]> gitweb.michael.orlitzky.com - dead/htsn.git/blob - doc/htsnrc.example
Quote example user/group names.
[dead/htsn.git] / doc / htsnrc.example
1 # Example configuration file for htsn. For this to take effect, you
2 # would need to place it in either /etc/htsnrc or $HOME/.htsnrc. On
3 # Windows, it probably needs to go in %APPDATA%, or
4 # C:\Users\<username>\Application Data.
5
6
7 # Run in the background as a daemon?
8 #
9 # Default: false
10 #
11 # daemonize = True
12
13
14 # A list of hostnames that supply the feed. You probably don't need to
15 # change this, but you can.
16 #
17 # Default: ["feed1.sportsnetwork.com",
18 # "feed2.sportsnetwork.com",
19 # "feed3.sportsnetwork.com"]
20 #
21 # feed-hosts = [ "hostname1", "hostname2", ... ]
22
23
24 # If you specify a file path here, logs will be written to it
25 # (possibly in addition to syslog). Can be either a relative or
26 # absolute path. It will not be auto-rotated; use something like
27 # logrotate for that.
28 #
29 # Default: none
30 #
31 # log_file = /var/log/htsn/htsn.log
32
33
34 # How verbose should the logs be? Valid levels are,
35 #
36 # "INFO", "WARNING", "ERROR"
37 #
38 # (there are others, but we don't emit them.)
39 #
40 # Default: "INFO"
41 #
42 # log_level = "WARNING"
43
44
45 # By default, XML files will be written to the current working
46 # directory. Often this is not desirable, and you would rather save
47 # them to a specific location. Specify it here.
48 #
49 # Default: "."
50 #
51 # output-directory = "/var/lib/htsn"
52
53
54 # The password associated with your TSN username.
55 #
56 # Default: none (required)
57 #
58 # password = "whatever"
59
60
61 # (Daemon mode only) Create a PID file in the given location. This is
62 # used by the init system on Unix to keep track of the running daemon.
63 #
64 # Default: /run/htsn.pid
65 #
66 # pidfile = /var/run/htsn.pid
67
68
69 # (Daemon mode only) Run htsn as the specified system grup. The PID
70 # file is written before privileges are dropped, so the only
71 # privileges needed by htsn are those necessary to write the XML files
72 # and (optionally) the log file.
73 #
74 # Default: the current group
75 #
76 # run-as-group = "htsn"
77
78
79 # (Daemon mode only) Run htsn as the specified system user. The PID
80 # file is written before privileges are dropped, so the only
81 # privileges needed by htsn are those necessary to write the XML files
82 # and (optionally) the log file.
83 #
84 # Default: the current user
85 #
86 # run-as-user = "htsn"
87
88 # Do you want to log to syslog? On Windows this will attempt to
89 # communicate (over UDP) with a syslog daemon on localhost, which will
90 # most likely not work.
91 #
92 # Default: False
93 #
94 # syslog = True
95
96
97 # The username used to connect to the feed.
98 #
99 # Default: none (required)
100 #
101 # username = "whoever"