~ubuntu-branches/debian/jessie/awstats/jessie : revision 22

1

# AWSTATS CONFIGURE FILE 7.1

2

#-----------------------------------------------------------------------------

3

# Copy this file into awstats.www.mydomain.conf and edit this new config file

4

# to setup AWStats (See documentation in docs/ directory).

5

# The config file must be in /etc/awstats, /usr/local/etc/awstats or /etc (for

6

# Unix/Linux) or same directory than awstats.pl (Windows, Mac, Unix/Linux...)

7

# To include an environment variable in any parameter (AWStats will replace

8

# it with its value when reading it), follow the example:

9

# Parameter="__ENVNAME__"

10

# Note that environment variable AWSTATS_CURRENT_CONFIG is always defined with

11

# the config value in an AWStats running session and can be used like others.

12

#-----------------------------------------------------------------------------

13

# $Revision: 1.355 $ - $Author: eldy $ - $Date: 2013/02/10 15:39:22 $

14

15

16

17

#-----------------------------------------------------------------------------

18

# MAIN SETUP SECTION (Required to make AWStats work)

19

#-----------------------------------------------------------------------------

20

21

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

22

# Possible values: A full path, or a relative path from awstats.pl directory.

23

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

24

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

25

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

26

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

27

# of its execution). This is available tags :

28

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

29

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

30

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

31

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

32

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

33

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

34

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

35

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

36

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

37

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

38

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

39

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

40

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

41

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

42

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

43

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

44

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

45

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

46

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

47

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

48

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

49

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

50

#

51

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

52

53

54

# Enter the log file type you want to analyze.

55

# Possible values:

56

# W - For a web log file

57

# S - For a streaming log file

58

# M - For a mail log file

59

# F - For a ftp log file

60

# Example: W

61

# Default: W

62

#

63

LogType=W

64

65

66

# Enter here your log format (Must match your web server config. See setup

67

# instructions in documentation to know how to configure your web server to

68

# have the required log format).

69

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

70

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

71

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

72

# 3 - Webstar native log format.

73

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

74

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

75

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

76

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

77

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

78

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

79

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

80

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

81

# %logname Authenticated login/user with format: john

82

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

83

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

84

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

85

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

86

# %time5 Date and time with format iso: yyyy-mm-ddThh:mm:ss

87

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

88

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

89

# %method Method with format: GET

90

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

91

# %query Query string (used by URLWithQuery option)

92

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

93

# %bytesd Size of document in bytes

94

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

95

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

96

# %uabracket User agent with format: [Mozilla/4.0 (compatible, ...)]

97

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

98

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

99

# %gzipin mod_gzip compression input bytes: In:XXX

100

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

101

# %gzipratio mod_gzip compression ratio: ZZpct.

102

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

103

# %email EMail sender (for mail log)

104

# %email_r EMail receiver (for mail log)

105

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

106

# contains data of several virtual web servers. AWStats

107

# will discard records not in SiteDomain nor HostAliases

108

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

109

# logresolvemerge.pl), use this to define cluster id field.

110

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

111

# personalized report with ExtraSection feature (See later).

112

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

113

# %other Means another not used field

114

# %otherquot Means another not used double quoted field

115

#

116

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

117

# LogFormat = 1

118

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

119

#

120

# Example for IIS:

121

# LogFormat = 2

122

#

123

LogFormat=1

124

125

126

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

127

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

128

# Backslash can be used as escape character.

129

# Example: " "

130

# Example: "\t"

131

# Example: "\|"

132

# Example: ","

133

# Default: " "

134

#

135

LogSeparator=" "

136

137

138

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

139

# server name, used to reach the web site.

140

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

141

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

142

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

143

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

144

# %virtualname tag).

145

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

146

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

147

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

148

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

149

# Example: "myintranetserver"

150

# Example: "www.domain.com"

151

# Example: "ftp.domain.com"

152

# Example: "domain.com"

153

#

154

SiteDomain=""

155

156

157

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

158

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

159

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

160

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

161

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

162

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

163

# another site.

164

# Note: Use space between each value.

165

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

166

# Note: You can also use @/mypath/myfile if list of aliases are in a file.

167

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

168

#

169

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

170

171

172

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

173

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

174

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

175

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

176

# in log file).

177

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

178

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

179

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

180

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

181

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

182

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

183

# Possible values:

184

# 0 - No DNS Lookup

185

# 1 - DNS Lookup is fully enabled

186

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

187

# Default: 2

188

#

189

DNSLookup=2

190

191

192

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

193

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

194

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

195

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

196

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

197

# feature (see later), you need "Write" permissions by web server user on this

198

# directory (and "Modify" for Windows NTFS file systems).

199

# Example: "/var/lib/awstats"

200

# Example: "../data"

201

# Example: "C:/awstats_data_dir"

202

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

203

#

204

DirData="."

205

206

207

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

208

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

209

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

210

# Example: "/awstats"

211

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

212

#

213

DirCgi="/cgi-bin"

214

215

216

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

217

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

218

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

219

# Example: "/awstatsicons"

220

# Example: "../icon"

221

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

222

#

223

DirIcons="/icon"

224

225

226

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

227

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

228

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

229

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

230

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

231

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

232

# necessary to "Read/Write" (and "Modify" for Windows NTFS file systems).

233

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

234

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

235

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

236

# line interface (or a task scheduler).

237

# Possible values: 0 or 1

238

# Default: 0

239

#

240

AllowToUpdateStatsFromBrowser=0

241

242

243

# AWStats saves and sorts its database on a month basis (except if using

244

# databasebreak option from command line).

245

# However, if you choose the -month=all from command line or

246

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

247

# needs to reload all data for full year (each month), and sort them,

248

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

