~ubuntu-branches/ubuntu/saucy/awstats/saucy : revision 18

1

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">

2

3

4

5

6

7

8

<title>AWStats Documentation - Configuration directives and parameters</title><link rel="stylesheet" href="styles.css" type="text/css"></head>

9

10

11

12

13

14

15

16

17

18

19

20

<font style="font-family: arial,helvetica,sans-serif; font-style: normal; font-variant: normal; font-weight: normal; font-size: 16pt; line-height: normal; font-size-adjust: none; font-stretch: normal;" color="#eeeeff">AWStats logfile analyzer 7.0 Documentation

21

22

</td>

23

24

25

</td>

26

</tr>

27

28

</tbody></table>

29

30

31

<h1 style="font-family: arial,helvetica,sans-serif; font-style: normal; font-variant: normal; font-weight: normal; font-size: 26px; line-height: normal; font-size-adjust: none; font-stretch: normal;">AWStats configuration directives/options</h1>

32

33

34

Each directive available in the AWStats config file (.conf) is listed here (with examples and default values).

35

36

Notes

37

To include an environment variable in any parameter (AWStats will replace it with its value

38

when reading it), follow the example:

39

Parameter="__ENVNAME__"

40

41

42

43

DIRECTIVES IN MAIN SETUP SECTION (Required to make AWStats work)

44

<ul>

45

<li><a href="#LogFile">LogFile</a>

46

</li><li><a href="#LogType">LogType</a>

47

</li><li><a href="#LogFormat">LogFormat</a>

48

</li><li><a href="#LogSeparator">LogSeparator</a>

49

</li><li><a href="#DNSLookup">DNSLookup</a>

50

</li><li><a href="#DirData">DirData</a>

51

</li><li><a href="#DirCgi">DirCgi</a>

52

</li><li><a href="#DirIcons">DirIcons</a>

53

</li><li><a href="#SiteDomain">SiteDomain</a>

54

</li><li><a href="#HostAliases">HostAliases</a>

55

</li><li><a href="#AllowToUpdateStatsFromBrowser">AllowToUpdateStatsFromBrowser</a>

56

</li><li><a href="#AllowFullYearView">AllowFullYearView</a>

57

</li></ul>

58

59

60

DIRECTIVES IN OPTIONAL SETUP SECTION (Not required but increase AWStats features)

61

<ul>

62

<li><a href="#EnableLockForUpdate">EnableLockForUpdate</a>

63

</li><li><a href="#DNSStaticCacheFile">DNSStaticCacheFile</a>

64

</li><li><a href="#DNSLastUpdateCacheFile">DNSLastUpdateCacheFile</a>

65

</li><li><a href="#SkipDNSLookupFor">SkipDNSLookupFor</a>

66

</li><li><a href="#AllowAccessFromWebToAuthenticatedUsersOnly">AllowAccessFromWebToAuthenticatedUsersOnly</a>

67

</li><li><a href="#AllowAccessFromWebToFollowingAuthenticatedUsers">AllowAccessFromWebToFollowingAuthenticatedUsers</a>

68

</li><li><a href="#AllowAccessFromWebToFollowingIPAddresses">AllowAccessFromWebToFollowingIPAddresses</a>

69

</li><li><a href="#CreateDirDataIfNotExists">CreateDirDataIfNotExists</a>

70

</li><li><a href="#BuildHistoryFormat">BuildHistoryFormat</a>

71

</li><li><a href="#BuildReportFormat">BuildReportFormat</a>

72

</li><li><a href="#SaveDatabaseFilesWithPermissionsForEveryone">SaveDatabaseFilesWithPermissionsForEveryone</a>

73

</li><li><a href="#PurgeLogFile">PurgeLogFile</a>

74

</li><li><a href="#ArchiveLogRecords">ArchiveLogRecords</a>

75

</li><li><a href="#KeepBackupOfHistoricFiles">KeepBackupOfHistoricFiles</a>

76

</li><li><a href="#DefaultFile">DefaultFile</a>

77

</li><li><a href="#SkipHosts">SkipHosts</a>

78

</li><li><a href="#SkipUserAgents">SkipUserAgents</a>

79

</li><li><a href="#SkipFiles">SkipFiles</a>

80

</li><li><a href="#OnlyHosts">OnlyHosts</a>

81

</li><li><a href="#OnlyUserAgents">OnlyUserAgents</a>

82

</li><li><a href="#OnlyUsers">OnlyUsers</a>

83

</li><li><a href="#OnlyFiles">OnlyFiles</a>

84

</li><li><a href="#NotPageList">NotPageList</a>

85

</li><li><a href="#ValidHTTPCodes">ValidHTTPCodes</a>

86

</li><li><a href="#ValidSMTPCodes">ValidSMTPCodes</a>

87

</li><li><a href="#AuthenticatedUsersNotCaseSensitive">AuthenticatedUsersNotCaseSensitive</a>

88

</li><li><a href="#URLNotCaseSensitive">URLNotCaseSensitive</a>

89

</li><li><a href="#URLWithAnchor">URLWithAnchor</a>

90

</li><li><a href="#URLQuerySeparators">URLQuerySeparators</a>

91

</li><li><a href="#URLWithQuery">URLWithQuery</a>

92

</li><li><a href="#URLWithQueryWithOnlyFollowingParameters">URLWithQueryWithOnlyFollowingParameters</a>

93

</li><li><a href="#URLWithQueryWithoutFollowingParameters">URLWithQueryWithoutFollowingParameters</a>

94

</li><li><a href="#URLReferrerWithQuery">URLReferrerWithQuery</a>

95

</li><li><a href="#WarningMessages">WarningMessages</a>

96

</li><li><a href="#ErrorMessages">ErrorMessages</a>

97

</li><li><a href="#DebugMessages">DebugMessages</a>

98

</li><li><a href="#NbOfLinesForCorruptedLog">NbOfLinesForCorruptedLog</a>

99

</li><li><a href="#SplitSearchString">SplitSearchString</a>

100

</li><li><a href="#WrapperScript">WrapperScript</a>

101

</li><li><a href="#DecodeUA">DecodeUA</a>

102

</li><li><a href="#MiscTrackerUrl">MiscTrackerUrl</a>

103

</li></ul>

104

105

DIRECTIVES IN OPTIONAL ACCURACY SETUP SECTION (Not required but increase AWStats features)

106

<ul>

107

<li><a href="#LevelFor">LevelForBrowsersDetection</a>

108

</li><li><a href="#LevelFor">LevelForOSDetection</a>

109

</li><li><a href="#LevelFor">LevelForRefererAnalyze</a>

110

</li><li><a href="#LevelFor">LevelForRobotsDetection</a>

111

</li><li><a href="#LevelFor">LevelForSearchEnginesDetection</a>

112

</li><li><a href="#LevelFor">LevelForKeywordsDetection</a>

113

</li><li><a href="#LevelFor">LevelForFileTypesDetection</a>

114

</li><li><a href="#LevelFor">LevelForWormsDetection</a>

115

116

</li></ul>

117

118

DIRECTIVES IN OPTIONAL APPEARANCE SETUP SECTION (Not required but increase AWStats features)

119

<ul>

120

<li><a href="#UseFramesWhenCGI">UseFramesWhenCGI</a>

121

</li><li><a href="#DetailedReportsOnNewWindows">DetailedReportsOnNewWindows</a>

122

</li><li><a href="#Expires">Expires</a>

123

</li><li><a href="#MaxRowsInHTMLOutput">MaxRowsInHTMLOutput</a>

124

</li><li><a href="#Lang">Lang</a>

125

</li><li><a href="#DirLang">DirLang</a>

126

</li><li><a href="#Show">ShowHeader</a>

127

</li><li><a href="#Show">ShowMenu</a>

128

</li><li><a href="#Show">ShowSummary</a>

129

</li><li><a href="#Show">ShowMonthStats</a>

130

</li><li><a href="#Show">ShowDaysOfMonthStats</a>

131

</li><li><a href="#Show">ShowDaysOfWeekStats</a>

132

</li><li><a href="#Show">ShowHoursStats</a>

133

</li><li><a href="#Show">ShowDomainsStats</a>

134

</li><li><a href="#Show">ShowHostsStats</a>

135

</li><li><a href="#Show">ShowAuthenticatedUsers</a>

136

</li><li><a href="#Show">ShowRobotsStats</a>

137

</li><li><a href="#Show">ShowWormsStats</a>

138

</li><li><a href="#Show">ShowSessionsStats</a>

139

</li><li><a href="#Show">ShowPagesStats</a>

140

</li><li><a href="#Show">ShowCompressionStats</a>

141

</li><li><a href="#Show">ShowFileTypesStats</a>

142

</li><li><a href="#Show">ShowFileSizesStats</a></li><li><a href="#Show">ShowDownloadsStats</a></li><li><a href="#Show">ShowOSStats</a>

143

</li><li><a href="#Show">ShowBrowsersStats</a>

144

</li><li><a href="#Show">ShowScreenSizeStats</a>

145

</li><li><a href="#Show">ShowOriginStats</a>

146

</li><li><a href="#Show">ShowKeyphrasesStats</a>

147

</li><li><a href="#Show">ShowKeywordsStats</a>

148

</li><li><a href="#Show">ShowMiscStats</a>

149

</li><li><a href="#Show">ShowHTTPErrorsStats</a>

150

</li><li><a href="#Show">ShowSMTPErrorsStats</a>

151

</li><li><a href="#Show">ShowClusterStats</a>

152

</li><li><a href="#AddDataArray">AddDataArrayMonthStats</a>

153

</li><li><a href="#AddDataArray">AddDataArrayShowDaysOfMonthStats</a>

154

</li><li><a href="#AddDataArray">AddDataArrayShowDaysOfWeekStats</a>

155

</li><li><a href="#AddDataArray">AddDataArrayShowHoursStats</a>

156

</li><li><a href="#IncludeInternalLinksInOriginSection">IncludeInternalLinksInOriginSection</a>

157

</li><li><a href="#Max">MaxNbOfDomain</a>

158

</li><li><a href="#Max">MinHitDomain</a>

159

</li><li><a href="#Max">MaxNbOfHostsShown</a>

160

</li><li><a href="#Max">MinHitHost</a>

161

</li><li><a href="#Max">MaxNbOfLoginShown</a>

162

</li><li><a href="#Max">MinHitLogin</a>

163

</li><li><a href="#Max">MaxNbOfRobotShown</a>

164

