-
Notifications
You must be signed in to change notification settings - Fork 19
/
Copy pathINSTALL.txt
executable file
·153 lines (107 loc) · 5.63 KB
/
INSTALL.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
This document describes how to install and setup the Nagios V-Shell or “Visual”
Shell for Nagios Core and Nagios XI installations.
Target Audience
---------------
This document is intended for use by Nagios XI and Nagios Core Administrators,
and assumes that Nagios Core is installed on the target system.
Overview
--------
The Nagios V-Shell is a web interface written in PHP that is designed to render
as valid XHTML and be fully styled and formatted using CSS classes, while
maintaining the power of Nagios Core for issuing system and node commands.
Installation
------------
Prerequisites:
-------------
V-Shell requires apache and php 5.x already installed in the system, as well as
php-cli if it's not already there.
APC Caching
--------------
V-Shell takes advantage of the Alternative PHP Cache system (APC), which is
of particular importance if you are managing a large installation. For
information about APC and installation instructions see
http://php.net/manual/en/book.apc.php
RHEL/CentOS/Fedora: yum install php-pecl-apc php-pecl-apc-devel
Ubuntu/Debian : sudo apt-get install php-apc
You may need to increase your PHP 'memory_limit' setting in your system's php.ini file
if you're using APC. For large systems try a setting as high as 256-512MB.
To Install V-Shell:
-------------------
Download and untar the latest V-Shell tarball from:
http://assets.nagios.com/downloads/exchange/nagiosvshell/vshell.tar.gz
To download the latest code from Subversion
https://nagios.svn.sourceforge.net/svnroot/nagios/nagiosvshell/trunk
Run the following with root permissions:
cd /tmp
wget http://assets.nagios.com/downloads/exchange/nagiosvshell/vshell.tar.gz
tar zxf vshell.tar.gz
cd vshell
Next, verify the values in config.php are correct. Sensible defaults are
included for RHEL/CentOS 6 and Debian 7, and should require no action.
Once the configuration values are verified finish install vshell:
chmod +x install.php
./install.php #located in the root vshell directory where the web files are stored
After running this script, be sure to verify the location of the files
specified in the `/etc/vshell.conf` file, as well as the location of the
htpasswd.users file that is specified by your apache configuration.
These will be required in order for V-Shell to run correctly.
For problems or support, use the V-Shell forum at the following address:
http://support.nagios.com/forum/viewforum.php?f=19
Configuration
--------------
*Important Notes*:
For custom configurations with Apache, changes may need to be made to the
/etc/vshell.conf file, which contains variables for the V-shell URL,
as well as the Nagios Core cgi's.
V-Shell assumes that your Nagios Core installation can be accessed via
http://<servername>/nagios (or nagios3 on Debian). If your configuration
differs from this, make changes are appropriate to the /etc/vshell.conf file.
If errors occur after installation, verify that the constants point to the
correct web URLS.
You may need to update the location of htpasswd.users file in the apache
configuration file. For Ubuntu/Debian users on a nagios3 install this file will
be at /etc/nagios3/htpasswd.users.
Default Apache Configuration Locations:
RHEL/CentOS: /etc/httpd/conf.d/vshell.conf
Ubuntu/Debian: /etc/apache2/conf.d/vshell.conf
Future versions will include a separate config file and possibly a wizard to
verify system configuration.
APC Caching
---------------
Nagios V-Shell is configured to automatically detect and use APC caching
if it installed. APC caching caches object configuration data each time there is
a change to the objects.cache file, and it caches status data based on the TTL
config option in the vshell.conf file. If TTL=90, V-Shell will cache data from
the status.dat file for 90 seconds before re-parsing the file. This cache can be refreshed
at any time by selecting the "Refresh Data" link at the top right of the page.
Getting Started
---------------
Nagios V-Shell gets authorization information from the existing Nagios / Apache
access control mechanisms (usually a htpasswd.users file), as well as the
cgi.cfg file for Nagios Core. Most permissions for Nagios Core should be
reflected in the Nagios V-Shell as well. To get started, log into your Nagios
webserver at http://<yourserver>/vshell, and enter your Nagios Core
authentication information. Nagios V-Shell requires a valid user defined in
the /path/to/nagios/etc/cgi.cfg file in order to display information for hosts and services.
NOTE: V-Shell needs a username from either an apache authentication method or the name
need to be hard-coded into the index.php file. See the code comments for the hard-coded option.
V-Shell maintains most of the same features of Nagios Core, while utilizing
a top menu bar for site navigation. This is done to maximize space for table
viewing for hosts and services.
Nagios Core system commands, reports, and the Core interface can all be
accessed by direct links from V-Shell.
Internationalization
---------------------
V-Shell as of version 1.7 has implemented gettext support for internationalization.
New language files can be created and stored according the following convention:
For English:
vshell/locale/en_EN/LC_MESSAGES/en_EN.mo
vshell/locale/en_EN/LC_MESSAGES/en_EN.po
The default language set can then be specified in the /etc/vshell.conf file:
LANG = "en_EN"
Getting Help
------------------
For problems, feedback, or support, use the V-Shell forum at the following address:
http://support.nagios.com/forum/viewforum.php?f=19
Developer Notes:
We're looking for people who want to contribute to the V-Shell project, see the TODO file for more information.