forked from sni/thruk
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathTHRUK_MANUAL.txt
3435 lines (2182 loc) · 86.7 KB
/
THRUK_MANUAL.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
Thruk Users Guide
=================
== Introduction
Thruk is a multibackend monitoring webinterface which currently
supports Naemon, Nagios, Icinga and Shinken as backend using the Livestatus
API. It is designed to be a 'dropin' replacement and covers almost
100% of the original features plus adds additional enhancements for
large installations and increased usability.
Main Features / Advantages
* Multiple backends
* Faster, no need to parse status.dat for every request
* Less CPU usage
* Display live data, no delay between core and GUI
* Independant from monitoring core, can be installed on remote host
* Clusterable, can be clustered over hosts
* Change status.cgi filter inline
* Extended logfile search
* Better logging, uses log4perl (who submitted which command?)
* Valid HTML code
* No frames (can be reenabled for better addon integration)
* Easy to extend with plugins
* 100% Perl (using Catalyst Framework)
* Pagination
* Multiple themes included
* Excel export for status and logfiles
* Adjustable side menu
* Full expanded plugin commandline for easy testing
* Save searches in personal bookmarks
* Config Tool included
* Mobile interface included
* SLA Reports in PDF format
* Recurring Downtimes
* Fully Featured Dashboard
* Business Process Addon
=== How it works
Thruk is written in Perl using the
http://www.catalystframework.org[Catalyst Framework]. Backend
monitoring systems will be connected with the
http://search.cpan.org/dist/Monitoring-Livestatus[Monitoring::Livestatus]
Perl Module. Thruk itself is running as a fastcgi process.
Availability will be calculated with
http://search.cpan.org/dist/Monitoring-Availability[Monitoring::Availability].
Authentication is provided by the Apache webserver (For example with
mod_auth_basic, mod_auth_ldap, mod_auth_mysql, ...).
.Thruk Architecture
image:source/arch_preview.png[Thruk Architecture]
=== Reasons to choose Thruk
There are a couple of cool things in Thruk. A few of them are listed
here.
==== Multi Site Support
Thruk connects to as many cores as you want. You could even combine
Naemon, Nagios, Icinga and Shinken instances into one big combined view. That
way you get the advantage of several independent locations and still
have an overview about all your installations. Sites can be put into
groups for better arrangement.
image:source/multi_site.png[Multi Site]
==== SLA Reports
The 'reporting' plugin creates comprehensive SLA reports in HTML and PDF format
which may be send by mail at regular intervals. Besides that you may turn any
page in Thruk into a regular E-Mail report.
image:source/sla_reporting.png[SLA Reporting]
==== Business Process Integration
Using the Business Process addon allows modeling your important applications and
business processes. Online editor and notifications included.
image:source/bp.png[Business Process]
==== Excel Export and Bookmarks
The Bookmarks feature allows you to save your searches and add them as
your personal menu item. Besides the bookmarks, you can adjust the
menu easily with the menu_local.conf for all users.
The Excel export creates real Excel files which can be send by mail or
used to extract hostnames and other information.
image:source/Bookmarks_and_excel_export.png[Bookmarks and Excel Export]
==== Config Tool
The Config Tool makes is very easy to change object configuration of
your monitoring solution. It also allows you to make quick changes to your
Thruk configuration, as well as managing user access via htpasswd
files or adjusting your cgi.cfg.
image:source/Config_Tool.png[Config Tool]
==== Sending Multiple Commands
The new status pages makes it very convenient to send multiple commands
at once. It is even possible to send host and service commands at the
same time. When rescheduling hosts and services, Thruk will wait until
your check is finished and display the result as soon as the check has
come back.
image:source/Reschedule.png[Multiple Commands]
==== Easy Filtering
Remember the days when you had to guess numbers in the url to filter
hosts or services. With Thruk it's possible to quickly change your
display filter. You can combine multiple filter to create whatever
views you like. An Ajax search supports you, so you don't have to
guess host or service names, plus you get the power of regular expressions.
image:source/Filter.png[Easy Filtering]
==== PNP4Nagios Graphs
When your action_url contains /pnp4nagios/, there will be automatically
a graph displayed for your host and service. This gives you a quick
view about the performance history. The image is then linked to
PNP4Nagios to get detailed information.
image:source/PNP4nagios.png[PNP4Nagios]
==== Multiple Lines of Plugin Output
When your check returns multiple lines of plugin output. Thruk marks
the output in blue and a click on it displays the complete output.
This is especially useful for check_multi checks. In addition to
that, the comments and downtimes also have a small popup with their
data. So you don't have to open the host/service page just to see who
set a comment and when there is a downtime.
image:source/PluginOutput.png[Multiple Lines of Plugin Output]
==== Mine Map
The Mine Map is the perfect tool to get a quick overview. It is
especially useful if you have a lot of common services across your
hosts. Otherwise use hostgroups or servicegroups for nice results.
Normal filtering is possible too.
image:source/MineMap.png[Mine Map]
==== Mobile Interface
The Mobile interface gives you access to the most important things
and allows you to quickly view and acknowledge problems.
image:source/Mobile.png[Mobile Interface]
== Installation
There are several ways of installing Thruk.
=== Labs Consol Repository
The https://labs.consol.de/repo/[Labs Repository] provides packages of
latest Thruk releases (including daily development builds) and other
Tools like Mod-Gearman. Just follow the guide on the labs page for
your distribution.
=== OMD
An easy way of installing Thruk is using OMD from
http://omdistro.org[omdistro.org]. There are Debian, Ubuntu, Centos
and Suse Packages containing preconfigured latest versions of Nagios
and Thruk. The package also includes Icinga, Shinken, pnp4nagios,
check_mk and Nagvis. OMD is the recommended way of installing new
Nagios / Thruk setups when you want to install several addons at once.
=== Use Packages
Standalone installation from a binary package is another easy way
to get Thruk running.
Download packages from http://www.thruk.org/files/pkg/
All packages have the following filesystem structure:
-------
/etc/thruk Thruks config
/etc/httpd/conf.d/thruk.conf Apache config
/usr/share/thruk shared files
/usr/lib/thruk/perl5 Perl libraries
/var/cache/thruk temporary files
/var/lib/thruk stored user settings
-------
After installation, Thruk is available at http://your-host/thruk/ and
has a default user 'thrukadmin' with password 'thrukadmin' configured.
You may need to change backend configuration. This should be done in
the thruk_local.conf where all settings can be overridden.
==== Debian / Ubuntu
-------
#> dpkg -i thruk_1.82_debian6_amd64.deb
-------
In case of dependency errors, run 'apt-get -f install' and try the
'dpkg -i...' again.
==== Centos / Redhat
-------
#> yum install --nogpgcheck thruk-1.82-1.rhel6.x86_64.rpm
-------
You may need to include an external repository for mod_fastcgi module.
Epel or Rpmforge should do it.
==== SLES
-------
#> zypper install thruk-1.82-1.sles11.x86_64.rpm
-------
You may need the SLES sdk dvd for additional dependencies.
=== Install from Source
==== Installation Steps
===== Requirements
[IMPORTANT]
.Experienced Users Only
=======
Source installation is for experienced users only. Using
packages/repositories should be the preferred solution in almost all
situations. Especially for production environments.
=======
In order to install the Thruk Monitoring Webinterface from source you
will need the following:
- Perl
- Git Client
- compiler tools: automake, make, g++, gcc
- Apache Webserver (optional for fastcgi only)
===== Create New User
refer to your systems manual on how to add new user.
This guide uses the following:
-------
user: thruk
group: thruk
-------
IMPORTANT: all following steps should be done by the thruk user.
===== Install Local::Lib
Follow the steps on http://search.cpan.org/perldoc?local::lib#The_bootstrapping_technique
quick guide:
-------
%> su - thruk
%> wget %http://search.cpan.org/CPAN/authors/id/A/AP/APEIRON/local-lib-1.008004.tar.gz
%> tar zxf local-lib-1.008004.tar.gz
%> cd local-lib-1.008004
%> perl Makefile.PL --bootstrap && make install
-------
[TIP]
.proxy configuration
=======
if you need a proxy configuration, you should answer <no> at this question:
Would you like me to configure as much as possible automatically? [yes]
Setting a proper http_proxy/ftp_proxy environment should work for the automatic
configuration.
=======
Add the following line to the thruk users .profile or .bashrc
eval $(perl -I$HOME/perl5/lib/perl5 -Mlocal::lib)
logout and login again and verify that your perl env looks like this:
-------
%> env | grep perl
PERL5LIB=/home/thruk/perl5/lib/perl5:/home/thruk/perl5/lib/perl5/x86_64-linux-gnu-thread-multi
MODULEBUILDRC=/home/thruk/perl5/.modulebuildrc
PATH=/home/thruk/perl5/bin:/usr/local/bin:/usr/bin:/bin:/usr/games
PERL_MM_OPT=INSTALL_BASE=/home/thruk/perl5
-------
===== Install Module::Install
-------
perl -MCPAN -e 'install Module::Install::Catalyst'
-------
===== Git Clone Thruk
-------
git clone https://github.com/sni/Thruk.git
cd Thruk
perl Makefile.PL
-------
press <enter> here:
-------
==> Auto-install the 35 mandatory module(s) from CPAN? [y]
-------
then run make
-------
make
-------
This may take a while, as there are probably several modules missing.
[TIP]
.yes
=======
you can use /usr/bin/yes to automatically answer all questions with
yes. (yes | make)
=======
Press <y> at this questions:
-------
Do you want to build the XS Stash module? [y]
Do you want to use the XS Stash by default? [y]
-------
run perl Makefile.PL again to see if all dependencies are now installed properly.
-------
perl Makefile.PL
-------
===== Configuration
Copy 'thruk.conf' to 'thruk_local.conf' and adjust the livestatus settings to your needs.
-------
%> cp thruk.conf thruk_local.conf
-------
The thruk.conf will be overwritten with new defaults on updates. The
thruk_local.conf contains the local overrides and will never be
overwritten.
Edit 'cgi.conf' and adjust settings to your needs.
See the <<Thruk Configuration>> section for detailed explanation of configuration options.
===== Start Server
After running these steps successfully, you should be able to test your
installation:
-------
./script/thruk_server.pl
-------
Open your browser and open http://<your_host>:3000
== Apache Configuration
[TIP]
.apache is preconfigured when using packages
=======
Apache configuration is not needed if you use OMD or packages. Apache
is already preconfigured in that case.
=======
Integration in the Apache webserver is done by fastcgi. There are two
fastcgi modules for Apache at the moment. Choose the one which fits
best into your environment. If unsure, use <<_mod_fcgid,mod_fcgid>>.
The main difference is, that mod_fcgid starts the fastcgi process upon
the first request whereas in mod_fastcgi you have to start the fastcgi
process by yourself.
Do not use the port 3000 thruk server in production, it's only for
testing and development. It cannot handle authentication and is slower
than the fastcgi variants.
[TIP]
.lighthttpd
=======
Francois Ponsard wrote an article on how to integrate Thruk in Lighthttpd:
http://www.dahwa.fr/dotclear/index.php?post/2011/03/15/Thruk-in-Lighttpd
=======
=== mod_fcgid
IMPORTANT: Thruk runs with the webserver user in this scenario, make
sure the webserver user has access to all Thruk files and perl modules.
.Apache configuration with mod_fcgid
-------
LoadModule fcgid_module /usr/lib/apache2/modules/mod_fcgid.so
<VirtualHost *:80>
ServerName thruk.company.local
DocumentRoot /home/thruk/Thruk/root/
CustomLog /home/thruk/Thruk/logs/access.log combined
ErrorLog /home/thruk/Thruk/logs/error.log
<Directory /home/thruk/Thruk/root/>
Options FollowSymLinks
AllowOverride All
order allow,deny
allow from all
</Directory>
AliasMatch /thruk/(.*\.cgi|.*\.html) /home/thruk/Thruk/script/thruk_fastcgi.pl/thruk/$1
<Location /thruk>
Options ExecCGI
Order allow,deny
Allow from all
AuthName "Monitoring Access"
AuthType Basic
AuthUserFile /home/thruk/Thruk/htpasswd.users
Require valid-user
</Location>
<IfModule mod_fcgid.c>
AddHandler fcgid-script .pl
MaxRequestsPerProcess 100
</IfModule>
</VirtualHost>
-------
[TIP]
.Example
Another more complicated example can be found on github:
https://github.com/sni/Thruk/blob/master/support/apache_fcgid.conf[apache_fcgid.conf].
This file is used for the official Thruk packages.
=== mod_fastcgi
start your fcgi server:
-------
%>./script/thruk_fastcgi.pl -n 5 \
-l /tmp/thruk_fastcgi.socket \
-p /tmp/thruk_fastcgi.pid
-------
you may want to copy the init.d script to /etc/init.d and adjust its paths:
-------
%> sudo cp ./script/thruk_fastcgi_server.sh /etc/init.d/thruk_fastcgi_server
%> vi /etc/init.d/thruk_fastcgi_server
%> sudo chown root: /etc/init.d/thruk_fastcgi_server
-------
Or create a custom init.d script (additional modules required) with:
-------
%> ./script/thruk_create.pl FastCGI::ExternalServer l=/tmp/thruk_fastcgi.socket n=5 p=/tmp/thruk_fastcgi.pid
-------
use this apache example configuration:
- replace /home/thruk/Thruk with your installation path
- replace your-web-host.local with your hostname
- create a /home/thruk/Thruk/htpasswd.users with htpasswd2
- make sure the /home/thruk/Thruk/logs/ directory exists
.Apache configuration within existing vhost
-------
<VirtualHost *:80>
# ... existing configuration
# thruk configuration
<Directory /home/thruk/Thruk/root/>
order allow,deny
allow from all
Options FollowSymLinks
AllowOverride All
</Directory>
<Directory /home/thruk/Thruk/plugins/>
order allow,deny
allow from all
Options FollowSymLinks
AllowOverride All
</Directory>
Alias /thruk/ /home/thruk/Thruk/root/thruk/
# authorization
<Location "/thruk">
AuthName "Monitoring Access"
AuthType Basic
AuthUserFile /home/thruk/Thruk/htpasswd.users
Order Allow,Deny
Allow from all
require valid-user
</Location>
# Load fastcgi module unless already loaded
LoadModule fastcgi_module /usr/lib/apache2/modules/mod_fastcgi.so
# fastcgi configuration
FastCGIExternalServer /tmp/thruk_fastcgi.fcgi -socket /tmp/thruk_fastcgi.socket -idle-timeout 120
# Load rewrite module unless already loaded
LoadModule rewrite_module /usr/lib/apache2/modules/mod_rewrite.so
# rewrite configuration
RewriteEngine On
RewriteCond %{DOCUMENT_ROOT}%{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/thruk(.*)$ /tmp/thruk_fastcgi.fcgi/thruk$1 [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},QSA,L]
</VirtualHost>
-------
.Apache configuration with own vhost
-------
<VirtualHost *:80>
ServerName thruk.your-host.local
DocumentRoot /home/thruk/Thruk/root/
CustomLog /home/thruk/Thruk/logs/access.log combined
ErrorLog /home/thruk/Thruk/logs/error.log
<Directory />
order deny,allow
deny from all
</Directory>
<Directory /home/thruk/Thruk/root/>
Options FollowSymLinks
AllowOverride All
order allow,deny
allow from all
</Directory>
<Directory /home/thruk/Thruk/plugins/>
order allow,deny
allow from all
Options FollowSymLinks
AllowOverride All
</Directory>
# authorization
<Location "/">
AuthName "Monitoring Access"
AuthType Basic
AuthUserFile /home/thruk/Thruk/htpasswd.users
Order Allow,Deny
Allow from all
require valid-user
</Location>
# Load fastcgi module unless already loaded
LoadModule fastcgi_module /usr/lib/apache2/modules/mod_fastcgi.so
# fastcgi configuration
FastCGIExternalServer /tmp/thruk_fastcgi.fcgi -socket /tmp/thruk_fastcgi.socket -idle-timeout 120
# Load rewrite module unless already loaded
LoadModule rewrite_module /usr/lib/apache2/modules/mod_rewrite.so
# rewrite configuration
RewriteEngine On
RewriteCond %{DOCUMENT_ROOT}%{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-f
RewriteRule ^/(.*)$ /tmp/thruk_fastcgi.fcgi/$1 [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},QSA,L]
</VirtualHost>
-------
== Backend Configuration
You may connect multiple backends into one Thruk interface. Just specify
multiple 'peer' items.
=== Livestatus
Livestatus is a addon for Naemon, Nagios or Icinga which provides real time
status data. Contrary to database addons it adds very little overhead to the
Naemon core which makes livestatus based gui fast and real time.
[TIP]
.Shinken
=======
Shinken has livestatus support built-in and does not require additional
modules.
=======
Refer to http://mathias-kettner.de/checkmk_livestatus.html#H1:%20Setting%20up%20and%20using%20Livestatus
on how to install livestatus onto your monitoring box. The
<<_labs_consol_repository,Lab Consol Repository>> has livestatus rpm
packages. For debian based Linux systems just use the provided
packages of your distribution.
Basically you have to build the NEB module and add it to your naemon.cfg,
nagios.cfg or icinga.cfg.
-------
broker_module=/opt/local/livestatus/livestatus.o /tmp/live.sock
-------
Then use the socket as 'peer' parameter in your backend configuration.
.Thruk Backends
image:source/backends.png[Thruk Backends Manager]
.Livestatus Architecture
image:source/livestatus.png[Livestatus Architecture]
=== HTTP
A HTTP connection is possible between multiple Thruk installations. A
HTTP connection not only makes live data available, it also offers a
secure way to manage object configuration from remote. To authenticate
the central Thruk installation, you need to provide the secret key from the
slave instance. This setup is perfect for managing several independent
installations from a central point of view.
[TIP]
.use SSL
=======
It's strongly recommended to use HTTPS for remote connections.
=======
-------
# package installation
%> cat /var/lib/thruk/secret.key
# omd site
OMD[site]:~$ cat var/thruk/secret.key
-------
.HTTP Architecture
image:source/livestatus_http.png[HTTP Architecture]
=== MongoDB
The MongoDB is not a real backend for status data, but it can be used as a
logfile cache. If unsure whether to use MongoDB or MySQL, use MySQL which is
newer and faster. The MongoDB logfile cache may be deprecated in the future.
ex.:
logcache = mongodb://localhost:27017/thruk_logs
Details are explained in the <<_logfile_cache,Logfile Cache>> section.
=== MySQL
The MySQL Database is not a real backend for status data, but it can be used as a
logfile cache. If unsure whether to use MongoDB or MySQL, use MySQL which is
newer and faster. The MongoDB logfile cache may be deprecated in the future.
ex.:
logcache = mysql://username:password@localhost:3306/thruk_logs
Details are explained in the <<_logfile_cache,Logfile Cache>> section.
== Thruk Configuration
Configuration is managed mainly in these configuration files.
-------
* thruk.conf # shipped default Thruk config
* thruk_local.conf # local override of Thruks settings
* cgi.cfg # Naemon/Nagios cgi.cfg
* log4perl.conf # Logging configuration
* menu.conf # Thruks default side navigation
* menu_local.conf # local override for the navigation
-------
%subtoc%
=== Config Files
==== thruk.conf
The thruk.conf contains the shipped defaults. You should not edit this
file directly. Overwrite your settings in your thruk_local.conf
instead.
==== thruk_local.conf
The thruk_local.conf is a copy of the thruk.conf. Both files are used by thruk.
The idea is, that the thruk.conf is provided with the packaged defaults and the
thruk_local.conf is to override these settings where needed.
=== General Settings
==== title_prefix
set the title prefix for all urls
this piece of text will be prepended to
all page titles.
ex.:
title_prefix = Prod
==== use_bookmark_titles
Sets the page title to the name of a bookmark
if the url matches. Private bookmarks are processed
first and the name of the first match is used.
ex.:
use_bookmark_titles = 1
==== use_dynamic_titles
Uses more descriptive page titles.
Bookmark titles take precedence and
can be overriden by adding the title
parameter on most pages
ex.:
use_dynamic_titles = 1
==== url_prefix
Changes the usual url path for Thruk. Don't change it unless you plan
to run multiple Thruk instances on the same webserver. You will have
to change your fastcgi configuration too.
ex.:
url_prefix = /
==== use_timezone
Changes the timezone from the systems default to this timezone.
Only set this if you have trouble with displaying the right timestamps.
ex.:
use_timezone = CET
==== mobile_agent
Specify user agents which will be redirected to the mobile plugin (if
enabled).
ex.:
mobile_agent=iPhone,Android,IEMobile
==== default_theme
Default theme to use for all users. Must be a valid sub directory in
the themes folder.
ex.:
default_theme = Thruk
==== first_day_of_week
Set first day of week. Used in reports.
Sunday: 0
Monday: 1
ex.:
first_day_of_week = 0
==== report_use_temp_files
Large reports will use temp files to avoid extreme memory usage.
With 'report_use_temp_files' you may set the report duration in days
which will trigger the use of temp files. Default is 14days, so
for example the 'last31days' report will use temp files, the 'thisweek'
not. Can be disabled by setting to 0.
ex.:
report_use_temp_files = 14
==== report_max_objects
Don't create reports with more hosts / services than this number.
The purpose is to don't wrack the server due to extended memory
usage. Increase this number if you hit that limit and have plenty
of memory left.
ex.:
report_max_objects = 1000
==== start_page
This link is used as startpage and points usually to the main.html
with displays version information and general links.
ex.:
start_page = /thruk/main.html
==== home_link
This link is used whenever you click on one of the main logos. By default
those logos are the Thruk logos and the link will take you to the Thruk homepage.
Replace this with where you want your home location to be.
ex.:
home_link = http://www.thruk.org
==== documentation_link
This link is used in the side navigation menu as link to the documentation.
Replace with your documentation location. Set it to a blank value
if you don't want a documentation link in the menu at all.
ex.:
documentation_link = /thruk/docs/
==== all_problems_link
Customizable link for the 'problems' link in side menu. Can be useful
to reflect your companies process of error handling.
ex.:
all_problems_link = /thruk/cgi-bin/status.cgi?...
==== allowed_frame_links
List of allowed patterns, where links inside frames can be set to.
You can link to /thruk/frame.html?link=http://wiki.my-company.com/page/blah
Your wiki will then be displayed with the Thruk navigation frame.
Useful for other addons, so they don't have to display a own
navigation.
ex.:
allowed_frame_links = http://intranet.my-company.com
allowed_frame_links = https://wiki.my-company.com
=== Authorization Settings
==== can_submit_commands
Set this if a contact should be allowed to send commands unless defined for the
contact itself. This is the default value for all contacts unless the user has
a can_submit_commands setting in your monitoring configuration.
ex.:
can_submit_commands = 1
==== command_disabled
Use this to disabled specific commands. Can be use multiple times to disabled
multiple commands. The number can be found in the 'cmd_typ' cgi parameter from
links to the command page.
You may use ranges here.
ex.:
command_disabled = 14
command_disabled = 35
command_disabled = 17-34,50-65
==== make_auth_user_lowercase
Convert authenticated username to lowercase.
ex.:
make_auth_user_lowercase = 1
==== make_auth_user_uppercase
Convert authenticated username to uppercase.
ex.:
make_auth_user_uppercase = 1
==== make_auth_replace_regex
Convert authenticated username by regular expression. The following
example removes everything after an @ from the authenticated username
and 'user@domain' becomes just 'user'.
ex.:
make_auth_replace_regex = s/^(.*?)@.*/$1/gmx
==== use_strict_host_authorization
When set to a true value, every contact will only see the hosts where
he is contact for plus the services where he is contact for. When
disabled, a host contact will see all services for this host
regardless of whether he is a service contact or not.
ex.:
use_strict_host_authorization = 1
=== Path Settings
==== cgi_cfg
The path to your cgi.cfg. See <<_cgi_cfg_2,cgi.cfg>> for details.
ex.:
cgi_cfg = cgi.cfg
==== log4perl_conf