</li><li><a href="#Max">MinHitRobot</a></li><li><a href="#Max">MaxNbOfDownloadsShown</a></li><li><a href="#Max">MinHitDownloads</a></li><li><a href="#Max">MaxNbOfPageShown</a>

165

</li><li><a href="#Max">MaxNbOfOsShown</a>

166

</li><li><a href="#Max">MinHitOs</a>

167

</li><li><a href="#Max">MaxNbOfBrowsersShown</a>

168

</li><li><a href="#Max">MinHitBrowser</a>

169

</li><li><a href="#Max">MinHitFile</a>

170

</li><li><a href="#Max">MaxNbOfScreenSizesShown</a>

171

</li><li><a href="#Max">MinHitScreenSize</a>

172

</li><li><a href="#Max">MaxNbOfRefererShown</a>

173

</li><li><a href="#Max">MinHitRefer</a>

174

</li><li><a href="#Max">MaxNbOfKeywordsShown</a>

175

</li><li><a href="#Max">MinHitKeyword</a>

176

</li><li><a href="#FirstDayOfWeek">FirstDayOfWeek</a>

177

</li><li><a href="#ShowFlagLinks">ShowFlagLinks</a>

178

</li><li><a href="#ShowLinksOnUrl">ShowLinksOnUrl</a>

179

</li><li><a href="#MaxLengthOfURL">MaxLengthOfURL</a>

180

</li><li><a href="#ShowLinksToWhoIs">ShowLinksToWhoIs</a>

181

</li><li><a href="#UseHTTPSLinksForUrl">UseHTTPSLinksForUrl</a>

182

</li><li><a href="#LinksToWhoIs">LinksToWhoIs</a>

183

</li><li><a href="#LinksToIPWhoIs">LinksToIPWhoIs</a>

184

</li><li><a href="#HTMLHeadSection">HTMLHeadSection</a>

185

</li><li><a href="#HTMLEndSection">HTMLEndSection</a>

186

</li><li><a href="#Bar">BarWidth</a>

187

</li><li><a href="#Bar">BarHeight</a>

188

</li><li><a href="#Logo">Logo</a>

189

</li><li><a href="#Logo">LogoLink</a>

190

</li><li><a href="#StyleSheet">StyleSheet</a>

191

</li><li><a href="#color_">color_Background</a>

192

</li><li><a href="#color_">color_TableBGTitle</a>

193

</li><li><a href="#color_">color_TableTitle</a>

194

</li><li><a href="#color_">color_TableBG</a>

195

</li><li><a href="#color_">color_TableRowTitle</a>

196

</li><li><a href="#color_">color_TableBGRowTitle</a>

197

</li><li><a href="#color_">color_TableBorder</a>

198

</li><li><a href="#color_">color_text</a>

199

</li><li><a href="#color_">color_titletext</a>

200

</li><li><a href="#color_">color_weekend</a>

201

</li><li><a href="#color_">color_link</a>

202

</li><li><a href="#color_">color_hover</a>

203

</li><li><a href="#color_">color_u</a>

204

</li><li><a href="#color_">color_v</a>

205

</li><li><a href="#color_">color_p</a>

206

</li><li><a href="#color_">color_h</a>

207

</li><li><a href="#color_">color_k</a>

208

</li><li><a href="#color_">color_s</a>

209

</li><li><a href="#color_">color_e</a>

210

</li><li><a href="#color_">color_x</a>

211

</li></ul>

212

213

DIRECTIVES FOR PLUGINS

214

<ul>

215

<li><a href="#LoadPlugin">LoadPlugin</a>

216

</li></ul>

217

218

DIRECTIVES IN EXTRA SECTIONS

219

<ul>

220

<li><a href="#Extra">ExtraSectionNameX</a>

221

</li><li><a href="#Extra">ExtraSectionCodeFilterX</a>

222

</li><li><a href="#Extra">ExtraSectionConditionX</a>

223

</li><li><a href="#Extra">ExtraSectionFirstColumnTitleX</a>

224

</li><li><a href="#Extra">ExtraSectionFirstColumnValuesX</a>

225

</li><li><a href="#Extra">ExtraSectionFirstColumnFormatX</a>

226

</li><li><a href="#Extra">ExtraSectionStatTypesX</a>

227

</li><li><a href="#Extra">ExtraSectionAddAverageRowX</a>

228

</li><li><a href="#Extra">ExtraSectionAddSumRowX</a>

229

</li><li><a href="#Extra">MaxNbOfExtraX</a>

230

</li><li><a href="#Extra">MinHitExtraX</a>

231

</li><li><a href="#ExtraTrackedRowsLimit">ExtraTrackedRowsLimit</a>

232

</li></ul>

233

234

INCLUDES

235

<ul>

236

<li><a href="#Include">Include</a>

237

</li></ul>

238

239

240

241

<hr>

242

243

<a name="LogFile">LogFile</a>

244

Version : 1.0+

245

3.1+ for tags %YYYY-n,%YY-n,%MM-n,%DD-n,%HH-n

246

3.2+ for tag %WM-n

247

4.0+ for tag %DW-n

248

4.1+ for tag %NS-n

249

5.0+ for tag %WY-n

250

5.1+ for tag %Wm-n, %Wy-n, %Dw-n

251

# "LogFile" contains the web, ftp or mail server logfile to analyze.

252

# You can use a full path or relative path from awstats.pl directory.

253

# Example: "/var/log/apache/access.log"

254

# Example: "../logs/mycombinedlog.log"

255

# You can also use tags in this filename if you need a dynamic file name

256

# depending on date or time (Replacement is made by AWStats at the beginning

257

# of its execution). This is available tags :

258

# %YYYY-n is replaced with 4 digits year we were n hours ago

259

# %YY-n is replaced with 2 digits year we were n hours ago

260

# %MM-n is replaced with month we were n hours ago

261

# %MO-n is replaced with 3 letters month we were n hours ago

262

# %DD-n is replaced with day we were n hours ago

263

# %HH-n is replaced with hour we were n hours ago

264

# %NS-n is replaced with number of seconds at 00:00 since 1970

265

# %WM-n is replaced with the week number in month (1-5)

266

# %Wm-n is replaced with the week number in month (0-4)

267

# %WY-n is replaced with the week number in year (01-52)

268

# %Wy-n is replaced with the week number in year (00-51)

269

# %DW-n is replaced with the day number in week (1-7, 1=sunday)

270

# use n=24 if you need (1-7, 1=monday)

271

# %Dw-n is replaced with the day number in week (0-6, 0=sunday)

272

# use n=24 if you need (0-6, 0=monday)

273

# Use 0 for n if you need current year, month, day, hour...

274

# Example: "/var/log/access_log.%YYYY-0%MM-0%DD-0.log"

275

# Example: "C:/WINNT/system32/LogFiles/W3SVC1/ex%YY-24%MM-24%DD-24.log"

276

# You can also use a pipe if log file come from a pipe.

277

# Example: "gzip -d </var/log/apache/access.log.gz |"

278

# If there is several log files from load balancing servers :

279

# Example: "/pathtotools/logresolvemerge.pl *.log |"

280

#

281

LogFile="/var/log/httpd/mylog.log"

282

283

<hr>

284

285

<a name="LogType">LogType</a>

286

Version : 5.7+

287

# Enter the log file type you want to analyze.

288

# Possible values:

289

# W - For a web log file

290

# M - For a mail log file

291

# F - For a ftp log file

292

# Example: W

293

# Default: W

294

#

295

LogType=W

296

297

<hr>

298

299

<a name="LogFormat">LogFormat</a>

300

Version : 2.1+

301

3.1+ for tags %host,%logname,%time1,%time2,%methodurl,%methodurlnoprot,%method,%url,

302

%query,%code,%bytesd,%refererquot,%referer,%uaquot,%ua,%other

303

3.2+ for tags %gzipin,%gzipout

304

4.0+ for tags %gzipratio,%syslog

305

4.1+ for tag %virtualname

306

5.6+ for tag %deflateratio

307

6.1+ for tag %time4

308

6.2+ for tag %time3

309

# Enter here your log format (Must agree with your web server. See setup

310

# instructions in README.txt to know how to configure your web server to have

311

# the required log format).

312

# Possible values: 1,2,3,4 or "your_own_personalized_log_format"

313

# 1 - Apache or Lotus Notes/Domino native combined log format (NCSA combined/XLF/ELF log format)

314

# 2 - IIS or ISA format (IIS W3C log format). See FAQ-COM115 For ISA.

315

# 3 - Webstar native log format.

316

# 4 - Apache or Squid native common log format (NCSA common/CLF log format)

317

# With LogFormat=4, some features (browsers, os, keywords...) can't work.

318

# "your_own_personalized_log_format" = If your log is ftp, mail or other format,

319

# you must use following keys to define the log format string (See FAQ for

320

# ftp, mail or exotic web log format examples):

321

# %host Client hostname or IP address (or Sender host for mail log)

322

# %host_r Receiver hostname or IP address (for mail log)

323

# %lognamequot Authenticated login/user with format: "alex"

324

# %logname Authenticated login/user with format: alex

325

# %time1 Date and time with format: [dd/mon/yyyy:hh:mm:ss +0000] or [dd/mon/yyyy:hh:mm:ss]

326

# %time2 Date and time with format: yyyy-mm-dd hh-mm-ss

327

# %time3 Date and time with format: Mon dd hh:mm:ss or Mon dd hh:mm:ss yyyy

328

# %time4 Date and time with unix timestamp format: dddddddddd

329

# %methodurl Method and URL with format: "GET /index.html HTTP/x.x"

330

# %methodurlnoprot Method and URL with format: "GET /index.html"

331

# %method Method with format: GET

332

# %url URL only with format: /index.html

333

# %query Query string (used by URLWithQuery option)

334

# %code Return code status (with format for web log: 999)

335

# %bytesd Size of document in bytes

336

# %refererquot Referer page with format: "http://from.com/from.htm"

337

# %referer Referer page with format: http://from.com/from.htm

338

# %uaquot User agent with format: "Mozilla/4.0 (compatible, ...)"

339

# %ua User agent with format: Mozilla/4.0_(compatible...)

340

# %gzipin mod_gzip compression input bytes: In:XXX

341

# %gzipout mod_gzip compression output bytes & ratio: Out:YYY:ZZpct.

342

# %gzipratio mod_gzip compression ratio: ZZpct.

343

# %deflateratio mod_deflate compression ratio with format: (ZZ)

344

# %email EMail sender (for mail log)

345

