release/src/router/nocat/man/nocat.conf.5

   1 .\" nocat.conf - NoCatSplash gateway daemon configuration file
   2 .\" This manual page is copyright 2005 Keegan Quinn.
   3
   4 .\" This program is free software; you can redistribute it and/or modify
   5 .\" it under the terms of the GNU General Public License as published by
   6 .\" the Free Software Foundation; either version 2, or (at your option)
   7 .\" any later version.
   8 .\"
   9 .\" This program is distributed in the hope that it will be useful,
  10 .\" but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 .\" MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 .\" GNU General Public License for more details.
  13 .\"
  14 .\" You should have received a copy of the GNU General Public License
  15 .\" along with this program; if not, write to the Free Software
  16 .\" Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  17
  18 .TH nocat.conf 5 "January 2005"
  19 .SH NAME
  20 nocat.conf \- NoCatSplash gateway daemon configuration file
  21
  22 .SH DESCRIPTION
  23 .B nocat.conf
  24 is the configuration file for the NoCatSplash gateway daemon.  It should
  25 contain one configuration keyword per line, followed by appropriate
  26 configuration information.  Lines starting with # are comments, and are
  27 ignored.
  28
  29 .SH OPTIONS
  30
  31 .TP
  32 .BI GatewayName\  STRING
  33 The name of the gateway.
  34
  35 .TP
  36 .BI LoginTimeout\  INTEGER
  37 Number of seconds after a client's last login/renewal to terminate their
  38 connection. Probably don't want to set this to less than 60 or a lot of
  39 bandwidth is likely to get consumed by the client's renewal attempts.
  40
  41 For Open Mode portals, you probably want to set LoginTimeout to
  42 something large (like 86400, for one notification
  43 per day).
  44
  45 .TP
  46 .BI LogFacility\  STRING
  47 If set to "syslog", splashd will log to syslog(3), using the daemon syslog
  48 facillity. Otherwise, splashd will log to standard error. LogFacility defaults
  49 to "syslog".
  50
  51 .TP
  52 .BI SyslogIdent\  STRING
  53 The string which splashd uses in order to identify itself to syslog(3).
  54 Defaults to "NoCat".
  55
  56 .TP
  57 .BI DocumentRoot\  PATH
  58 Where all of the application templates (including SplashForm) are hiding.
  59
  60 .TP
  61 .BI SplashForm\  FILE
  62 The file in DocumentRoot used as the template for the splash page.
  63
  64 .TP
  65 .BI SplashURL\  URL
  66 Optional URL to fetch dynamic remote splash page from. You must compile
  67 with --with-remote-splash for this to work.
  68
  69 .TP
  70 .BI SplashTimeout\  URL
  71 Specifies the reload period of the remote splash page, if one is used.
  72
  73 .TP
  74 .BI StatusForm\  FILE
  75 The file in DocumentRoot used as the template for the status page.
  76
  77 .TP
  78 .BI ExternalDevice\  INTERFACE
  79 The upstream network interface. Required if and only if NoCatSplash can't
  80 figure it out from looking at your routing tables and picking the interface
  81 that carries the default route. Must be set to the interface connected to the
  82 Internet. Usually eth0 or eth1 under Linux, or maybe even ppp0 if you're
  83 running PPP or PPPoE.
  84
  85 .TP
  86 .BI InternalDevice\  INTERFACE
  87 The local (typically wireless) interface.  Required if and only if your machine
  88 has more than two network interfaces; otherwise, NoCatSplash will assume that
  89 the network interface that doesn't have the default route is the
  90 InternalDevice. Must be set to the interface connected to your local network,
  91 normally your wireless card, e.g. eth1, wlan0, etc.
  92
  93 .TP
  94 .BI LocalNetwork\  NETWORK/NETMASK
  95 The network address and netmask of your internal (usually wireless) network.
  96 Required if and only if NoCatSplash can't figure it out by polling the
  97 InternalDevice. Must be set to the network address and net mask of your
  98 internal network. You can use the number of bits in the netmask (e.g. /16, /24,
  99 etc.) or the full x.x.x.x specification.
 100
 101 .TP
 102 .BI DNSAddr\  IP-ADDRESS
 103 Optional. *If* you choose not to run DNS on your internal network, DNSAddr
 104 should specify the address(es) of one or more domain name server on the
 105 Internet that wireless clients can use to get out. Should be the same DNS that
 106 your DHCP server hands out.
 107
 108 .TP
 109 .BI AllowedWebHosts\  HOSTNAME\ [HOSTNAME ...]
 110 Optional.  List any hosts that you would like to allow clients to have web
 111 access to (TCP port 80 and 443) BEFORE logging in. This is the pre-login
 112 stage, so be careful about what you allow.
 113
 114 .TP
 115 .BI IncludePorts\  PORT\ [PORT ...]
 116 Optional.  Specify TCP ports to allow access to when public class users login.
 117 All others will be denied. Don't forget to specify ports 80 and 443 if you
 118 decide to use IncludePorts or your users will be grumpy. We recommend using
 119 ExcludePorts instead.
 120
 121 .TP
 122 .BI ExcludePorts\  PORT\ [PORT ...]
 123 Optional.  Specify TCP ports to denied access to when public class users login.
 124 All others will be allowed.
 125
 126 Note that you should use either IncludePorts or ExcludePorts, but not both.  If
 127 neither is specified, access is granted to all ports to public class users.
 128
 129 You should *always* exclude port 25 (SMTP), unless you want to run an portal
 130 for wanton spam sending. Users should have their own way of sending mail. It
 131 sucks, but that's the way it is. Your nocat.conf excludes port 25 by default.
 132
 133 .TP
 134 .BI ResetCmd/PermitCmd/DenyCmd\  FILE
 135 Shell commands to reset, open and close the firewall. You probably don't need
 136 to change these.
 137
 138 .TP
 139 .BI GatewayPort\  PORT
 140 The TCP port to bind the gateway service to. 5280 is de-facto standard for
 141 NoCatSplash.  Change this only if you absolutely need to.
 142
 143 .SH SEE ALSO
 144
 145 The default nocat.conf comes with extensive comments.
 146
 147 .BR splashd(8)
 148
 149 .BR http://nocat.net/
 150
 151 .SH COPYRIGHT
 152
 153 NoCatSplash is copyright (c) 2004 - 2005 Schuyler Erle <schuyler@nocat.net> and
 154 Rob Flickenger <rob@nocat.net>, and is distributed under the GNU Public License
 155 v2 or better.
 156
 157 This manual page is copyright 2005 Keegan Quinn.
 158