249

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

250

# servers, to non CPU cautious customers.

251

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

252

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

253

# Possible values:

254

# 0 - Never allowed

255

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

256

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

257

# 3 - Possible on CLI and CGI

258

# Default: 2

259

#

260

AllowFullYearView=2

261

262

263

264

#-----------------------------------------------------------------------------

265

# OPTIONAL SETUP SECTION (Not required but increase AWStats features)

266

#-----------------------------------------------------------------------------

267

268

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

269

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

270

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

271

# AllowToUpdateStatsFromBrowser is set to 1.

272

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

273

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

274

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

275

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

276

# Change : Effective immediatly

277

# Possible values: 0 or 1

278

# Default: 0

279

#

280

EnableLockForUpdate=0

281

282

283

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

284

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

285

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

286

# This option is not used if DNSLookup=0.

287

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

288

# or just 'ipaddress resolved_hostname'

289

# Change : Effective for new updates only

290

# Example: "/mydnscachedir/dnscache"

291

# Default: "dnscache.txt"

292

#

293

DNSStaticCacheFile="dnscache.txt"

294

295

296

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

297

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

298

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

299

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

300

# This option is used only if DNSLookup=1.

301

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

302

# lookup in DNSLastUpdateCacheFile after checking into DNSStaticCacheFile.

303

# Change : Effective for new updates only

304

# Example: "/mydnscachedir/dnscachelastupdate"

305

# Default: "dnscachelastupdate.txt"

306

#

307

DNSLastUpdateCacheFile="dnscachelastupdate.txt"

308

309

310

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

311

# This option is used only if DNSLookup=1.

312

# Note: Use space between each value.

313

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

314

# Change : Effective for new updates only

315

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

316

# Default: ""

317

#

318

SkipDNSLookupFor=""

319

320

321

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

322

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

323

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

324

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

325

# your server setup manual).

326

# Change : Effective immediatly

327

# Possible values: 0 or 1

328

# Default: 0

329

#

330

AllowAccessFromWebToAuthenticatedUsersOnly=0

331

332

333

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

334

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

335

# AllowAccessFromWebToAuthenticatedUsersOnly is set to 1.

336

# Change : Effective immediatly

337

# Example: "user1 user2"

338

# Example: "__REMOTE_USER__"

339

# Default: ""

340

#

341

AllowAccessFromWebToFollowingAuthenticatedUsers=""

342

343

344

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

345

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

346

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

347

# Change : Effective immediatly

348

# Example: "127.0.0.1 123.123.123.1-123.123.123.255"

349

# Default: ""

350

#

351

AllowAccessFromWebToFollowingIPAddresses=""

352

353

354

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

355

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

356

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

357

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

358

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

359

# Change : Effective immediatly

360

# Possible values: 0 or 1

361

# Default: 0

362

#

363

CreateDirDataIfNotExists=0

364

365

366

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

367

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

368

# larger than using "text" format.

369

# Change : Database format is switched after next update

370

# Possible values: text or xml

371

# Default: text

372

#

373

BuildHistoryFormat=text

374

375

376

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

377

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

378

# properly with old browsers).

379

# Change : Effective immediatly

380

# Possible values: html or xhtml

381

# Default: html

382

#

383

BuildReportFormat=html

384

385

386

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

387

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

388

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

389

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

390

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

391

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

392

# files with read and write permissions for everyone.

393

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

394

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

395

# Change : Effective for new updates only

396

# Possible values: 0 or 1

397

# Default: 0

398

#

399

SaveDatabaseFilesWithPermissionsForEveryone=0

400

401

402

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

403

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

404

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

405

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

406

# that make this purge frequently.

407

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

408

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

409

# file to be purged).

410

# Change : Effective for new updates only

411

# Possible values: 0 or 1

412

# Default: 0

413

#

414

PurgeLogFile=0

415

416

417

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

418

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

419

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

420

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

421

# awstats_archive.configname[.suffix].log

422

# This parameter is not used if PurgeLogFile=0

423

# Change : Effective for new updates only

424

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

425

# Example: 1

426

# Example: %YYYY%MM%DD

427

# Default: 0

428

#

429

ArchiveLogRecords=0

430

431

432

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

433

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

434

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

435

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

436

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

437

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

438

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

439

# Change : Effective for new updates only

440

# Possible values: 0 or 1

441

# Default: 0

442

#

443

KeepBackupOfHistoricFiles=0

444

445

446

# Default index page name for your web server.

447

# Change : Effective for new updates only

448

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

449

# Default: "index.php index.html"

450

#

451

DefaultFile="index.php index.html"

452

453

454

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

455

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

456

# matching IP addresses criteria.

457

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

458

# criteria, else enter ip address criteria.

459

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

460

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

461

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

462

# Change : Effective for new updates only

463

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

464

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

465

# Default: ""

466

#

467

SkipHosts=""

468

469

470

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

471

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

472

# file instead of this parameter.

473

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

474

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

475

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

476

# Change : Effective for new updates only

477

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

478

# Default: ""

479

#

480

SkipUserAgents=""

481

482

483

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

484

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

485

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

486

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

487

# all its query paramaters.

488

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

489

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

490

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

491

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

492

# depending on URLNotCaseSensitive parameter.

493

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

494

# Change : Effective for new updates only

495

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

496

# Default: ""

497

#

498

SkipFiles=""

499

500

501

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

502

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

503

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

504

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

505

# Change : Effective for new updates only

506

# Example: "/mylibpath/blacklist.txt"

507

# Default: ""

508

#

509

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

510

# with black list file provided with AWStats !

511

#

512

SkipReferrersBlackList=""

513

514

515

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

516

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

517

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

518

# this parameter.

519

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

520

