welcome: please sign in

Diff for "MemberManual/UsingDomtool"

Differences between revisions 11 and 19 (spanning 8 versions)
Revision 11 as of 2007-11-14 14:53:48
Size: 3129
Editor: MichaelOlson
Comment:
Revision 19 as of 2013-01-14 07:07:12
Size: 2660
Editor: ClintonEbadi
Comment: cat / remove seemingly superfluous info about ip addresses
Deletions are marked like this. Additions are marked like this.
Line 5: Line 5:
[[TableOfContents]] <<TableOfContents>>
Line 19: Line 19:
fs setacl ~/.domtool domtool.deleuze read
Line 28: Line 27:
It can take a long time to run, like many minutes, so have patience.
Line 49: Line 49:
= HCoop-specific instructions =

 * We serve all member webpages off of mire.hcoop.net, which has the IP address 69.90.123.68.
 * Our mail server is deleuze.hcoop.net, which has the IP address 69.90.123.67.
 * Our nameservers are ns1.hcoop.net and ns3.hcoop.net.

'''Members shouldn't need to know these things. Our standard library should contain variables with service-themed names, not machine-name-themed names, that map to appropriate IP addresses. --AdamChlipala'''
Line 59: Line 52:
The intention of this page was to give you a very quick overview of the {{{domtool}}} command. To learn about how to create working configuration files, as well as brag to your friends about Domtool's excellent design, it is essential that you read the [:DomTool/UserGuide:Domtool User Guide]. The intention of this page was to give you a very quick overview of the {{{domtool}}} command. To learn about how to create working configuration files, it is essential that you read the [[DomTool/UserGuide|Domtool User Guide]], and also [[DomTool/Examples|see some examples]].

This is the chapter of the MemberManual that describes the bare minimum that you need to know concerning our use of DomTool. This is meant to be a very brief HCoop-specific overview, compared to the DomTool/UserGuide page, which is more thorough.

Configuration files

Domtool has user-specified configuration files that determine how to set up a domain or subdomain. Each file contains all of the information needed to configure a single domain.

If you want Domtool to process these files automatically, then place them in the ~/.domtool directory. If you are just testing out a domain temporarily, the configuration files may be placed anywhere.

By default, this ~/.domtool directory is actually a symlink to the ~/.public/.domtool directory. This makes your configuration files readable by anyone, but writable only by you. If you want to make them private, then do the following.

rm ~/.domtool
mkdir ~/.domtool
fs setacl ~/.domtool domtool read
# Do the following two commands if you have any files in ~/.public/.domtool
mv ~/.public/.domtool/* ~/.domtool
rmdir ~/.public/.domtool

Running domtool

In order to activate or test a domain, you must run the domtool command. It can take a long time to run, like many minutes, so have patience.

Testing your configuration

Running the following command tests your configuration file (here called "MYDOMAIN") for errors. Make sure to give the full path to the configuration file, unless you are currently in the same directory as the configuration file.

domtool -tc ~/.domtool/MYDOMAIN

The "-tc" argument means "type-check".

It is highly recommended to store your domtool configuration in a different directory while you are testing it (for example, ~/.domtool-test). The reason for this is that admins sometimes need to regenerate all domtool configuration files, and if any of your files in ~/.domtool have errors, none of them will be published. Once you are done testing, copy the known-good configuration files to ~/.domtool.

Activating your configuration

In order to make your changes go live, you need to run domtool without the "-tc" argument, as follows.

domtool ~/.domtool/MYDOMAIN

Further instructions

The intention of this page was to give you a very quick overview of the domtool command. To learn about how to create working configuration files, it is essential that you read the Domtool User Guide, and also see some examples.

MemberManual/UsingDomtool (last edited 2013-01-14 07:07:24 by ClintonEbadi)