welcome: please sign in

Diff for "MemberManual/UsingDomtool"

Differences between revisions 1 and 4 (spanning 3 versions)
Revision 1 as of 2007-10-25 00:07:09
Size: 424
Editor: MichaelOlson
Comment: Initial contents
Revision 4 as of 2007-10-28 01:46:21
Size: 2129
Editor: MichaelOlson
Comment: Write page
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 7: Line 7:
 * Write to ~/.domtool. Explain how to make public or private.
 * Explain how to add a domain. In particular, an example, with content then annotated below. Point to relevant DomTool subpage for more.
 * Explain how to remove a domain.
= 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 if you have any files in ~/.public/.domtool
mv ~/.public/.domtool/* ~/.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".

== 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 instruction =

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].

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.

TableOfContents

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 if you have any files in ~/.public/.domtool
mv ~/.public/.domtool/* ~/.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".

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 instruction

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].

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