# criteria, else enter ip address criteria.

521

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

522

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

523

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

524

# Change : Effective for new updates only

525

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

526

# Default: ""

527

#

528

OnlyHosts=""

529

530

531

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

532

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

533

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

534

# string in this parameter.

535

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

536

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

537

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

538

# Change : Effective for new updates only

539

# Example: "msie"

540

# Default: ""

541

#

542

OnlyUserAgents=""

543

544

545

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

546

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

547

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

548

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

549

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

550

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

551

# Change : Effective for new updates only

552

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

553

# Default: ""

554

#

555

OnlyUsers=""

556

557

558

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

559

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

560

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

561

# directory name in this parameter.

562

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

563

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

564

# depending on URLNotCaseSensitive parameter.

565

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

566

# Change : Effective for new updates only

567

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

568

# Default: ""

569

#

570

OnlyFiles=""

571

572

573

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

574

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

575

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

576

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

577

# Pages/URL report.

578

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

579

# Hits reported), you must use SkipFiles parameter.

580

# Change : Effective for new updates only

581

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

582

# Example: ""

583

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

584

#

585

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

586

587

588

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

589

# successful hits if HTTP code returned by server is a valid HTTP code (200

590

# and 304). Any other code are reported in HTTP status chart.

591

# Note that HTTP 'control codes', like redirection (302, 305) are not added by

592

# default in this list as they are not pages seen by a visitor but are

593

# protocol exchange codes to tell the browser to ask another page. Because

594

# this other page will be counted and seen with a 200 or 304 code, if you

595

# add such codes, you will have 2 pages viewed reported for only one in facts.

596

# Change : Effective for new updates only

597

# Example: "200 304 302 305"

598

# Default: "200 304"

599

#

600

ValidHTTPCodes="200 304"

601

602

603

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

604

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

605

# log file match values defined by this parameter.

606

# Change : Effective for new updates only

607

# Example: "1 250 200"

608

# Default: "1 250"

609

#

610

ValidSMTPCodes="1 250"

611

612

613

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

614

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

615

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

616

# Change : Effective for new updates only

617

# Possible values: 0 or 1

618

# Default: 0

619

#

620

AuthenticatedUsersNotCaseSensitive=0

621

622

623

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

624

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

625

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

626

# Change : Effective for new updates only

627

# Possible values: 0 or 1

628

# Default: 0

629

#

630

URLNotCaseSensitive=0

631

632

633

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

634

# Change : Effective for new updates only

635

# Possible values: 0 or 1

636

# Default: 0

637

#

638

URLWithAnchor=0

639

640

641

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

642

# /mypage.html?param1=value1&param2=value2

643

# However, some servers/sites use also other chars to isolate dynamic part of

644

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

645

# Change : Effective for new updates only

646

# Example: "?;,"

647

# Default: "?;"

648

#

649

URLQuerySeparators="?;"

650

651

652

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

653

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

654

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

655

# different pages.

656

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

657

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

658

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

659

# the next parameter URLWithQueryWithOnlyFollowingParameters (or eventually

660

# URLWithQueryWithoutFollowingParameters).

661

# Change : Effective for new updates only

662

# Possible values:

663

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

664

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

665

# Default: 0

666

#

667

URLWithQuery=0

668

669

670

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

671

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

672

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

673

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

674

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

675

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

676

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

677

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

678

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

679

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

680

# URLWithQueryWithoutFollowingParameters.

681

# Change : Effective for new updates only

682

# Example: "param"

683

# Default: ""

684

#

685

URLWithQueryWithOnlyFollowingParameters=""

686

687

688

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

689

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

690

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

691

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

692

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

693

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

694

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

695

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

696

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

697

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

698

# URLWithQueryWithOnlyFollowingParameters.

699

# Change : Effective for new updates only

700

# Example: "PHPSESSID jsessionid"

701

# Default: ""

702

#

703

URLWithQueryWithoutFollowingParameters=""

704

705

706

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

707

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

708

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

709

# are counted as two different referrer pages.

710

# Change : Effective for new updates only

711

# Possible values:

712

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

713

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

714

# Default: 0

715

#

716

URLReferrerWithQuery=0

717

718

719

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

720

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

721

# Change : Effective immediatly

722

# Possible values: 0 or 1

723

# Default: 1

724

#

725

WarningMessages=1

726

727

728

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

729

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

730

# can set this parameter to your personalized generic message.

731

# Change : Effective immediatly

732

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

733

# Default: ""

734

#

735

ErrorMessages=""

736

737

738

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

739

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

740

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

741

# Change : Effective immediatly

742

# Possible values: 0 or 1

743

# Default: 0

744

#

745

DebugMessages=0

746

747

748

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

749

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

750

# match the LogFormat parameter.

751

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

752

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

753

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

754

# increase this parameter (very rare).

755

# Change : Effective for new updates only

756

# Default: 50

757

#

758

NbOfLinesForCorruptedLog=50

759

760

761

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

762

# point to another script than awstats.pl.

763

# Use the name of this script in WrapperScript parameter.

764

# Change : Effective immediatly

765

# Example: "awstatslauncher.pl"

766

# Example: "awstatswrapper.cgi?key=123"

767

# Default: ""

768

#

769

WrapperScript=""

770

771

772

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

773

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

774

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

775

# if your web server is Roxen.

776

# Change : Effective for new updates only

777

# Possible values: 0 or 1

778

# Default: 0

779

#

780

DecodeUA=0

781

782

783

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

784

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

785

# - Javascript disabled

786

# - Java enabled

787

# - Screen size

788

# - Color depth

789

# - Macromedia Director plugin

790

# - Macromedia Shockwave plugin

791

# - Realplayer G2 plugin

792

# - QuickTime plugin

