|
Size: 885
Comment: Comments
|
Size: 3102
Comment: converted to 1.6 markup
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 3: | Line 3: |
| This is the chapter of the MemberManual that describes the bare minimum that you need to know concerning our use of DomTool. | 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. |
| Line 5: | Line 5: |
| '''Why does this page exist? Why not point directly to DomTool/UserGuide? --AdamChlipala''' | <<TableOfContents>> |
| Line 7: | Line 7: |
| [[TableOfContents]] | = Configuration files = |
| Line 9: | Line 9: |
| * Write to ~/.domtool. Explain how to make public or private. '''(Add to DomTool/UserGuide instead. --AdamChlipala)''' * Explain how to add a domain. In particular, an example, with content then annotated below. Point to relevant DomTool subpage for more. '''(Doesn't DomTool/UserGuide do this already? There is no concept of "adding a domain" at the rank-and-file-member level. You just write a Domtool source file that mentions a domain that you've been granted permission to use. --AdamChlipala)''' * Explain how to remove a domain. '''(Add to DomTool/UserGuide instead. --AdamChlipala)''' |
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. == 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 }}} = HCoop-specific instructions = * We serve all member web pages off of `mire.hcoop.net`, which has the IP address 69.90.123.68. Use the variable '''mire_ip''' in place of this IP address. * Our mail server is `deleuze.hcoop.net` (otherwise known as `mail.hcoop.net`), which has the IP address 69.90.123.67. Use the variable '''deleuze_ip''' in place of this IP address. * Our nameservers are `ns1.hcoop.net` and `ns2.hcoop.net`. These are automatically included when you use the '''dom''' directive. = 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/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.
Contents
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.
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
HCoop-specific instructions
We serve all member web pages off of mire.hcoop.net, which has the IP address 69.90.123.68. Use the variable mire_ip in place of this IP address.
Our mail server is deleuze.hcoop.net (otherwise known as mail.hcoop.net), which has the IP address 69.90.123.67. Use the variable deleuze_ip in place of this IP address.
Our nameservers are ns1.hcoop.net and ns2.hcoop.net. These are automatically included when you use the dom directive.
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.