# %email_r EMail receiver (for mail log)

346

# %virtualname Web sever virtual hostname. Use this tag when same log

347

# contains data of several virtual web servers. AWStats

348

# will discard records not in SiteDomain nor HostAliases

349

# %cluster If log file is provided from several computers (merged by

350

# logresolvemerge.pl), this tag define field of cluster id.

351

# %extraX Another field that you plan to use for building a

352

# personalized report with ExtraSection feature (See later).

353

# If your log format has some fields not included in this list, use

354

# %other Means another field

355

# %otherquot Means another not used double quoted field

356

#

357

# Examples for Apache combined logs (following two examples are equivalent):

358

# LogFormat = 1

359

# LogFormat = "%host %other %logname %time1 %methodurl %code %bytesd %refererquot %uaquot"

360

#

361

# Example for IIS:

362

# LogFormat = 2

363

#

364

LogFormat=1

365

366

<hr>

367

368

<a name="LogSeparator">LogSeparator</a>

369

Version : 5.0+

370

# If your log field's separator is not a space, you can change this parameter.

371

# This parameter is not used if LogFormat is a predefined value (1,2,3,4)

372

# Example: " "

373

# Example: "\t"

374

# Example: "|"

375

# Default: " "

376

#

377

LogSeparator=" "

378

379

<hr>

380

381

<a name="DNSLookup">DNSLookup</a>

382

Version : 1.0+ (5.0+ for value 2)

383

# If you want to have hosts reported by name instead of ip address, AWStats

384

# need to make reverse DNS lookups (if not already done in your log file).

385

# With DNSLookup to 0, all hosts will be reported by their IP addresses and

386

# not by the full hostname of visitors (except if names are already available

387

# in log file).

388

# If you want/need to set DNSLookup to 1, don't forget that this will reduce

389

# dramatically AWStats update process speed. Do not use on large web sites.

390

# Note: Reverse DNS lookup is done on IPv4 only (Enable ipv6 plugin for IPv6).

391

# Note: Result of DNS Lookup can be used to build the Country report. However

392

# it is highly recommanded to enable the plugin 'geoipfree' or 'geoip' to

393

# have an accurate Country report with no need of DNS Lookup.

394

# Possible values:

395

# 0 - No DNS Lookup

396

# 1 - DNS Lookup is fully enabled

397

# 2 - DNS Lookup is made only from static DNS cache file (if it exists)

398

# Default: 2

399

#

400

DNSLookup=2

401

402

<hr>

403

404

<a name="DirData">DirData</a>

405

Version : 1.0+

406

# When AWStats updates its statistics, it stores results of its analysis in

407

# files (AWStats database). All those files are written in the directory

408

# defined by the "DirData" parameter. Set this value to the directory where

409

# you want AWStats to save its database and working files into.

410

# Warning: If you want to be able to use the "AllowToUpdateStatsFromBrowser"

411

# feature (see later), you need write permissions by webserver user on this

412

# directory.

413

# Example: "/var/lib/awstats"

414

# Example: "../data"

415

# Example: "C:/awstats_data_dir"

416

# Default: "." (means same directory as awstats.pl)

417

#

418

DirData="."

419

420

<hr>

421

422

<a name="DirCgi">DirCgi</a>

423

Version : 1.0+

424

# Relative or absolute web URL of your awstats cgi-bin directory.

425

# This parameter is used only when AWStats is ran from command line

426

# with -output option (to generate links in HTML reported page).

427

# Example: "/awstats"

428

# Default: "/cgi-bin" (means awstats.pl is in "/yourwwwroot/cgi-bin")

429

#

430

DirCgi="/cgi-bin"

431

432

<hr>

433

434

<a name="DirIcons">DirIcons</a>

435

Version : 1.0+

436

# Relative or absolute web URL of your awstats icon directory.

437

# If you build static reports ("... -output > outputpath/output.html"), enter

438

# path of icon directory relative to the output directory 'outputpath'.

439

# Example: "/awstatsicons"

440

# Example: "../icon"

441

# Default: "/icon" (means you must copy icon directories in "/mywwwroot/icon")

442

#

443

DirIcons="/icon"

444

445

<hr>

446

447

<a name="SiteDomain">SiteDomain</a>

448

Version : 3.2+

449

# "SiteDomain" must contain the main domain name or the main intranet web

450

# server name used to reach the web site.

451

# If you share the same log file for several virtual web servers, this

452

# parameter is used to tell AWStats to filter record that contains records for

453

# this virtual host name only (So check that this virtual hostname can be

454

# found in your log file and use a personalized log format that include the

455

# %virtualname tag).

456

# But for multi hosting a better solution is to have one log file for each

457

# virtual web server. In this case, this parameter is only used to generate

458

# full URL's links when ShowLinksOnUrl option is set to 1.

459

# If analysing mail log, enter here the domain name of mail server.

460

# Example: "myintranetserver"

461

# Example: "www.domain.com"

462

# Example: "ftp.domain.com"

463

# Example: "domain.com"

464

#

465

SiteDomain=""

466

467

<hr>

468

469

<a name="HostAliases">HostAliases</a>

470

Version : 1.0+ (5.6+ for REGEX syntax)

471

# Enter here all other possible domain names, addresses or virtual host

472

# aliases someone can use to access your site. Try to keep only the minimum

473

# number of possible names/addresses to have the best performances.

474

# You can repeat the "SiteDomain" value in this list.

475

# This parameter is used to analyze referer field in log file and to help

476

# AWStats to know if a referer URL is a local URL of same site or an URL of

477

# another site.

478

# Note: Use space between each value.

479

# Note: You can use regular expression values writing value with REGEX[value].

480

# Example: "www.myserver.com localhost 127.0.0.1 REGEX[\.mydomain\.(net|org)$]"

481

#

482

HostAliases="localhost 127.0.0.1 REGEX[^.*\.myserver\.com$]"

483

484

<hr>

485

486

<a name="AllowToUpdateStatsFromBrowser">AllowToUpdateStatsFromBrowser</a>

487

Version : 3.0+

488

# When this parameter is set to 1, AWStats add a button on report page to

489

# allow to "update" statistics from a web browser. Warning, when "update" is

490

# made from a browser, AWStats is ran as a CGI by the web server user

491

# defined in your web server (user "nobody" by default with Apache, "IUSR_XXX"

492

# with IIS), so the "DirData" directory and all already existing history files

493

# (awstatsMMYYYY[.xxx].txt) must be writable by this user. Change permissions

494

# if required.

495

# Warning: Update process can be long so you might experience "time out"

496

# browser errors if you don't launch AWStats enough frequently.

497

# When set to 0, update is only made when AWStats is ran from the command

498

# line interface (or a task scheduler).

499

# Possible values: 0 or 1

500

# Default: 0

501

#

502

AllowToUpdateStatsFromBrowser=0

503

504

<hr>

505

506

<a name="AllowFullYearView">AllowFullYearView</a>

507

Version : 5.9+

508

# AWStats save and sort its database on a month basis, this allows to build

509

# build a report quickly. However, if you choose the -month=all from command

510

# line or value '-Year-' from CGI combo form to have a report for all year,

511

# AWStats needs to reload all data for full year, and resort them completely,

512

# requiring a large amount of time, memory and CPU. This might be a problem

513

# for web hosting providers that offer AWStats for large sites on shared

514

# servers to non CPU cautious customers.

515

# For this reason, the 'full year' is only enable on Command Line by default.

516

# You can change this by setting this parameter to 0, 1, 2 or 3.

517

# Possible values:

518

# 0 - Never allowed

519

# 1 - Allowed on CLI only, -Year- value in combo is not visible

520

# 2 - Allowed on CLI only, -Year- value in combo is visible but not allowed

521

# 3 - Possible on CLI and CGI

522

# Default: 2

523

#

524

AllowFullYearView=2

525

526

<hr>

527

528

<a name="EnableLockForUpdate">EnableLockForUpdate</a>

529

Version : 5.0+

530

# When the update process run, AWStats can set a lock file in TEMP or TMP

531

# directory. This lock is to avoid to have 2 update processes running at the

532

# same time to prevent unknown conflicts problems and avoid DoS attacks when

533

# AllowToUpdateStatsFromBrowser is set to 1.

534

# Because, when you use lock file, you can experience sometimes problems in

535

# lock file not correctly removed (killed process for example requires that

536

# you remove the file manualy), this option is not enabled by default (Do

537

# not enable this option with no console server access).

538

# Possible values: 0 or 1

539

# Default: 0

540

#

541

EnableLockForUpdate=0

542

543

<hr>

544

545

<a name="DNSStaticCacheFile">DNSStaticCacheFile</a>

546

Version : 5.0+

547

# AWStats can do reverse DNS lookups through a static DNS cache file that was

548

# previously created manually. If no path is given in static DNS cache file

549

# name, AWStats will search DirData directory. This file is never changed.

550

# This option is not used if DNSLookup=0.

551

# Note: DNS cache file format is 'minsince1970 ipaddress resolved_hostname'

552

# or just 'ipaddress resolved_hostname'

553

# Example: "/mydnscachedir/dnscache"

554

# Default: "dnscache.txt"

555

#

556

DNSStaticCacheFile="dnscache.txt"

557

558

<hr>

559

560

<a name="DNSLastUpdateCacheFile">DNSLastUpdateCacheFile</a>

561

Version : 5.0+

562

# AWStats can do reverse DNS lookups through a DNS cache file that was created

563

# by a previous run of AWStats. This file is erased and recreated after each

564

# statistics update process. You don't need to create and/or edit it.

565

# AWStats will read and save this file in DirData directory.

566

# This option is used only if DNSLookup=1.

567

# Note: If a DNSStaticCacheFile is available, AWStats will check for DNS

568

# lookup in DNSLastUpdateCacheFile after checking into DNSStaticCacheFile.

569

# Example: "/mydnscachedir/dnscachelastupdate"

570

# Default: "dnscachelastupdate.txt"

571

#

572

DNSLastUpdateCacheFile="dnscachelastupdate.txt"

573

574

<hr>

575

576

<a name="SkipDNSLookupFor">SkipDNSLookupFor</a>

577

Version : 3.0+ (5.6+ for REGEX syntax)

578

# You can specify specific IP addresses that should NOT be looked up in DNS.

579

# This option is used only if DNSLookup=1.

580

# Note: Use space between each value.

581

# Note: You can use regular expression values writing value with REGEX[value].

582

# Change : Effective for new updates only

583