793

# - Mediaplayer plugin

794

# - Acrobat PDF plugin

795

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

796

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

797

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

798

#

799

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

800

# <noscript><img src="/js/awstats_misc_tracker.js?nojs=y" height=0 width=0 border=0 style="display: none"></noscript>

801

#

802

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

803

# disabled. You must also check that ShowScreenSizeStats and ShowMiscStats

804

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

805

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

806

# awstatsmisctrackerurl variable into the awstats_misc_tracker.js file.

807

# Change : Effective for new updates only.

808

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

809

# Default: "/js/awstats_misc_tracker.js"

810

#

811

MiscTrackerUrl="/js/awstats_misc_tracker.js"

812

813

814

# AddLinkToExternalCGIWrapper can be used to add a link to a wrapper script

815

# into each title of Dolibarr reports. This can be used to add a wrapper

816

# to download data into a CSV file for example.

817

#

818

# AddLinkToExternalCGIWrapper="/awstats/awdownloadcsv.pl"

819

820

821

822

#-----------------------------------------------------------------------------

823

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

824

#-----------------------------------------------------------------------------

825

826

# The following values allow you to define accuracy of AWStats entities

827

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

828

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

829

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

830

# Possible values:

831

# 0 = No detection,

832

# 1 = Medium/Standard detection

833

# 2 = Full detection

834

# Change : Effective for new updates only

835

# Note : LevelForBrowsersDetection can also accept value "allphones". This

836

# enable detailed detection of phone/pda browsers.

837

# Default: 2 (0 for LevelForWormsDetection)

838

#

839

LevelForBrowsersDetection=2 # 0 disables Browsers detection.

840

# 2 reduces AWStats speed by 2%

841

# allphones reduces AWStats speed by 5%

842

LevelForOSDetection=2 # 0 disables OS detection.

843

# 2 reduces AWStats speed by 3%

844

LevelForRefererAnalyze=2 # 0 disables Origin detection.

845

# 2 reduces AWStats speed by 14%

846

LevelForRobotsDetection=2 # 0 disables Robots detection.

847

# 2 reduces AWStats speed by 2.5%

848

LevelForSearchEnginesDetection=2 # 0 disables Search engines detection.

849

# 2 reduces AWStats speed by 9%

850

LevelForKeywordsDetection=2 # 0 disables Keyphrases/Keywords detection.

851

# 2 reduces AWStats speed by 1%

852

LevelForFileTypesDetection=2 # 0 disables File types detection.

853

# 2 reduces AWStats speed by 1%

854

LevelForWormsDetection=0 # 0 disables Worms detection.

855

# 2 reduces AWStats speed by 15%

856

857

858

859

#-----------------------------------------------------------------------------

860

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

861

#-----------------------------------------------------------------------------

862

863

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

864

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

865

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

866

# Possible values: 0 or 1

867

# Default: 1

868

#

869

UseFramesWhenCGI=1

870

871

872

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

873

# window than the main page.

874

# Possible values:

875

# 0 - Open all in same browser window

876

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

877

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

878

# Default: 1

879

#

880

DetailedReportsOnNewWindows=1

881

882

883

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

884

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

885

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

886

# Example: 3600

887

# Default: 0

888

#

889

Expires=0

890

891

892

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

893

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

894

# Default: 1000

895

#

896

MaxRowsInHTMLOutput=1000

897

898

899

# Set your primary language (ISO-639-1 language codes).

900

# Possible values:

901

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

902

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

903

# Danish=dk, Dutch=nl, English=en, Estonian=et, Euskara=eu, Finnish=fi,

904

# French=fr, Galician=gl, German=de, Greek=gr, Hebrew=he, Hungarian=hu,

905

# Icelandic=is, Indonesian=id, Italian=it, Japanese=jp, Korean=ko,

906

# Latvian=lv, Norwegian (Nynorsk)=nn, Norwegian (Bokmal)=nb, Polish=pl,

907

# Portuguese=pt, Portuguese (Brazilian)=br, Romanian=ro, Russian=ru,

908

# Serbian=sr, Slovak=sk, Slovenian=si, Spanish=es, Swedish=se, Turkish=tr,

909

# Ukrainian=ua, Welsh=cy.

910

# First available language accepted by browser=auto

911

# Default: "auto"

912

#

913

Lang="auto"

914

915

916

# Set the location of language files.

917

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

918

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

919

#

920

DirLang="./lang"

921

922

923

# Show menu header with reports' links

924

# Possible values: 0 or 1

925

# Default: 1

926

#

927

ShowMenu=1

928

929

930

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

931

# want to see in those reports.

932

# Possible values:

933

# 0 - Report is not shown at all

934

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

935

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

936

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

937

# U = Unique visitors

938

# V = Visits

939

# P = Number of pages

940

# H = Number of hits (or mails)

941

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

942

# L = Last access date

943

# E = Entry pages

944

# X = Exit pages

945

# C = Web compression (mod_gzip,mod_deflate)

946

# M = Average mail size (mail logs)

947

#

948

949

# Show monthly summary

950

# Context: Web, Streaming, Mail, Ftp

951

# Default: UVPHB, Possible column codes: UVPHB

952

ShowSummary=UVPHB

953

954

# Show monthly chart

955

# Context: Web, Streaming, Mail, Ftp

956

# Default: UVPHB, Possible column codes: UVPHB

957

ShowMonthStats=UVPHB

958

959

# Show days of month chart

960

# Context: Web, Streaming, Mail, Ftp

961

# Default: VPHB, Possible column codes: VPHB

962

ShowDaysOfMonthStats=VPHB

963

964

# Show days of week chart

965

# Context: Web, Streaming, Mail, Ftp

966

