Browse Source

More verbose config documentation

tags/1.0
Timo Röhling 11 years ago
parent
commit
c6bc37881d
1 changed files with 17 additions and 4 deletions
  1. 17
    4
      postsrsd.default

+ 17
- 4
postsrsd.default View File

@@ -1,15 +1,28 @@
1 1
 # Default settings for postsrsd
2 2
 
3
-# Local domain name. Addresses are rewritten to originate from this domain
3
+# Local domain name. 
4
+# Addresses are rewritten to originate from this domain. The default value 
5
+# is taken from `postconf -h mydomain` and probably okay.
6
+#
4 7
 #SRS_DOMAIN=example.com
5 8
 
6
-# The secret key to sign the addresses is stored in this file
9
+# Secret key to sign rewritten addresses.
10
+# When postsrsd is installed for the first time, a random secret is generated
11
+# and stored in /etc/postsrsd.secret. For most installations, that's just fine.
12
+#
7 13
 #SRS_SECRET=/etc/postsrsd.secret
8 14
 
9
-# These ports are used to bind the TCP list for postfix
15
+# Local ports for TCP list.
16
+# These ports are used to bind the TCP list for postfix. If you change
17
+# these, you have to modify the postfix settings accordingly. The ports
18
+# are bound to the loopback interface, and should never be exposed on
19
+# the internet.
20
+#
10 21
 #SRS_FORWARD_PORT=10001
11 22
 #SRS_REVERSE_PORT=10002
12 23
 
13
-# Drop root privileges and run as this user after initialization.
24
+# Drop root privileges and run as another user after initialization. 
25
+# This is highly recommended as postsrsd handles untrusted input.
26
+#
14 27
 RUN_AS=nobody
15 28
 

Loading…
Cancel
Save