# Example: "123.123.123.123 REGEX[^192\.168\.]"

584

# Default: ""

585

#

586

SkipDNSLookupFor=""

587

588

<hr>

589

590

<a name="AllowAccessFromWebToAuthenticatedUsersOnly">AllowAccessFromWebToAuthenticatedUsersOnly</a>

591

Version : 4.0+

592

# The following two parameters allow you to protect a config file from being

593

# read by AWStats when called from a browser if web user has not been

594

# authenticated. Your AWStats program must be in a web protected "realm" (With

595

# Apache, you can use .htaccess files to do so. With other web servers, see

596

# your server setup manual).

597

# Change : Effective immediatly

598

# Possible values: 0 or 1

599

# Default: 0

600

#

601

AllowAccessFromWebToAuthenticatedUsersOnly=0

602

603

<hr>

604

605

<a name="AllowAccessFromWebToFollowingAuthenticatedUsers">AllowAccessFromWebToFollowingAuthenticatedUsers</a>

606

Version : 4.0+

607

# This parameter gives the list of all authorized authenticated users to view

608

# statistics for this domain/config file. This parameter is used only if

609

# AllowAccessToAuthenticatedUsersOnly is set to 1.

610

# Change : Effective immediatly

611

# Example: "user1 user2"

612

# Default: ""

613

#

614

AllowAccessFromWebToFollowingAuthenticatedUsers=""

615

616

<hr>

617

618

<a name="AllowAccessFromWebToFollowingIPAddresses">AllowAccessFromWebToFollowingIPAddresses</a>

619

Version : 5.0+

620

# When this parameter is defined to something, the IP address of the user that

621

# read its statistics from a browser (when AWStats is used as a CGI) is

622

# checked and must match one of the IP address values or ranges.

623

# Change : Effective immediatly

624

# Example: "127.0.0.1 123.123.123.1-123.123.123.255"

625

# Default: ""

626

#

627

AllowAccessFromWebToFollowingIPAddresses=""

628

629

<hr>

630

631

<a name="CreateDirDataIfNotExists">CreateDirDataIfNotExists</a>

632

Version : 4.0+

633

# If the "DirData" directory (see above) does not exists, AWStats return an

634

# error. However, you can ask AWStats to create it.

635

# This option can be used by some Web Hosting Providers that has defined a

636

# dynamic value for DirData (for example DirData="/home/__REMOTE_USER__") and

637

# don't want to have to create a new directory each time they add a new user.

638

# Change : Effective immediatly

639

# Possible values: 0 or 1

640

# Default: 0

641

#

642

CreateDirDataIfNotExists=1

643

644

<hr>

645

646

<a name="BuildHistoryFormat">BuildHistoryFormat</a>

647

Version : 6.0+

648

# You can choose in which format the Awstats history database is saved.

649

# Note: Using "xml" format make AWStats building database files three times

650

# larger than using "text" format.

651

# Change : Database format is switched after next update

652

# Possible values: text or xml

653

# Default: text

654

#

655

BuildHistoryFormat=text

656

657

<hr>

658

659

<a name="BuildReportFormat">BuildReportFormat</a>

660

Version : 6.0+

661

# If you prefer having the report output pages be built as XML compliant pages

662

# instead of simple HTML pages, you can set this to 'xhtml' (May not works

663

# properly with old browsers).

664

# Possible values: html or xhtml

665

# Default: html

666

#

667

BuildReportFormat=html

668

669

<hr>

670

671

<a name="SaveDatabaseFilesWithPermissionsForEveryone">SaveDatabaseFilesWithPermissionsForEveryone</a>

672

Version : 4.0+

673

# AWStats databases can be updated from command line of from a browser (when

674

# used as a cgi program). So AWStats database files need write permission

675

# for both command line user and default web server user (nobody for Unix,

676

# IUSR_xxx for IIS/Windows,...).

677

# To avoid permission's problems between update process (run by an admin user)

678

# and CGI process (ran by a low level user), AWStats can save its database

679

# files with read and write permissions for everyone.

680

# By default, AWStats keep default user permissions on updated files. If you

681

# set AllowToUpdateStatsFromBrowser to 1, you can change this parameter to 1.

682

# Change : Effective for new updates only

683

# Possible values: 0 or 1

684

# Default: 0

685

#

686

SaveDatabaseFilesWithPermissionsForEveryone=0

687

688

<hr>

689

690

<a name="PurgeLogFile">PurgeLogFile</a>

691

Version : 2.23+

692

# AWStats can purge log file, after analyzing it. Note that AWStats is able

693

# to detect new lines in a log file, to process only them, so you can launch

694

# AWStats as often as you want, even with this parameter to 0.

695

# With 0, no purge is made, so you must use a scheduled task or a web server

696

# that make this purge frequently.

697

# With 1, the purge of the log file is made each time AWStats is ran.

698

# This parameter doesn't work with IIS (This web server doesn't let its log

699

# file to be purged).

700

# Possible values: 0 or 1

701

# Default: 0

702

#

703

PurgeLogFile=0

704

705

<hr>

706

707

<a name="ArchiveLogRecords">ArchiveLogRecords</a>

708

Version : 2.1+ (6.4+ to use tags for suffix)

709

# When PurgeLogFile is setup to 1, AWStats will clean your log file after

710

# processing it. You can however keep an archive file of all processed log

711

# records by setting this parameter (For example if you want to use another

712

# log analyzer). The archived log file is saved in "DirData" with name

713

# awstats_archive.configname[.suffix].log

714

# This parameter is not used if PurgeLogFile=0

715

# Change : Effective for new updates only

716

# Possible values: 0, 1, or tags (See LogFile parameter) for suffix

717

# Example: 1

718

# Example: %YYYY%MM%DD

719

# Default: 0

720

#

721

ArchiveLogRecords=0

722

723

<hr>

724

725

<a name="KeepBackupOfHistoricFiles">KeepBackupOfHistoricFiles</a>

726

Version : 3.2+

727

# Each time you run the update process, AWStats overwrite the 'historic file'

728

# for the month (awstatsMMYYYY[.*].txt) with the updated one.

729

# When write errors occurs (IO, disk full,...), this historic file can be

730

# corrupted and must be deleted. Because this file contains information of all

731

# past processed log files, you will loose old stats if removed. So you can

732

# ask AWStats to save last non corrupted file in a .bak file. This file is

733

# stored in "DirData" directory with other 'historic files'.

734

# Possible values: 0 or 1

735

# Default: 0

736

#

737

KeepBackupOfHistoricFiles=0

738

739

<hr>

740

741

<a name="DefaultFile">DefaultFile</a>

742

Version : 1.0+ (5.0+ can accept several values)

743

# Default index page name for your web server.

744

# Change : Effective for new updates only

745

# Example: "index.php index.html default.html"

746

# Default: "index.html"

747

#

748

DefaultFile="index.html"

749

750

<hr>

751

752

<a name="SkipHosts">SkipHosts</a>

753

Version : 1.0+ (5.6+ for REGEX syntax)

754

# Do not include access from clients that match following criteria.

755

# If your log file contains IP adresses in host field, you must enter here

756

# matching IP adresses criteria.

757

# If DNS lookup is already done in your log file, you must enter here hostname

758

# criteria, else enter ip address criteria.

759

# The opposite parameter of "SkipHosts" is "OnlyHosts".

760

# Note: Use space between each value.

761

# Note: You can use regular expression values writing value with REGEX[value].

762

# Change : Effective for new updates only

763

# Example: "127.0.0.1 REGEX[^192\.168\.] REGEX[^10\.0\.0\.]"

764

# Example: "localhost REGEX[^.*\.localdomain$]"

765

# Default: ""

766

#

767

SkipHosts=""

768

769

<hr>

770

771

<a name="SkipUserAgents">SkipUserAgents</a>

772

Version : 5.1+ (5.6+ for REGEX syntax)

773

# Do not include access from clients with a user agent that match following

774

# criteria. If you want to exclude a robot, you should update the robots.pm

775

# file instead of this parameter.

776

# The opposite parameter of "SkipUserAgents" is "OnlyUserAgents".

777

# Note: Use space between each value. This parameter is not case sensitive.

778

# Note: You can use regular expression values writing value with REGEX[value].

779

# Change : Effective for new updates only

780

# Example: "konqueror REGEX[ua_test_v\d\.\d]"

781

# Default: ""

782

#

783

SkipUserAgents=""

784

785

<hr>

786

787

<a name="SkipFiles">SkipFiles</a>

788

Version : 1.0+ (5.6+ for REGEX syntax)

789

# Use SkipFiles to ignore access to URLs that match one of following entries.

790

# You can enter a list of not important URLs (like framed menus, hidden pages,

791

# etc...) to exclude them from statistics. You must enter here exact relative

792

# URL as found in log file, or a matching REGEX value. Check apply on URL with

793

# all its query paramaters.

794

# For example, to ignore /badpage.php, just add "/badpage.php". To ignore all

795

# pages in a particular directory, add "REGEX[^\/directorytoexclude]".

796

# The opposite parameter of "SkipFiles" is "OnlyFiles".

797

# Note: Use space between each value. This parameter is or not case sensitive

798

# depending on URLNotCaseSensitive parameter.

799

# Note: You can use regular expression values writing value with REGEX[value].

800

# Change : Effective for new updates only

801

# Example: "/badpage.php /page.php?param=x REGEX[^\/excludedirectory]"

802

# Default: ""

803

#

804

SkipFiles=""

805

806

<hr>

807

808

<a name="SkipReferrersBlackList">SkipReferrersBlackList</a>

809

Version : 6.5+

810

# Use SkipReferrersBlackList if you want to exclude records coming from a SPAM

811

# referrer. Parameter must receive a local file name containing rules applied

812

# on referrer field. If parameter is empty, no filter is applied.

813

# An example of such a file is available in lib/blacklist.txt

814

# You can download updated version at http://www.jayallen.org/comment_spam/

815

# Change : Effective for new updates only

816

# Example: "/mylibpath/blacklist.txt"

817

# Default: ""

818

819

# WARNING!! Using this feature make AWStats running very slower (5 times slower

820

# with black list file provided with AWStats !

821

#

822

SkipReferrersBlackList=""

823

824

<hr>

825

826

<a name="OnlyHosts">OnlyHosts</a>

827

Version : 5.2+ (5.6+ for REGEX syntax)

828

# Include in stats, only accesses from hosts that match one of following

829

# entries. For example, if you want AWStats to filter access to keep only

830

