Document facilities offered to debian.org subdomains
authorRaphaël Hertzog <hertzog@debian.org>
Thu, 2 Aug 2012 21:17:46 +0000 (23:17 +0200)
committerMartin Zobel-Helas <zobel@debian.org>
Mon, 10 Sep 2012 19:01:41 +0000 (21:01 +0200)
Signed-off-by: Martin Zobel-Helas <zobel@debian.org>
input/doc/subdomains.mdwn [new file with mode: 0644]
input/index.mdwn

diff --git a/input/doc/subdomains.mdwn b/input/doc/subdomains.mdwn
new file mode 100644 (file)
index 0000000..ced73f7
--- /dev/null
@@ -0,0 +1,62 @@
+Facilities offered to teams with dedicated debian.org subdomains
+================================================================
+
+Various teams have dedicated subdomains below debian.org (e.g
+release.debian.org, qa.debian.org, etc.). Associated to it,
+there's usually a website and e-mail addresses. The corresponding
+files are always in `/srv/foo.debian.org/` on the host allocated
+to the service by the DSA team.
+
+Website 
+-------
+
+The Apache virtual host configuration usually resides in
+`/srv/foo.debian.org/apache.conf`. After having changed the configuration,
+you should be able to reload apache with
+`sudo /usr/sbin/apache2-vhost-update` (provided that you have correctly
+configured a sudo password for the corresponding host).
+
+Virtual Domain Mail Settings
+----------------------------
+
+The configuration of the mail service usually resides in
+`/srv/foo.debian.org/mail/`.
+
+The following files enable you to create various email addresses:
+
+* __aliases__: just like `/etc/aliases`, you can create e-mail addresses that
+  forward the messages to one or more recipients.
+* __.forward-*__: qmail like forward files where `.forward-bar` defines how
+  emails sent to bar@foo.debian.org are handled. It can be used to redirect
+  mails to programs (eg. `|/srv/foo.debian.org/bin/processmail.pl`) or
+  to mailboxes (eg. `/srv/foo.debian.org/mail/archive/bar`). Just put
+  each destination on its own line.
+* __.forward-default__: like above, except it handles all the e-mail addresses
+  that are not covered by an alias or another .forward-* file.
+
+There are also various files that can be used to control the
+antispam measures of each email address:
+
+* **callout_users**: a simple list of local parts (before the @) that should
+  have callout sender verification applied.
+* **grey_users**: a simple list of local parts that should have
+  greylisting applied.
+* **neversenders**: a simple list of local parts (of the virtual domain) that
+  should never appear as senders of mails.
+* **whitelist**: a colon separated list starting with "localpart:" of hosts
+  and IP patterns to whitelist from any antispam measures configured in this
+  directory.
+* **rbllist**: a colon separated list starting with "localpart:" of RBL
+  lists to perform lookups in. Example for owner@foo.debian.org:
+
+        owner: zen.spamhaus.org : safe.dnsbl.sorbs.net
+
+* **rhsbllist**: a colon separated list starting with "localpart:" of RHSBL
+  lists to perform lookups in. This should be in the form of
+  "RHSBL.example/$sender_address_domain". Example for owner@foo.debian.org:
+
+        owner: bogusmx.rfc-ignorant.org/$sender_address_domain : nomail.rhsbl.sorbs.net/$sender_address_domain
+
+You can find examples of the last two files on any debian.org system
+in /var/lib/misc/*hostname* as mail-rbl and mail-rhsbl.
+
index 81f6907..feb2022 100644 (file)
@@ -29,6 +29,7 @@ VCS repositories for ud-ldap and all our other stuff can be found at
 * [[doc/install-req]]: guidelines to request package installation in chroots
 * [dchroot documentation](http://www.debian.org/doc/developers-reference/resources.html#dchroot): How dchroot can be used on porter machines
 * [[doc/guest-account]]: guest account access to porter machines
+* [[doc/subdomains]]: facilities offered to teams with a dedicated subdomain
 
 ## Internal documentation