1lg.conf(5) File Formats Manual lg.conf(5)
2
3
4
6 lg.conf - looking glass configuration file
7
9 lg.conf contains configuration for the looking glass scripts.
10
11 The syntax is that of perl(1). It is used to set variables that affect
12 run-time behavior and/or to locate resources.
13
15 The following variables are used (alphabetically):
16
17 LG_AS_REG
18 *** not implemented.
19
20 LG_BGP_RT
21 Allows show ip bgp neighbor commands that can produce heavy
22 output, such as sh ip bgp neighbor <ip> advertised-routes for a
23 transit customer when the neighbor address is followed by
24 'advertised-routes' for the sh ip bgp neighbor query.
25
26 LG_CACHE_DIR
27 Sets the location of the cache directory. The looking glass
28 uses this to hold lock files, log files, and output from cached
29 commands.
30
31 Default: ./tmp
32
33 Note that the default is relative to the directory where lg.cgi
34 runs in the server's document root (e.g.:
35 /usr/local/www/data/lg/tmp).
36
37 LG_CACHE_TIME
38 Sets the number of seconds that the looking glass should cache
39 output from commands that tend to produce a lot of output, such
40 as 'show ip bgp dampened-paths'.
41
42 Default: 600
43
44 LG_CLOGINRC
45 Defines the location of the cloginrc(5) that the looking glass
46 should use. The path may be relative to the directory where the
47 CGI scripts run in the server's document root.
48
49 Default: $HOME/.cloginrc
50
51 Note that the .cloginrc must be readable by the user or group
52 that will be running the CGI and that clogin(1) will not allow a
53 world readable .cloginrc. The user is normally that of the http
54 server (httpd).
55
56 LG_IMAGE
57 Defines a html image tag (<img>) which, if defined, will be
58 included at the top of the looking glass pages. It may contain
59 any html as it is simply handed off to print().
60
61 Example: $LG_IMAGE="<img src=/icons/rancid.gif hspace=0>\n <font
62 size=+2>FOO</font>";
63
64 LG_INFO
65 Defines information in html format which, if defined, will be
66 included at the bottom of the looking glass form page. It may
67 contain any html as it is simply handed off to print().
68
69 Example: $LG_INFO="For Support contact <a
70 href=mailto:webmaster@localhost>webmaster</a>";
71
72 LG_LOG Defines the fully qualified path name (i.e.: begins with '/')
73 for the log file or the syslog(3) facility to use for logging.
74 For syslog, the argument is the lowercase name of a syslog
75 facility (see syslog.h) without the 'LOG_' prefix.
76
77 Example: local0
78
79 Default: $LG_CACHE_DIR/lg.log
80
81 LG_ROUTERDB
82 Sets the location for the router.db file in rancid's
83 router.db(5) format. It lists the devices that should be
84 available to the looking glass users. Only those devices of
85 supported types and with state 'up' are made available. If not
86 defined and the default file does not exist, the looking glass
87 will compile a list from the router.db files of all the groups
88 present in rancid, that is, the list will be a concatenation of
89 the available router.db(5) files.
90
91 Note that if the concatenation method is used, it may be
92 necessary to alter the mode of the router.db files in the rancid
93 group directories, since rancid's default umask is 027 (see
94 rancid.conf(5)).
95
96 LG_STRIP
97 Causes the LG to strip login information from the looking glass
98 results. Since Expect often munges disabling echo when
99 passwords are entered, this is a SECURITY CONCERN! However,
100 this output can be very useful for debugging clogin problems.
101
102 LG_STYLE
103 Defines the URL of a style sheet to be used for HTML formatting.
104
105 PATH Is a colon separated list of directory pathnames in the file
106 system where rancid's login scripts, clogin(1) etc.) and
107 programs needed within these, such as telnet(1), are located.
108 Its value is set by configure. Should it be necessary to modify
109 PATH, note that it must include $BASEDIR/bin (see above).
110
111 Queries ...................................
112
114 LG_CONF
115 Location of lg.conf file. See the FILES section for more
116 information.
117
119 lg.conf is interpreted directly by perl(1), so its syntax follows that
120 of perl. Syntax errors may produce quite unexpected results.
121
123 /etc/rancid/lg.conf
124 Configuration file described here.
125
126 lg.conf is located by the value of the environment variable
127 LG_CONF, in the CWD (current working directory), or the
128 sysconfdir defined when rancid was installed, in that order.
129
131 cloginrc(5), lg_intro(7), router.db(5)
132
134 In RANCID releases prior to 2.3, lg.conf was located in the util/lg
135 sub-directory of the install path. This was changed to be more
136 consistent with common file location practices.
137
138
139
140 7 Jan 2004 lg.conf(5)