# Default: PHB, Possible column codes: PHB

967

ShowDaysOfWeekStats=PHB

968

969

# Show hourly chart

970

# Context: Web, Streaming, Mail, Ftp

971

# Default: PHB, Possible column codes: PHB

972

ShowHoursStats=PHB

973

974

# Show domains/country chart

975

# Context: Web, Streaming, Mail, Ftp

976

# Default: PHB, Possible column codes: UVPHB

977

ShowDomainsStats=PHB

978

979

# Show hosts chart

980

# Context: Web, Streaming, Mail, Ftp

981

# Default: PHBL, Possible column codes: PHBL

982

ShowHostsStats=PHBL

983

984

# Show authenticated users chart

985

# Context: Web, Streaming, Ftp

986

# Default: 0, Possible column codes: PHBL

987

ShowAuthenticatedUsers=0

988

989

# Show robots chart

990

# Context: Web, Streaming

991

# Default: HBL, Possible column codes: HBL

992

ShowRobotsStats=HBL

993

994

# Show worms chart

995

# Context: Web, Streaming

996

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

997

ShowWormsStats=0

998

999

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

1000

# Context: Mail

1001

# Default: 0, Possible column codes: HBML

1002

ShowEMailSenders=0

1003

1004

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

1005

# Context: Mail

1006

# Default: 0, Possible column codes: HBML

1007

ShowEMailReceivers=0

1008

1009

# Show session chart

1010

# Context: Web, Streaming, Ftp

1011

# Default: 1, Possible column codes: None

1012

ShowSessionsStats=1

1013

1014

# Show pages-url chart.

1015

# Context: Web, Streaming, Ftp

1016

# Default: PBEX, Possible column codes: PBEX

1017

ShowPagesStats=PBEX

1018

1019

# Show file types chart.

1020

# Context: Web, Streaming, Ftp

1021

# Default: HB, Possible column codes: HBC

1022

ShowFileTypesStats=HB

1023

1024

# Show file size chart (Not yet available)

1025

# Context: Web, Streaming, Mail, Ftp

1026

# Default: 1, Possible column codes: None

1027

ShowFileSizesStats=0

1028

1029

# Show downloads chart.

1030

# Context: Web, Streaming, Ftp

1031

# Default: HB, Possible column codes: HB

1032

ShowDownloadsStats=HB

1033

1034

# Show operating systems chart

1035

# Context: Web, Streaming, Ftp

1036

# Default: 1, Possible column codes: None

1037

ShowOSStats=1

1038

1039

# Show browsers chart

1040

# Context: Web, Streaming

1041

# Default: 1, Possible column codes: None

1042

ShowBrowsersStats=1

1043

1044

# Show screen size chart

1045

# Context: Web, Streaming

1046

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

1047

ShowScreenSizeStats=0

1048

1049

# Show origin chart

1050

# Context: Web, Streaming

1051

# Default: PH, Possible column codes: PH

1052

ShowOriginStats=PH

1053

1054

# Show keyphrases chart

1055

# Context: Web, Streaming

1056

# Default: 1, Possible column codes: None

1057

ShowKeyphrasesStats=1

1058

1059

# Show keywords chart

1060

# Context: Web, Streaming

1061

# Default: 1, Possible column codes: None

1062

ShowKeywordsStats=1

1063

1064

# Show misc chart

1065

# Context: Web, Streaming

1066

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

1067

ShowMiscStats=a

1068

1069

# Show http errors chart

1070

# Context: Web, Streaming

1071

# Default: 1, Possible column codes: None

1072

ShowHTTPErrorsStats=1

1073

1074

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

1075

# Context: Mail

1076

# Default: 0, Possible column codes: None

1077

ShowSMTPErrorsStats=0

1078

1079

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

1080

# Context: Web, Streaming, Ftp

1081

# Default: 0, Possible column codes: PHB

1082

ShowClusterStats=0

1083

1084

1085

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

1086

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

1087

# can set thoose options to 0.

1088

# Possible values: 0 or 1

1089

# Default: 1

1090

#

1091

# Data array values for the ShowMonthStats report

1092

AddDataArrayMonthStats=1

1093

# Data array values for the ShowDaysOfMonthStats report

1094

AddDataArrayShowDaysOfMonthStats=1

1095

# Data array values for the ShowDaysOfWeekStats report

1096

AddDataArrayShowDaysOfWeekStats=1

1097

# Data array values for the ShowHoursStats report

1098

AddDataArrayShowHoursStats=1

1099

1100

1101

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

1102

# include hits on pages that come from pages of same sites in this chart.

1103

# Possible values: 0 or 1

1104

# Default: 0

1105

#

1106

IncludeInternalLinksInOriginSection=0

1107

1108

1109

# The following parameters can be used to choose the maximum number of lines

1110

# shown for the particular following reports.

1111

#

1112

# Stats by countries/domains

1113

MaxNbOfDomain = 10

1114

MinHitDomain = 1

1115

# Stats by hosts

1116

MaxNbOfHostsShown = 10

1117

MinHitHost = 1

1118

# Stats by authenticated users

1119

MaxNbOfLoginShown = 10

1120

MinHitLogin = 1

1121

# Stats by robots

1122

MaxNbOfRobotShown = 10

1123

MinHitRobot = 1

1124

# Stats for Downloads

1125

MaxNbOfDownloadsShown = 10

1126

MinHitDownloads = 1

1127

# Stats by pages

1128

MaxNbOfPageShown = 10

1129

MinHitFile = 1

1130

# Stats by OS

1131

MaxNbOfOsShown = 10

1132

MinHitOs = 1

1133

# Stats by browsers

1134

MaxNbOfBrowsersShown = 10

1135

MinHitBrowser = 1

1136

