welcome: please sign in

The following 188 words could not be found in the dictionary of 7 words (including 7 LocalSpellingWords) and are highlighted below:
about   activate   Activating   actually   admins   all   also   and   any   anyone   anywhere   are   argument   as   automatically   bare   be   brief   but   By   by   called   can   Category   changes   chapter   check   command   compared   concerning   Configuration   configuration   configure   contains   Contents   Coop   copy   create   currently   default   describes   determine   different   directory   do   Dom   domain   domtool   Domtool   done   Each   errors   essential   example   examples   Examples   file   files   following   follows   for   fs   full   Further   give   go   good   Guide   has   have   here   highly   how   if   If   in   In   information   instructions   intention   is   it   It   just   know   known   learn   like   live   long   Make   make   makes   Manual   many   may   means   meant   Member   minimum   minutes   mkdir   more   must   mv   need   needed   none   Of   of   Once   only   or   order   our   out   overview   page   path   patience   place   placed   private   process   public   published   quick   read   readable   reason   recommended   regenerate   rm   rmdir   run   Running   same   see   set   setacl   single   so   some   sometimes   specific   specified   store   subdomain   sure   symlink   Table   take   tc   temporarily   test   Testing   testing   tests   that   The   the   them   then   these   This   this   thorough   time   to   To   Tool   type   unless   up   use   User   user   very   want   was   which   while   will   without   working   writable   you   your  

Clear message
Edit

MemberManual / UsingDomtool

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

  1. Configuration files
  2. Running domtool
    1. Testing your configuration
    2. Activating your configuration
  3. Further instructions

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.

CategoryMemberManual

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