# stats for visits from particular hosts, you can add those hosts names in

831

# this parameter.

832

# If DNS lookup is already done in your log file, you must enter here hostname

833

# criteria, else enter ip address criteria.

834

# The opposite parameter of "OnlyHosts" is "SkipHosts".

835

# Note: Use space between each value. This parameter is not case sensitive.

836

# Note: You can use regular expression values writing value with REGEX[value].

837

# Change : Effective for new updates only

838

# Example: "127.0.0.1 REGEX[^192\.168\.] REGEX[^10\.0\.0\.]"

839

# Default: ""

840

#

841

OnlyHosts=""

842

843

<hr>

844

845

<a name="OnlyUserAgents">OnlyUserAgents</a>

846

Version : 5.8+

847

# Include in stats, only accesses from user agent that match one of following

848

# entries. For example, if you want AWStats to filter access to keep only

849

# stats for visits from particular browsers, you can add their user agents

850

# string in this parameter.

851

# The opposite parameter of "OnlyUserAgents" is "SkipUserAgents".

852

# Note: Use space between each value. This parameter is not case sensitive.

853

# Note: You can use regular expression values writing value with REGEX[value].

854

# Change : Effective for new updates only

855

# Example: "msie"

856

# Default: ""

857

#

858

OnlyUserAgents=""

859

860

<hr>

861

862

<a name="OnlyUsers">OnlyUsers</a>

863

Version : 6.8+

864

# Include in stats, only accesses from authenticated users that match one of

865

# following entries. For example, if you want AWStats to filter access to keep

866

# only stats for authenticated users, you can add those users names in

867

# this parameter. Useful for statistics for per user ftp logs.

868

# Note: Use space between each value. This parameter is not case sensitive.

869

# Note: You can use regular expression values writing value with REGEX[value].

870

# Change : Effective for new updates only

871

# Example: "john bob REGEX[^testusers]"

872

# Default: ""

873

#

874

OnlyUsers=""

875

876

<hr>

877

878

<a name="OnlyFiles">OnlyFiles</a>

879

Version : 3.0+ (5.6+ for REGEX syntax)

880

# Include in stats, only accesses to URLs that match one of following entries.

881

# For example, if you want AWStats to filter access to keep only stats that

882

# match a particular string, like a particular directory, you can add this

883

# directory name in this parameter.

884

# The opposite parameter of "OnlyFiles" is "SkipFiles".

885

# Note: Use space between each value. This parameter is or not case sensitive

886

# depending on URLNotCaseSensitive parameter.

887

# Note: You can use regular expression values writing value with REGEX[value].

888

# Change : Effective for new updates only

889

# Example: "REGEX[marketing_directory] REGEX[office\/.*\.(csv|sxw)$]"

890

# Default: ""

891

#

892

OnlyFiles=""

893

894

<hr>

895

896

<a name="NotPageList">NotPageList</a>

897

Version : 3.2+

898

# Add here a list of kind of url (file extension) that must be counted as

899

# "Hit only" and not as a "Hit" and "Page/Download". You can set here all

900

# images extensions as they are hit downloaded that must be counted but they

901

# are not viewed pages. URLs with such extensions are not included in the TOP

902

# Pages/URL report.

903

# Note: If you want to exclude particular URLs from stats (No Pages and no

904

# Hits reported), you must use SkipFiles parameter.

905

# Example: "css js class gif jpg jpeg png bmp rss xml swf zip arj gz z wav mp3 wma mpg"

906

# Example: ""

907

# Default: "css js class gif jpg jpeg png bmp rss xml swf"

908

#

909

NotPageList="css js class gif jpg jpeg png bmp rss xml swf"

910

911

<hr>

912

913

<a name="ValidHTTPCodes">ValidHTTPCodes</a>

914

Version : 4.0+

915

# By default, AWStats considers that records found in log file are successful

916

# hits if HTTP code returned by server is a valid HTTP code (200 and 304).

917

# Any other code are reported in HTTP error chart.

918

# However in some specific environment, with web server HTTP redirection,

919

# you can choose to also accept other codes.

920

# Example: "200 304 302 305"

921

# Default: "200 304"

922

#

923

ValidHTTPCodes="200 304"

924

925

This is examples of current HTTP codes

926

927

#[Miscellaneous successes]

928

"2xx", "[Miscellaneous successes]",

929

"200", "OK", # HTTP request OK

930

"201", "Created",

931

"202", "Request recorded, will be executed later",

932

"203", "Non-authoritative information",

933

"204", "Request executed",

934

"205", "Reset document",

935

"206", "Partial Content",

936

#[Miscellaneous redirections]

937

"3xx", "[Miscellaneous redirections]",

938

"300", "Multiple documents available",

939

"301", "Moved Permanently",

940

"302", "Found",

941

"303", "See other document",

942

"304", "Not Modified since last retrieval", # HTTP request OK

943

"305", "Use proxy",

944

"306", "Switch proxy",

945

"307", "Document moved temporarily",

946

#[Miscellaneous client/user errors]

947

"4xx", "[Miscellaneous client/user errors]",

948

"400", "Bad Request",

949

"401", "Unauthorized",

950

"402", "Payment required",

951

"403", "Forbidden",

952

"404", "Document Not Found",

953

"405", "Method not allowed",

954

"406", "ocument not acceptable to client",

955

"407", "Proxy authentication required",

956

"408", "Request Timeout",

957

"409", "Request conflicts with state of resource",

958

"410", "Document gone permanently",

959

"411", "Length required",

960

"412", "Precondition failed",

961

"413", "Request too long",

962

"414", "Requested filename too long",

963

"415", "Unsupported media type",

964

"416", "Requested range not valid",

965

"417", "Failed",

966

#[Miscellaneous server errors]

967

"5xx", "[Miscellaneous server errors]",

968

"500", "Internal server Error",

969

"501", "Not implemented",

970

"502", "Received bad response from real server",

971

"503", "Server busy",

972

"504", "Gateway timeout",

973

"505", "HTTP version not supported",

974

"506", "Redirection failed",

975

#[Unknown]

976

"xxx" ,"[Unknown]"

977

978

979

<hr>

980

981

<a name="ValidSMTPCodes">ValidSMTPCodes</a>

982

Version : 5.0+

983

# By default, AWStats considers that records found in mail log file are

984

# successful mail transfers if field that represent return code in analyzed

985

# log file match values defined by this parameter.

986

# Change : Effective for new updates only

987

# Example: "1 250 200"

988

# Default: "1 250"

989

#

990

ValidSMTPCodes="1 250"

991

992

<hr>

993

994

<a name="AuthenticatedUsersNotCaseSensitive">AuthenticatedUsersNotCaseSensitive</a>

995

Version : 5.3+

996

# Some web servers on some Operating systems (IIS-Windows) considers that a

997

# login with same value but different case are the same login. To tell AWStats

998

# to also considers them as one, set this parameter to 1.

999

# Possible values: 0 or 1

1000

# Default: 0

1001

#

1002

AuthenticatedUsersNotCaseSensitive=0

1003

1004

<hr>

1005

1006

<a name="URLNotCaseSensitive">URLNotCaseSensitive</a>

1007

Version : 5.1+

1008

# Some web servers on some Operating systems (IIS-Windows) considers that two

1009

# URLs with same value but different case are the same URL. To tell AWStats to

1010

# also considers them as one, set this parameter to 1.

1011

# Possible values: 0 or 1

1012

# Default: 0

1013

#

1014

URLNotCaseSensitive=0

1015

1016

<hr>

1017

1018

<a name="URLWithAnchor">URLWithAnchor</a>

1019

Version : 5.4+

1020

# Keep or remove the anchor string you can find in some URLs.

1021

# Possible values: 0 or 1

1022

# Default: 0

1023

#

1024

URLWithAnchor=0

1025

1026

<hr>

1027

1028

<a name="URLQuerySeparators">URLQuerySeparators</a>

1029

Version : 5.2+

1030

# In URL links, "?" char is used to add parameter's list in URLs. Syntax is:

1031

# /mypage.html?param1=value1

1032

# However, some servers/sites have also others chars to isolate dynamic part of

1033

# their URLs. You can complete this list with all such characters.

1034

# Example: "?;,"

1035

# Default: "?;"

1036

#

1037

URLQuerySeparators="?;"

1038

1039

<hr>

1040

1041

<a name="URLWithQuery">URLWithQuery</a>

1042

Version : 3.2+

1043

# Keep or remove the query string to the URL in the statistics for individual

1044

# pages. This is primarily used to differentiate between the URLs of dynamic

1045

# pages. If set to 1, mypage.html?id=x and mypage.html?id=y are counted as two

1046

# different pages.

1047

# Warning, when set to 1, memory required to run AWStats is dramatically

1048

# increased if you have a lot of changing URLs (for example URLs with a random

1049

# id inside). Such web sites should not set this option to 1 or use seriously

1050

# the next parameter URLWithQueryWithoutFollowingParameters.

1051

# Possible values:

1052

# 0 - URLs are cleaned from the query string (ie: "/mypage.html")

1053

# 1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y")

1054

# Default: 0

1055

#

1056

URLWithQuery=0

1057

1058

<hr>

1059

1060

<a name="URLWithQueryWithOnlyFollowingParameters">URLWithQueryWithOnlyFollowingParameters</a>

1061

Version : 6.0+

1062

# When URLWithQuery is on, you will get the full URL with all parameters in

1063

# URL reports. But among thoose parameters, sometimes you don't need a

1064

# particular parameter because it does not identify the page or because it's

1065

# a random ID changing for each access even if URL points to same page. In

1066

# such cases, it is higly recommanded to ask AWStats to keep only parameters

1067

# you need (if you know them) before counting, manipulating and storing URL.

1068

# Enter here list of wanted parameters. For example, with "param", one hit on

1069

# /mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r

1070

# will be reported as 2 hits on /mypage.cgi?param=abc

1071

# This parameter is not used when URLWithQuery is 0 and can't be used with

1072

# URLWithQueryWithoutFollowingParameters.

1073

# Change : Effective for new updates only

1074

# Example: "param"

1075

# Default: ""

1076

#

1077

URLWithQueryWithOnlyFollowingParameters=""

1078

1079

<hr>

1080

1081

<a name="URLWithQueryWithoutFollowingParameters">URLWithQueryWithoutFollowingParameters</a>

1082

Version : 5.1+

1083

# When URLWithQuery is on, you will get the full URL with all parameters in

1084

# URL reports. But among thoose parameters, sometimes you don't need a