# Stats by screen size

1137

MaxNbOfScreenSizesShown = 5

1138

MinHitScreenSize = 1

1139

# Stats by window size (following 2 parameters are not yet used)

1140

MaxNbOfWindowSizesShown = 5

1141

MinHitWindowSize = 1

1142

# Stats by referers

1143

MaxNbOfRefererShown = 10

1144

MinHitRefer = 1

1145

# Stats for keyphrases

1146

MaxNbOfKeyphrasesShown = 10

1147

MinHitKeyphrase = 1

1148

# Stats for keywords

1149

MaxNbOfKeywordsShown = 10

1150

MinHitKeyword = 1

1151

# Stats for sender or receiver emails

1152

MaxNbOfEMailsShown = 20

1153

MinHitEMail = 1

1154

1155

1156

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

1157

# Possible values:

1158

# 0 - Week starts on sunday

1159

# 1 - Week starts on monday

1160

# Default: 1

1161

#

1162

FirstDayOfWeek=1

1163

1164

1165

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

1166

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

1167

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

1168

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

1169

# Possible values: "" or "language_codes_separated_by_space"

1170

# Example: "en es fr nl de"

1171

# Default: ""

1172

#

1173

ShowFlagLinks=""

1174

1175

1176

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

1177

# Possible values: 0 or 1

1178

# Default: 1

1179

#

1180

ShowLinksOnUrl=1

1181

1182

1183

# When AWStats builds HTML links in its report pages, it starts those links

1184

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

1185

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

1186

# just enter "/".

1187

# This parameter is not used if ShowLinksOnUrl is 0.

1188

# Example: "/shopping"

1189

# Example: "/"

1190

# Default: ""

1191

#

1192

UseHTTPSLinkForUrl=""

1193

1194

1195

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

1196

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

1197

# Default: 64

1198

#

1199

MaxLengthOfShownURL=64

1200

1201

1202

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

1203

# Default: ""

1204

#

1205

HTMLHeadSection=""

1206

1207

1208

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

1209

# Great to add advert ban.

1210

# Default: ""

1211

#

1212

HTMLEndSection=""

1213

1214

1215

# By default AWStats page contains meta tag robots=noindex,nofollow

1216

# If you want to have your statistics to be indexed, set this option to 1.

1217

# Default: 0

1218

#

1219

MetaRobot=0

1220

1221

1222

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

1223

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

1224

# LogoLink is the expected URL when clicking on Logo.

1225

# Default: "awstats_logo6.png"

1226

#

1227

Logo="awstats_logo6.png"

1228

LogoLink="http://www.awstats.org"

1229

1230

1231

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

1232

# Default: 260/90

1233

#

1234

BarWidth = 260

1235

BarHeight = 90

1236

1237

1238

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

1239

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

1240

# AWStats in wwwroot/css directory.

1241

# Example: "/awstatscss/awstats_bw.css"

1242

# Example: "/css/awstats_bw.css"

1243

# Default: ""

1244

#

1245

StyleSheet=""

1246

1247

1248

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

1249

# to change AWStats look.

1250

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

1251

#

1252

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

1253

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

1254

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

1255

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

1256

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

1257

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

1258

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

1259

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

1260

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

1261

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

1262

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

1263

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

1264

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

1265

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

1266

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

1267

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

1268

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

1269

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

1270

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

1271

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

1272

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

1273

1274

1275

1276

#-----------------------------------------------------------------------------

1277

# PLUGINS

1278

#-----------------------------------------------------------------------------

1279

1280

# Add here all plugin files you want to load.

1281

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

1282

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

1283

# modules required by the plugin are installed.

1284

1285

# PLUGIN: Tooltips

1286

# REQUIRED MODULES: None

1287

# PARAMETERS: None

1288

# DESCRIPTION: Add tooltips pop-up help boxes to HTML report pages.

1289

# NOTE: This will increased HTML report pages size, thus server load and bandwidth.

1290

#

1291

#LoadPlugin="tooltips"

1292

1293

# PLUGIN: DecodeUTFKeys

1294

# REQUIRED MODULES: Encode and URI::Escape

1295

# PARAMETERS: None

1296

# DESCRIPTION: Allow AWStats to show correctly (in language charset)

1297

# keywords/keyphrases strings even if they were UTF8 coded by the

1298

# referer search engine.

1299

#

1300

#LoadPlugin="decodeutfkeys"

1301

1302

# PLUGIN: IPv6

1303

# PARAMETERS: None

1304

# REQUIRED MODULES: Net::IP and Net::DNS

1305

# DESCRIPTION: This plugin gives AWStats capability to make reverse DNS

1306

# lookup on IPv6 addresses.

1307

#

1308

#LoadPlugin="ipv6"

1309

1310

# PLUGIN: HashFiles

1311

# REQUIRED MODULES: Storable

1312

# PARAMETERS: None

1313

# DESCRIPTION: AWStats DNS cache files are read/saved as native hash files.

1314

# This increases DNS cache files loading speed, above all for very large web sites.

1315

#

1316

#LoadPlugin="hashfiles"

1317

1318

1319

# PLUGIN: UserInfo

1320

# REQUIRED MODULES: None

1321

# PARAMETERS: None

1322

# DESCRIPTION: Add a text (Firtname, Lastname, Office Department, ...) in

1323

# authenticated user reports for each login value.

1324

# A text file called userinfo.myconfig.txt, with two fields (first is login,

1325

# second is text to show, separated by a tab char) must be created in DirData

1326

# directory.

1327

#

1328

#LoadPlugin="userinfo"

1329

1330

# PLUGIN: HostInfo

1331

# REQUIRED MODULES: Net::XWhois

1332

# PARAMETERS: None

1333

