welcome: please sign in

Diff for "DomTool/Plugins"

Differences between revisions 8 and 10 (spanning 2 versions)
Revision 8 as of 2008-04-30 14:55:17
Size: 5330
Editor: AdamChlipala
Comment: deleuze -> hcoop
Revision 10 as of 2011-04-21 07:27:50
Size: 63
Editor: cultureclub
Comment: AFAIC that's the best aneswr so far!
Deletions are marked like this. Additions are marked like this.
Line 1: Line 1:
This page is aimed at admins; that is, people with root privileges on our servers. Most members should probably consult DomTool/UserGuide instead.

This page documents the different DomTool '''plugins''', which provide the primitive actions that can be used to configure particular "real" daemons.


= Apache =

'''Modules:''' [http://hcoop.net/domtool/apache.html Apache], [http://hcoop.net/domtool/apache_auth.html Apache_auth], [http://hcoop.net/domtool/apache_options.html Apache_options], [http://hcoop.net/domtool/mod_autoindex.html Mod_autoindex], [http://hcoop.net/domtool/mod_dav.html Mod_dav], [http://hcoop.net/domtool/mod_env.html Mod_env], [http://hcoop.net/domtool/mod_rewrite.html Mod_rewrite], [http://hcoop.net/domtool/proxy.html Proxy], [http://hcoop.net/domtool/urls.html Urls]

Each `vhost "$HOST"` directive creates a `$HOST.vhost` file in `$DOMTOOL/nodes`. A change handler for `.vhost` files copies them to `/var/domtool/vhosts`. A post-handler runs `domtool-publish apache`, which rsyncs `/var/domtool/vhosts` to `/etc/apache2/vhosts` after any vhost has changed and runs `/etc/init.d/apache2 reload` to reload configuration.

The Apache plugin also manages creation and deletion of log directories. Each member should have an `apache/log` subdirectory of his AFS volume root, owned by domtool with read permissions for the member. The plugin creates a directory `/afs/hcoop/usr/$USER/apache/log/$NODE/$HOST` for each virtual host running on `$NODE` as `$USER` with full hostname `$HOST`. When a vhost is deleted, the plugin deletes its log directory. Since this can't be done while Apache is running, because the daemon maintains open file handles to logs, the plugin has to take Apache down until configuration is finished, reloading it afterward. Hopefully domains aren't deleted very often, so this shouldn't be much of a problem.

Apache also provides hooks that other plugins can use to request callbacks just before and/or after a vhost is configured.

= BIND =

'''Modules:''' [http://hcoop.net/domtool/bind.html Bind]

BIND configuration directives are written to `dns` files in the `$DOMTOOL/nodes` directories of the appropriate nodes/domains. These `dns` files contain all of the contents of a BIND zonefile, with the exception of the SOA record. This is handled by main DomTool code and written in a stylized form to `soa` files. The BIND plugin registers a change handler looking for modifications to either `dns` or `soa` files. When any are found, `/var/domtool/zones/$DOMAIN.zone` is regenerated from them.

The BIND plugin also produces a `named.conf` file for each domain. A change handler notes when some `named.conf` has changed, and a post-handler concatenates all `named.conf` files in `$DOMTOOL/nodes/$NODE` into `/var/domtool/named.conf.local` and runs `domtool-publish bind`, which rsyncs `/var/domtool/zones` to `/etc/bind/zones`, copies `/var/domtool/named.conf.local` to `/etc/bind/`, and runs `/etc/init.d/bind9 reload`.

= Exim =

'''Modules:''' [http://hcoop.net/domtool/alias.html Alias], [http://hcoop.net/domtool/exim.html Exim]

The Exim plugin maintains three kinds of files in domain configuration directories:
 * `aliases`, e-mail aliases to be concatenated into `/etc/aliases.hosted`
 * `mail` files that, if non-empty, should contain the current domain's name, indicating that the current node should accept mail for that domain for local delivery
 * `mail.relay` files that, if non-empty, should contain the current domain's name, indicating that the current node should provide relaying for any mail addressed to that domain

A post-handler performs the concatenation over all domains into `/var/domtool/aliases`, `/var/domtool/local_domains.cfg`, and `/var/domtool/relay_domains.cfg`, respectively; and then runs `domtool-publish exim`, which copies the first file to `/etc/aliases.hosted` and concatenates the rest to `/etc/exim4/conf.d/main/10_domtool-domains`, and then runs `/etc/init.d/exim4 reload`.

= HCoop =

'''Modules:''' [http://hcoop.net/domtool/hcoop.html Hcoop]

This plug-in currently only provides useful HCoop-specific `extern` functions.

= Mailman =

'''Modules:''' [http://hcoop.net/domtool/mailman.html Mailman]

The `mailmanWebHost` action writes a domain file `mailman`, recording the default Mailman vhost for that domain. A post-handler concatenates all of these into `/var/domtool/mailman.map` in a format suitable for a Python association list in Mailman configuration, and runs `domtool-publish mailman`, which uses that file to create `/etc/mailman/vhosts_cfg.py`, which defines an association list named `HCOOP_VHOSTS`. A file `/var/domtool/mailman_domains.cfg` is also created to list which domains should be considered for Mailman list delivery, and this list is added to `/etc/exim4/conf.d/main/10_domtool-domains` upon publishing.

= Webalizer =

'''Modules:''' none

This plugin works entirely through the before/after vhost hooks provided by the Apache plugin. For each vhost `$VHOST` on node `$NODE`, it writes to `$DOMTOOL/webalizer/config/$NODE/$VHOST.conf` Webalizer configuration that will generate statistics for that vhost. The output HTML and images are directed to `$DOMTOOL/webalizer/output/$NODE/$VHOST/`, which the plugin ensures exists.
AFAIC that's the best aneswr so far!

AFAIC that's the best aneswr so far!


DomTool/Plugins (last edited 2011-04-22 23:05:37 by ClintonEbadi)