1085

# particular parameter because it does not identify the page or because it's

1086

# a random ID changing for each access even if URL points to same page. In

1087

# such cases, it is higly recommanded to ask AWStats to remove such parameters

1088

# from the URL before counting, manipulating and storing URL. Enter here list

1089

# of all non wanted parameters. For example, if you enter "id", one hit on

1090

# /mypage.cgi?param=abc&id=Yo4UomP9d and /mypage.cgi?param=abc&id=Mu8fdxl3r

1091

# will be reported as 2 hits on /mypage.cgi?param=abc

1092

# This parameter is not used when URLWithQuery is 0 and can't be used with

1093

# URLWithQueryWithOnlyFollowingParameters.

1094

# Change : Effective for new updates only

1095

# Example: "PHPSESSID jsessionid"

1096

# Default: ""

1097

#

1098

URLWithQueryWithoutFollowingParameters=""

1099

1100

<hr>

1101

1102

<a name="URLReferrerWithQuery">URLReferrerWithQuery</a>

1103

Version : 5.1+

1104

# Keep or remove the query string to the referrer URL in the statistics for

1105

# external referrer pages. This is used to differentiate between the URLs of

1106

# dynamic referrer pages. If set to 1, mypage.html?id=x and mypage.html?id=y

1107

# are counted as two different referrer pages.

1108

# Possible values:

1109

# 0 - Referrer URLs are cleaned from the query string (ie: "/mypage.html")

1110

# 1 - Full URL with query string is used (ie: "/mypage.html?p=x&q=y")

1111

# Default: 0

1112

#

1113

URLReferrerWithQuery=0

1114

1115

<hr>

1116

1117

<a name="WarningMessages">WarningMessages</a>

1118

Version : 1.0+

1119

# AWStats can detect setup problems or show you important informations to have

1120

# a better use. Keep this to 1, except if AWStats says you can change it.

1121

# Possible values: 0 or 1

1122

# Default: 1

1123

#

1124

WarningMessages=1

1125

1126

<hr>

1127

1128

<a name="ErrorMessages">ErrorMessages</a>

1129

Version : 5.2+

1130

# When an error occurs, AWStats output a message related to errors. If you

1131

# want (in most cases for security reasons) to have no error messages, you

1132

# can set this parameter to your personalized generic message.

1133

# Example: "An error occured. Contact your Administrator"

1134

# Default: ""

1135

#

1136

ErrorMessages=""

1137

1138

<hr>

1139

1140

<a name="DebugMessages">DebugMessages</a>

1141

Version : 5.2+

1142

# AWStat can be run with debug=x parameter to output various informations

1143

# to help in debugging or solving troubles. If you want to allow this (not

1144

# enabled by default for security reasons), set this parameter to 0.

1145

# Change : Effective immediatly

1146

# Possible values: 0 or 1

1147

# Default: 0

1148

#

1149

DebugMessages=0

1150

1151

<hr>

1152

1153

<a name="NbOfLinesForCorruptedLog">NbOfLinesForCorruptedLog</a>

1154

Version : 3.2+

1155

# To help you to detect if your log format is good, AWStats report an error

1156

# if all the first NbOfLinesForCorruptedLog lines have a format that does not

1157

# match the LogFormat parameter.

1158

# However, some worm virus attack on your web server can result in a very high

1159

# number of corrupted lines in your log. So if you experience awstats stop

1160

# because of bad virus records at the beginning of your log file, you can

1161

# increase this parameter (very rare).

1162

# Default: 50

1163

#

1164

NbOfLinesForCorruptedLog=50

1165

1166

<hr>

1167

1168

<a name="SplitSearchString">SplitSearchString</a>

1169

1170

Version : 2.24 - 4.0 (deprecated since 4.1)

1171

This parameter has been removed since 4.1.

1172

AWStats 4.1+ supports both keywords AND keyphrases by default with no need of any parameter.

1173

1174

1175

<hr>

1176

1177

<a name="WrapperScript">WrapperScript</a>

1178

Version : 4.0+

1179

# For some particular integration needs, you may want to have CGI links to

1180

# point to another script than awstats.pl.

1181

# Use the name of this script in WrapperScript parameter.

1182

# Example: "awstatslauncher.pl"

1183

# Default: ""

1184

#

1185

WrapperScript=""

1186

1187

<hr>

1188

1189

<a name="DecodeUA">DecodeUA</a>

1190

Version : 5.0+

1191

# DecodeUA must be set to 1 if you use Roxen web server. This server converts

1192

# all spaces in user agent field into %20. This make the AWStats robots, os

1193

# and browsers detection fail in some cases. Just change it to 1 if and only

1194

# if your web server is Roxen.

1195

# Possible values: 0 or 1

1196

# Default: 0

1197

#

1198

DecodeUA=0

1199

1200

<hr>

1201

1202

<a name="MiscTrackerUrl">MiscTrackerUrl</a>

1203

Version : 5.6+

1204

# MiscTrackerUrl can be used to make AWStats able to detect some miscellanous

1205

# things, that can not be tracked on other way like:

1206

# - Screen size

1207

# - Screen color depth

1208

# - Java enabled

1209

# - Macromedia Director plugin

1210

# - Macromedia Shockwave plugin

1211

# - Realplayer G2 plugin

1212

# - QuickTime plugin

1213

# - Mediaplayer plugin

1214

# - Acrobat PDF plugin

1215

# To enable all this features, you must copy the awstats_misc_tracker.js file

1216

# into a /js/ directory stored in your web document root and add the following

1217

# HTML code at the end of your index page (before </BODY>) :

1218

# <script language=javascript src="/js/awstats_misc_tracker.js"></script>

1219

# If code is not added in index page, all this detection capabilities will be

1220

# disabled. You must also check that ShowScreenSizeStats and ShowMiscStats

1221

# parameters are set to 1 to make results appear in report page.

1222

# If you want to use another directory than /js/, you must also change the

1223

# awstatsmisctrackerurl variable into the awstats_misc_tracker.js file.

1224

# Change : Effective for new updates only.

1225

# Possible value: Full URL of javascript tracker file added in HTML code

1226

# Default: "/js/awstats_misc_tracker.js"

1227

#

1228

MiscTrackerUrl="/js/awstats_misc_tracker.js"

1229

1230

<hr>

1231

1232

<a name="LevelFor">LevelFor</a>

1233

Version : 4.0+

1234

6.0+ for LevelForFileTypesDetection, LevelForSearchEnginesDetection, LevelForKeywordsDetection, LevelForWormsDetection

1235

# Following values allows you to define accuracy of AWStats entities (robots,

1236

# browsers, os, referers, file types) detection.

1237

# It might be a good idea for large web sites or ISP that provides AWStats to

1238

# high number of customers, to set this parameter to 1 (or 0), instead of 2.

1239

# Possible values:

1240

# 0 = No detection,

1241

# 1 = Medium/Standard detection

1242

# 2 = Full detection

1243

# Change : Effective for new updates only

1244

# Default: 2 (0 for LevelForWormsDetection)

1245

#

1246

LevelForBrowsersDetection=2 # 0 disables Browsers detection.

1247

# 2 reduces AWStats speed by 2%

1248

LevelForOSDetection=2 # 0 disables OS detection.

1249

# 2 reduces AWStats speed by 3%

1250

LevelForRefererAnalyze=2 # 0 disables Origin detection.

1251

# 2 reduces AWStats speed by 14%

1252

LevelForRobotsDetection=2 # 0 disables Robots detection.

1253

# 2 reduces AWStats speed by 2.5%

1254

LevelForSearchEnginesDetection=2 # 0 disables Search engines detection.

1255

# 2 reduces AWStats speed by 9%

1256

LevelForKeywordsDetection=2 # 0 disables Keyphrases/Keywords detection.

1257

# 2 reduces AWStats speed by 1%

1258

LevelForFileTypesDetection=2 # 0 disables File types detection.

1259

# 2 reduces AWStats speed by 1%

1260

LevelForWormsDetection=0 # 0 disables Worms detection.

1261

# 2 reduces AWStats speed by 15%

1262

1263

<hr>

1264

1265

<a name="UseFramesWhenCGI">UseFramesWhenCGI</a>

1266

Version : 5.0+

1267

# When you use AWStats as a CGI, you can have the reports shown in HTML views.

1268

# Frames are only available for report viewed dynamically. When you build

1269

# pages from command line, this option is not used and no frames are built.

1270

# Possible values: 0 or 1

1271

# Default: 1

1272

#

1273

UseFramesWhenCGI=1

1274

1275

<hr>

1276

1277

<a name="DetailedReportsOnNewWindows">DetailedReportsOnNewWindows</a>

1278

Version : 4.1+ (5.0+ for value 2)

1279

# This parameter ask your browser to open detailed reports into a different

1280

# window than the main page.

1281

# Possible values:

1282

# 0 - Open all in same browser window

1283

# 1 - Open detailed reports in another window except if using frames

1284

# 2 - Open always in a different window even if reports are framed

1285

# Default: 1

1286

#

1287

DetailedReportsOnNewWindows=1

1288

1289

<hr>

1290

1291

<a name="Expires">Expires</a>

1292

Version : 3.1+

1293

# You can add, in the HTML report page, a cache lifetime (in seconds) that

1294

# will be returned to browser in HTTP header answer by server.

1295

# This parameter is not used when report are built with -staticlinks option.

1296

# Example: 3600

1297

# Default: 0

1298

#

1299

Expires=0

1300

1301

<hr>

1302

1303

<a name="MaxRowsInHTMLOutput">MaxRowsInHTMLOutput</a>

1304

Version : 4.0+

1305

# To avoid too large web pages, you can ask AWStats to limit number of rows of

1306

# all reported charts to this number when no other limit apply.

1307

# Default: 1000

1308

#

1309

MaxRowsInHTMLOutput=1000

1310

1311

<hr>

1312

1313

1314

Version : 2.1+

1315

# Set your primary language.

1316

# Possible value:

1317

# Albanian=al, Bosnian=ba, Bulgarian=bg,

1318

# Chinese (Taiwan)=tw, Chinese (Simpliefied)=cn, Czech=cz,

1319

# Danish=dk, Dutch=nl, English=en, Estonian=et, Finnish=fi, French=fr,

1320

# German=de, Greek=gr, Hebrew=he, Hungarian=hu, Indonesian=id, Italian=it,

1321

# Japanese=jp, Korean=kr, Latvian=lv, Norwegian (Nynorsk)=nn,