# DESCRIPTION: Add a column into host chart with a link to open a popup window that shows

1334

# info on host (like whois records).

1335

#

1336

#LoadPlugin="hostinfo"

1337

1338

# PLUGIN: ClusterInfo

1339

# REQUIRED MODULES: None

1340

# PARAMETERS: None

1341

# DESCRIPTION: Add a text (for example a full hostname) in cluster reports for each cluster

1342

# number. A text file called clusterinfo.myconfig.txt, with two fields (first is

1343

# cluster number, second is text to show) separated by a tab char. must be

1344

# created into DirData directory.

1345

# Note this plugin is useless if ShowClusterStats is set to 0 or if you don't

1346

# use a personalized log format that contains %cluster tag.

1347

#

1348

#LoadPlugin="clusterinfo"

1349

1350

# PLUGIN: UrlAliases

1351

# REQUIRED MODULES: None

1352

# PARAMETERS: None

1353

# DESCRIPTION: Add a text (Page title, description...) in URL reports before URL value.

1354

# A text file called urlalias.myconfig.txt, with two fields (first is URL,

1355

# second is text to show, separated by a tab char) must be created into

1356

# DirData directory.

1357

#

1358

#LoadPlugin="urlalias"

1359

1360

# PLUGIN: TimeHiRes

1361

# REQUIRED MODULES: Time::HiRes (if Perl < 5.8)

1362

# PARAMETERS: None

1363

# DESCRIPTION: Time reported by -showsteps option is in millisecond. For debug purpose.

1364

#

1365

#LoadPlugin="timehires"

1366

1367

# PLUGIN: TimeZone

1368

# REQUIRED MODULES: Time::Local

1369

# PARAMETERS: [timezone offset]

1370

# DESCRIPTION: Allow AWStats to adjust time stamps for a different timezone

1371

# This plugin reduces AWStats speed of 10% !!!!!!!

1372

# LoadPlugin="timezone"

1373

# LoadPlugin="timezone +2"

1374

# LoadPlugin="timezone CET"

1375

#

1376

#LoadPlugin="timezone +2"

1377

1378

# PLUGIN: Rawlog

1379

# REQUIRED MODULES: None

1380

# PARAMETERS: None

1381

# DESCRIPTION: This plugin adds a form in AWStats main page to allow users to see raw

1382

# content of current log files. A filter is also available.

1383

#

1384

#LoadPlugin="rawlog"

1385

1386

# PLUGIN: GraphApplet

1387

# REQUIRED MODULES: None

1388

# PARAMETERS: [CSS classes to override]

1389

# DESCRIPTION: Supported charts are built by a 3D graphic applet.

1390

#

1391

#LoadPlugin="graphapplet /awstatsclasses" # EXPERIMENTAL FEATURE

1392

1393

# PLUGIN: GraphGoogleChartAPI

1394

# REQUIRED MODULES: None

1395

# PARAMETERS: None

1396

# DESCRIPTION: Replaces the standard charts with free Google API generated images

1397

# in HTML reports. If country data is available and more than one country has hits,

1398

# a map will be generated using Google Visualizations.

1399

# Note: The machine where reports are displayed must have Internet access for the

1400

# charts to be generated. The only data sent to Google includes the statistic numbers,

1401

# legend names and country names.

1402

# Warning: This plugin is not compatible with option BuildReportFormat=xhtml.

1403

#

1404

#LoadPlugin="graphgooglechartapi"

1405

1406

# PLUGIN: GeoIPfree

1407

# REQUIRED MODULES: Geo::IPfree version 0.2+ (from Graciliano M.P.)

1408

# PARAMETERS: None

1409

# DESCRIPTION: Country chart is built from an Internet IP-Country database.

1410

# This plugin is useless for intranet only log files.

1411

# Note: You must choose between using this plugin (need Perl Geo::IPfree

1412

# module, database is free but not up to date) or the GeoIP plugin (need

1413

# Perl Geo::IP module from Maxmind, database is also free and up to date).

1414

# Note: Activestate provide a corrupted version of Geo::IPfree 0.2 Perl

1415

# module, so install it from elsewhere (from www.cpan.org for example).

1416

# This plugin reduces AWStats speed by up to 10% !

1417

#

1418

#LoadPlugin="geoipfree"

1419

1420

# MAXMIND GEO IP MODULES: Please see documentation for notes on all Maxmind modules

1421

1422

# PLUGIN: GeoIP

1423

# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind)

1424

# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/geoip.dat[+/pathto/override.txt]]

1425

# DESCRIPTION: Builds a country chart and adds an entry to the hosts

1426

# table with country name

1427

# Replace spaces in the path of geoip data file with string "%20".

1428

#

1429

#LoadPlugin="geoip GEOIP_STANDARD /pathto/GeoIP.dat"

1430

1431

# PLUGIN: GeoIP_City_Maxmind

1432

# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind)

1433

# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPCity.dat[+/pathto/override.txt]]

1434

# DESCRIPTION: This plugin adds a column under the hosts field and tracks the pageviews

1435

# and hits by city including regions.

1436

# Replace spaces in the path of geoip data file with string "%20".

1437

#

1438

#LoadPlugin="geoip_city_maxmind GEOIP_STANDARD /pathto/GeoIPCity.dat"

1439

1440

# PLUGIN: GeoIP_ASN_Maxmind

1441

# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind)

1442

# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPASN.dat[+/pathto/override.txt][+http://linktoASlookup]]

1443

# DESCRIPTION: This plugin adds a chart of AS numbers where the host IP address is registered.

1444

# This plugin can display some ISP information if included in the database. You can also provide

1445

# a link that will be used to lookup additional registration data. Put the link at the end of

1446

