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