1322

# Norwegian (Bokmal)=nb, Polish=pl, Portuguese=pt, Portuguese (Brazilian)=br,

1323

# Romanian=ro, Russian=ru, Serbian=sr, Slovak=sk, Spanish=es,

1324

# Spanish (Catalan)=es_cat, Swedish=se, Turkish=tr, Ukrainian=ua, Welsh=wlk.

1325

# First available language accepted by browser=auto

1326

# Default: "auto"

1327

#

1328

Lang="auto"

1329

1330

<hr>

1331

1332

<a name="DirLang">DirLang</a>

1333

Version : 2.1+

1334

# Set the location of language files.

1335

# Example: "/usr/share/awstats/lang"

1336

# Default: "./lang" (means lang directory is in same location than awstats.pl)

1337

#

1338

DirLang="./lang"

1339

1340

<hr>

1341

1342

1343

Version :

1344

3.2 - 5.0 for ShowCompressionStats (deprecated since 5.1, use code C with ShowFileTypesStats instead)

1345

3.2 - 5.3 for ShowHeader (deprecated since 5.4)

1346

3.2+ for ShowMenu,ShowMonthStats,ShowDaysOfWeekStats,ShowHoursStats,

1347

ShowDomainsStats,ShowHostsStats,ShowAuthenticatedUsers,ShowRobotsStats,

1348

ShowPagesStats,ShowFileTypesStats,ShowFileSizesStats,ShowBrowsersStats,

1349

ShowOSStats,ShowOriginStats,ShowKeyphrasesStats,ShowKeywordsStats,ShowHTTPErrorsStats

1350

4.1+ for ShowSessionsStats, ShowKeywordsStats

1351

5.1+ for all letters codes

1352

5.5+ for ShowDaysOfMonthStats

1353

5.6+ for ShowMiscStats,ShowSTMPErrorsStats

1354

5.8+ for ShowClusterStats

1355

6.0+ for ShowWormsStats

1356

6.4+ for ShowSummary 7.0+ for ShowDownloadsStats

1357

# You choose here which reports you want to see in the main page and what you

1358

# want to see in those reports.

1359

# Possible values:

1360

# 0 - Report is not shown at all

1361

# 1 - Report is shown in main page with an entry in menu and default columns

1362

# XYZ - Report shows column informations defined by code X,Y,Z...

1363

# X,Y,Z... are code letters among the following:

1364

# U = Unique visitors

1365

# V = Visits

1366

# P = Number of pages

1367

# H = Number of hits (or mails)

1368

# B = Bandwith (or total mail size for mail logs)

1369

# L = Last access date

1370

# E = Entry pages

1371

# X = Exit pages

1372

# C = Web compression (mod_gzip,mod_deflate)

1373

# M = Average mail size (mail logs)

1374

#

1375

1376

# Show menu header with reports' links

1377

# Possible values: 0 or 1

1378

# Default: 1

1379

#

1380

ShowMenu=1

1381

1382

# Show monthly summary

1383

# Context: Web, Streaming, Mail, Ftp

1384

# Default: UVPHB, Possible column codes: UVPHB

1385

ShowSummary=UVPHB

1386

1387

# Show monthly chart

1388

# Context: Web, Streaming, Mail, Ftp

1389

# Default: UVPHB, Possible column codes: UVPHB

1390

ShowMonthStats=UVPHB

1391

1392

# Show days of month chart

1393

# Context: Web, Streaming, Mail, Ftp

1394

# Default: VPHB, Possible column codes: VPHB

1395

ShowDaysOfMonthStats=VPHB

1396

1397

# Show days of week chart

1398

# Context: Web, Streaming, Mail, Ftp

1399

# Default: PHB, Possible column codes: PHB

1400

ShowDaysOfWeekStats=PHB

1401

1402

# Show hourly chart

1403

# Context: Web, Streaming, Mail, Ftp

1404

# Default: PHB, Possible column codes: PHB

1405

ShowHoursStats=PHB

1406

1407

# Show domains/country chart

1408

# Context: Web, Streaming, Mail, Ftp

1409

# Default: PHB, Possible column codes: PHB

1410

ShowDomainsStats=PHB

1411

1412

# Show hosts chart

1413

# Context: Web, Streaming, Mail, Ftp

1414

# Default: PHBL, Possible column codes: PHBL

1415

ShowHostsStats=PHBL

1416

1417

# Show authenticated users chart

1418

# Context: Web, Streaming, Ftp

1419

# Default: 0, Possible column codes: PHBL

1420

ShowAuthenticatedUsers=0

1421

1422

# Show robots chart

1423

# Context: Web, Streaming

1424

# Default: HBL, Possible column codes: HBL

1425

ShowRobotsStats=HBL

1426

1427

# Show worms chart

1428

# Context: Web, Streaming

1429

# Default: 0 (If set to other than 0, see also LevelForWormsDetection), Possible column codes: HBL

1430

ShowWormsStats=0

1431

1432

# Show email senders chart (For use when analyzing mail log files)

1433

# Context: Mail

1434

# Default: 0, Possible column codes: HBML

1435

ShowEMailSenders=0

1436

1437

# Show email receivers chart (For use when analyzing mail log files)

1438

# Context: Mail

1439

# Default: 0, Possible column codes: HBML

1440

ShowEMailReceivers=0

1441

1442

# Show session chart

1443

# Context: Web, Streaming, Ftp

1444

# Default: 1, Possible column codes: None

1445

ShowSessionsStats=1

1446

1447

# Show pages-url chart.

1448

# Context: Web, Streaming, Ftp

1449

# Default: PBEX, Possible column codes: PBEX

1450

ShowPagesStats=PBEX

1451

1452

# Show file types chart.

1453

# Context: Web, Streaming, Ftp

1454

# Default: HB, Possible column codes: HBC

1455

ShowFileTypesStats=HB

1456

1457

# Show file size chart (Not yet available)

1458

# Context: Web, Streaming, Mail, Ftp

1459

# Default: 1, Possible column codes: None

1460

ShowFileSizesStats=0

1461

# Show downloads chart. # Context: Web, Streaming, Ftp # Default: HB, Possible column codes: HB ShowDownloadsStats=HB

1462

# Show operating systems chart

1463

# Context: Web, Streaming, Ftp

1464

# Default: 1, Possible column codes: None

1465

ShowOSStats=1

1466

1467

# Show browsers chart

1468

# Context: Web, Streaming

1469

# Default: 1, Possible column codes: None

1470

ShowBrowsersStats=1

1471

1472

# Show screen size chart

1473

# Context: Web, Streaming

1474

# Default: 0 (If set to 1, see also MiscTrackerUrl), Possible column codes: None

1475

ShowScreenSizeStats=0

1476

1477

# Show origin chart

1478

# Context: Web, Streaming

1479

# Default: PH, Possible column codes: PH

1480

ShowOriginStats=PH

1481

1482

# Show keyphrases chart

1483

# Context: Web, Streaming

1484

# Default: 1, Possible column codes: None

1485

ShowKeyphrasesStats=1

1486

1487

# Show keywords chart

1488

# Context: Web, Streaming

1489

# Default: 1, Possible column codes: None

1490

ShowKeywordsStats=1

1491

1492

# Show misc chart

1493

# Context: Web, Streaming

1494

# Default: a (See also MiscTrackerUrl parameter), Possible column codes: anjdfrqwp

1495

ShowMiscStats=a

1496

1497

# Show http errors chart

1498

# Context: Web, Streaming

1499

# Default: 1, Possible column codes: None

1500

ShowHTTPErrorsStats=1

1501

1502

# Show smtp errors chart (For use when analyzing mail log files)

1503

# Context: Mail

1504

# Default: 0, Possible column codes: None

1505

ShowSMTPErrorsStats=0

1506

1507

# Show the cluster report (Your LogFormat must contains the %cluster tag)

1508

# Context: Web, Streaming, Ftp

1509

# Default: 0, Possible column codes: PHB

1510

ShowClusterStats=0

1511

1512

<hr>

1513

1514

<a name="AddDataArray">AddDataArray...</a>

1515

Version :

1516

5.4+ for AddDataArrayMonthStats,AddDataArrayShowDaysOfWeekStats,AddDataArrayShowHoursStats

1517

5.5+ for AddDataArrayShowDaysOfMonthStats

1518

# Some graphical reports are followed by the data array of values.

1519

# If you don't want this array (to reduce report size for example), you can

1520

# set thoose options to 0.

1521

# Possible values: 0 or 1

1522

# Default: 1

1523

#

1524

# Data array values for the ShowMonthStats report

1525

AddDataArrayMonthStats=1

1526

# Data array values for the ShowDaysOfMonthStats report

1527

AddDataArrayShowDaysOfMonthStats=1

1528

# Data array values for the ShowDaysOfWeekStats report

1529

AddDataArrayShowDaysOfWeekStats=1

1530

# Data array values for the ShowHoursStats report

1531

AddDataArrayShowHoursStats=1

1532

1533

<hr>

1534

1535

<a name="IncludeInternalLinksInOriginSection">IncludeInternalLinksInOriginSection</a>

1536

Version : 6.1+

1537

# In the Origin chart, you have stats on where your hits came from. You can

1538

# includes hits on pages that comes from pages of same sites in this chart.

1539

# Possible values: 0 or 1

1540

# Default: 0

1541

#

1542

IncludeInternalLinksInOriginSection=0

1543

1544

<hr>

1545

1546

1547

Version : 1.0+

1548

# This value can be used to choose maximum number of lines shown for each

1549

# particular reporting.

1550

#

1551

# Stats by domains

1552

MaxNbOfDomain = 10

1553

MinHitDomain = 1

1554

# Stats by hosts

1555

MaxNbOfHostsShown = 10

1556

MinHitHost = 1

1557

# Stats by authenticated users

1558

MaxNbOfLoginShown = 10

1559

MinHitLogin = 1

1560

# Stats by robots

1561

MaxNbOfRobotShown = 10

1562

MinHitRobot = 1

1563

# Stats for Downloads MaxNbOfDownloadsShown = 10 MinHitDownloads = 1 # Stats by pages

1564

MaxNbOfPageShown = 10

1565

MinHitFile = 1

1566

# Stats by OS

1567

MaxNbOfOsShown = 10

1568

MinHitOs = 1

1569

# Stats by browsers

1570

MaxNbOfBrowsersShown = 10

1571

MinHitBrowser = 1

1572

# Stats by screen size

1573

MaxNbOfScreenSizesShown = 5