# the parameter string and the report page will include the link with the full AS number at the end.

1447

# Replace spaces in the path of geoip data file with string "%20".

1448

#

1449

#LoadPlugin="geoip_asn_maxmind GEOIP_STANDARD /usr/local/geoip.dat+http://enc.com.au/itools/aut-num.php?autnum="

1450

1451

# PLUGIN: GeoIP_Region_Maxmind

1452

# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind)

1453

# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPRegion.dat[+/pathto/override.txt]]

1454

# DESCRIPTION:This plugin adds a chart of hits by regions. Only regions for US and

1455

# Canada can be detected.

1456

# Replace spaces in the path of geoip data file with string "%20".

1457

#

1458

#LoadPlugin="geoip_region_maxmind GEOIP_STANDARD /pathto/GeoIPRegion.dat"

1459

1460

# PLUGIN: GeoIP_ISP_Maxmind

1461

# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind)

1462

# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPISP.dat[+/pathto/override.txt]]

1463

# DESCRIPTION: This plugin adds a chart of hits by ISP.

1464

# Replace spaces in the path of geoip data file with string "%20".

1465

#

1466

#LoadPlugin="geoip_isp_maxmind GEOIP_STANDARD /pathto/GeoIPISP.dat"

1467

1468

# PLUGIN: GeoIP_Org_Maxmind

1469

# REQUIRED MODULES: Geo::IP or Geo::IP::PurePerl (from Maxmind)

1470

# PARAMETERS: [GEOIP_STANDARD | GEOIP_MEMORY_CACHE] [/pathto/GeoIPOrg.dat[+/pathto/override.txt]]

1471

# DESCRIPTION: This plugin add a chart of hits by Organization name

1472

# Replace spaces in the path of geoip data file with string "%20".

1473

#

1474

#LoadPlugin="geoip_org_maxmind GEOIP_STANDARD /pathto/GeoIPOrg.dat"

1475

1476

1477

#-----------------------------------------------------------------------------

1478

# EXTRA SECTIONS

1479

#-----------------------------------------------------------------------------

1480

1481

# You can define your own charts, you choose here what are rows and columns

1482

# keys. This feature is particularly useful for marketing purpose, tracking

1483

# products orders for example.

1484

# For this, edit all parameters of Extra section. Each set of parameter is a

1485

# different chart. For several charts, duplicate section changing the number.

1486

# Note: Each Extra section reduces AWStats speed by 8%.

1487

#

1488

# WARNING: A wrong setup of Extra section might result in too large arrays

1489

# that will consume all your memory, making AWStats unusable after several

1490

# updates, so be sure to setup it correctly.

1491

# In most cases, you don't need this feature.

1492

#

1493

# ExtraSectionNameX is title of your personalized chart.

1494

# ExtraSectionCodeFilterX is list of codes the record code field must match.

1495

# Put an empty string for no test on code.

1496

# ExtraSectionConditionX are conditions you can use to count or not the hit,

1497

# Use one of the field condition

1498

# (URL,URLWITHQUERY,QUERY_STRING,REFERER,UA,HOSTINLOG,HOST,VHOST,extraX)

1499

# and a regex to match, after a coma. Use "||" for "OR".

1500

# ExtraSectionFirstColumnTitleX is the first column title of the chart.

1501

# ExtraSectionFirstColumnValuesX is a string to tell AWStats which field to

1502

# extract value from

1503

# (URL,URLWITHQUERY,QUERY_STRING,REFERER,UA,HOSTINLOG,HOST,VHOST,extraX)

1504

# and how to extract the value (using regex syntax). Each different value

1505

# found will appear in first column of report on a different row. Be sure

1506

# that list of different possible values will not grow indefinitely.

1507

# ExtraSectionFirstColumnFormatX is the string used to write value.

1508

# ExtraSectionStatTypesX are things you want to count. You can use standard

1509

# code letters (P for pages,H for hits,B for bandwidth,L for last access).

1510

# ExtraSectionAddAverageRowX add a row at bottom of chart with average values.

1511

# ExtraSectionAddSumRowX add a row at bottom of chart with sum values.

1512

# MaxNbOfExtraX is maximum number of rows shown in chart.

1513

# MinHitExtraX is minimum number of hits required to be shown in chart.

1514

#

1515

1516

# Example to report the 20 products the most ordered by "order.cgi" script

1517

#ExtraSectionName1="Product orders"

1518

#ExtraSectionCodeFilter1="200 304"

1519

#ExtraSectionCondition1="URL,\/cgi\-bin\/order\.cgi||URL,\/cgi\-bin\/order2\.cgi"

1520

#ExtraSectionFirstColumnTitle1="Product ID"

1521

#ExtraSectionFirstColumnValues1="QUERY_STRING,productid=([^&]+)"

1522

#ExtraSectionFirstColumnFormat1="%s"

1523

#ExtraSectionStatTypes1=PL

1524

#ExtraSectionAddAverageRow1=0

1525

#ExtraSectionAddSumRow1=1

1526

#MaxNbOfExtra1=20

1527

#MinHitExtra1=1

1528

1529

1530

# There is also a global parameter ExtraTrackedRowsLimit that limits the

1531

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

1532

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

1533

# ExtraSection. It applies to all ExtraSection independently meaning that

1534

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

1535

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

1536

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

1537

# Example: 2000

1538

# Default: 500

1539

#

1540

ExtraTrackedRowsLimit=500

1541

1542

1543

#-----------------------------------------------------------------------------

1544

# INCLUDES

1545

#-----------------------------------------------------------------------------

1546

1547

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

1548

# config file.

1549

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

1550

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

1551

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

1552

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

1553

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

1554

# parameters that are lists of values.

1555

#

1556

1557

#Include ""

1558