1574

MinHitScreenSize = 1

1575

# Stats by referers

1576

MaxNbOfRefererShown = 10

1577

MinHitRefer = 1

1578

# Stats for keywords

1579

MaxNbOfKeywordsShown = 10

1580

MinHitKeyword = 1

1581

# Stats for sender or receiver emails

1582

MaxNbOfEMailsShown = 20

1583

MinHitEMail = 1

1584

1585

<hr>

1586

1587

<a name="FirstDayOfWeek">FirstDayOfWeek</a>

1588

Version : 3.2+

1589

# Choose if you want week to start on sunday or monday

1590

# Possible values:

1591

# 0 - Week start on sunday

1592

# 1 - Week start on monday

1593

# Default: 1

1594

#

1595

FirstDayOfWeek=1

1596

1597

<hr>

1598

1599

<a name="ShowFlagLinks">ShowFlagLinks</a>

1600

Version : 3.2+

1601

# List of visible flags with link to other language translations.

1602

# See Lang parameter for list of allowed flag/language codes.

1603

# If you don't want any flag link, set ShowFlagLinks to "".

1604

# This parameter is used only if ShowMenu parameter is set to 1.

1605

# Possible values: "" or "language_codes_separated_by_space"

1606

# Default: "en es fr it nl es"

1607

#

1608

ShowFlagLinks="en fr de it nl es"

1609

1610

<hr>

1611

1612

<a name="ShowLinksOnUrl">ShowLinksOnUrl</a>

1613

Version : 3.1+

1614

# Each URL shown in stats report views are links you can click.

1615

# Possible values: 0 or 1

1616

# Default: 1

1617

#

1618

ShowLinksOnUrl=1

1619

1620

<hr>

1621

1622

<a name="UseHTTPSLinkForUrl">UseHTTPSLinkForUrl</a>

1623

Version : 4.0+

1624

# When AWStats build HTML links in its report pages, it starts thoose link

1625

# with "http://". However some links might be HTTPS links, so you can enter

1626

# here the root of all your HTTPS links. If all your site is a SSL web site,

1627

# just enter "/".

1628

# This parameter is not used if ShowLinksOnUrl is 0.

1629

# Example: "/shopping"

1630

# Example: "/"

1631

# Default: ""

1632

#

1633

UseHTTPSLinkForUrl=""

1634

1635

<hr>

1636

1637

<a name="MaxLengthOfShownURL">MaxLengthOfShownURL</a>

1638

Version : 1.0+

1639

# Maximum length of URL part shown on stats page (number of characters).

1640

# This affects only URL visible text, larger links still work.

1641

# Default: 64

1642

#

1643

MaxLengthOfShownURL=64

1644

1645

<hr>

1646

1647

<a name="ShowLinksToWhoIs">ShowLinksToWhoIs</a>

1648

1649

Version : 4.0 - 5.6 (deprecated since 5.7, replaced by plugin 'hostinfo')

1650

This parameter has been removed since 5.7.

1651

You must enable the plugin 'hostinfo' to get the same result if you were using this

1652

parameter.

1653

1654

1655

<hr>

1656

1657

<a name="LinksToWhoIs">LinksToWhoIs</a>

1658

1659

Version : 4.0 - 5.9 (deprecated since 6.0, replaced by plugin 'hostinfo')

1660

This parameter has been removed since 6.0.

1661

This parameter is no more required.

1662

1663

1664

<hr>

1665

1666

<a name="LinksToIPWhoIs">LinksToIPWhoIs</a>

1667

1668

Version : 5.0 - 5.9 (deprecated since 6.0, replaced by plugin 'hostinfo')

1669

This parameter has been removed since 6.0.

1670

This parameter is no more required.

1671

1672

1673

<hr>

1674

1675

<a name="HTMLHeadSection">HTMLHeadSection</a>

1676

Version : 3.2+

1677

# You can enter HTML code that will be added at the top of AWStats reports.

1678

# Default: ""

1679

#

1680

HTMLHeadSection=""

1681

1682

<hr>

1683

1684

<a name="HTMLEndSection">HTMLEndSection</a>

1685

Version : 3.2+

1686

# You can enter HTML code that will be added at the end of AWStats reports.

1687

# Great to add advert ban.

1688

# Default: ""

1689

#

1690

HTMLEndSection=""

1691

1692

<hr>

1693

1694

1695

Version : 1.0+

1696

# Value of maximum bar width/height for horizontal/vertical HTML graphics bar.

1697

# Default: 260/90

1698

#

1699

BarWidth = 260

1700

BarHeight = 90

1701

1702

<hr>

1703

1704

1705

Version : 3.1+

1706

# You can set Logo and LogoLink to use your own logo.

1707

# Logo must be the name of image file (must be in $DirIcons/other directory).

1708

# LogoLink is the expected URL when clicking on Logo.

1709

# Default: "awstats_logo1.png"

1710

#

1711

Logo="awstats_logo1.png"

1712

LogoLink="http://awstats.sourceforge.net"

1713

1714

<hr>

1715

1716

<a name="StyleSheet">StyleSheet</a>

1717

Version : 5.6+

1718

# You can ask AWStats to use a particular CSS (Cascading Style Sheet) to

1719

# change its look. To create a style sheet, you can use samples provided with

1720

# AWStats in wwwroot/css directory.

1721

# Example: "/awstatscss/awstats_bw.css"

1722

# Example: "/css/awstats_bw.css"

1723

# Default: ""

1724

#

1725

StyleSheet=""

1726

1727

<hr>

1728

1729

<a name="color_">color_...</a>

1730

Version :

1731

3.1 for color_Background,color_TableBGTitle,color_TableTitle,color_TableBG,

1732

color_TableRowTitle,color_TableBGRowTitle,color_TableBorder,color_text,

1733

color_textpercent,color_titletext,color_weekend,color_link,color_hover,

1734

color_u,color_v,color_p,color_h,color_k,color_s

1735

4.1 for color_e,color_x

1736

5.0 for color_other

1737

# Those colors parameters can be used (if StyleSheet parameter is not used)

1738

# to change AWStats look.

1739

# Example: color_name="RRGGBB" # RRGGBB is Red Green Blue components in Hex

1740

#

1741

color_Background="FFFFFF" # Background color for main page (Default = "FFFFFF")

1742

color_TableBGTitle="CCCCDD" # Background color for table title (Default = "CCCCDD")

1743

color_TableTitle="000000" # Table title font color (Default = "000000")

1744

color_TableBG="CCCCDD" # Background color for table (Default = "CCCCDD")

1745

color_TableRowTitle="FFFFFF" # Table row title font color (Default = "FFFFFF")

1746

color_TableBGRowTitle="ECECEC" # Background color for row title (Default = "ECECEC")

1747

color_TableBorder="ECECEC" # Table border color (Default = "ECECEC")

1748

color_text="000000" # Color of text (Default = "000000")

1749

color_textpercent="606060" # Color of text for percent values (Default = "606060")

1750

color_titletext="000000" # Color of text title within colored Title Rows (Default = "000000")

1751

color_weekend="EAEAEA" # Color for week-end days (Default = "EAEAEA")

1752

color_link="0011BB" # Color of HTML links (Default = "0011BB")

1753

color_hover="605040" # Color of HTML on-mouseover links (Default = "605040")

1754

color_other="666688" # Color of text for 'other' record in charts (Default = "666688")

1755

color_u="FFB055" # Background color for number of unique visitors (Default = "FFB055")

1756

color_v="F8E880" # Background color for number of visites (Default = "F8E880")

1757

color_p="4477DD" # Background color for number of pages (Default = "4477DD")

1758

color_h="66F0FF" # Background color for number of hits (Default = "66F0FF")

1759

color_k="2EA495" # Background color for number of bytes (Default = "2EA495")

1760

color_s="8888DD" # Background color for number of search (Default = "8888DD")

1761

color_e="CEC2E8" # Background color for number of entry pages (Default = "CEC2E8")

1762

color_x="C1B2E2" # Background color for number of exit pages (Default = "C1B2E2")

1763

1764

<hr>

1765

1766

<a name="LoadPlugin">LoadPlugin</a>

1767

Version : 5.0+

1768

# Add here all plugins file you want to load.

1769

# Plugin files must be .pm files stored in 'plugins' directory.

1770

# Uncomment LoadPlugin lines to enable a plugin after checking that plugin

1771

# required perl modules are installed.

1772

1773

# Plugin: PluginName

1774

# PluginName description

1775

# Perl modules required: ...

1776

#

1777

LoadPlugin="pluginname"

1778

1779

<hr>

1780

1781

<a name="Extra">Extra...</a>

1782

Version :

1783

5.2+

1784

5.8 for ExtraSectionFirstColumnFormatX, ExtraSectionAddAverageRowX, ExtraSectionAddSumRowX

1785

You can see the <a href="awstats_extra.html">following page</a> for explanation of

1786

all ExtraSection...X directives and how to use them.

1787

1788

<hr>

1789

1790

<a name="ExtraTrackedRowsLimit">ExtraTrackedRowsLimit</a>

1791

Version : 6.1

1792

# There is also a global parameter ExtraTrackedRowsLimit that limit the

1793

# number of possible rows an ExtraSection can report. This parameter is

1794

# here to protect too much memory use when you make a bad setup in your

1795

# ExtraSection. It applies to all ExtraSection independently meaning that

1796

# none ExtraSection can report more rows than value defined by ExtraTrackedRowsLimit.

1797

# If you know an ExtraSection will report more rows than its value, you should

1798

# increase this parameter or AWStats will stop with an error.

1799

# Example: 2000

1800

# Default: 500

1801

#

1802

ExtraTrackedRowsLimit=500

1803

1804

<hr>

1805

1806

<a name="Include">Include</a>

1807

Version : 5.4+

1808

# You can include other config files using the directive with the name of the

1809

# config file.

1810

# This is particularly usefull for users who have a lot of virtual servers, so

1811

# a lot of config files and want to maintain common values in only one file.

1812

# Note that when a variable is defined both in a config file and in an

1813

# included file, AWStats will use the last value read for parameters that

1814

# contains one value and AWStats will concat all values from both files for

1815

# parameters that are lists of value.

1816

#

1817

Include ""

1818

1819

1820

1821

1822

<hr>

1823

1824

1825

var date='$Date: 2010/06/22 21:35:24 $';

1826

document.writeln("Last revision: "+date);

1827

</script>

1828

1829

</body></html>

b'\\ No newline at end of file'