note where instructions on non-hcoop setups are
|Deletions are marked like this.||Additions are marked like this.|
|Line 41:||Line 41:|
|Heck, you could even go ahead and set some non-standard configuration values! If you leave it as is, you inherit the defaults, which should be appropriate for HCoop servers. If you are not installation DomTool at HCoop, see DomTool/NonHCoopSetup for details on configuring DomTool to run outside of HCoop.||Heck, you could even go ahead and set some non-standard configuration values! If you leave it as is, you inherit the defaults, which should be appropriate for HCoop servers. If you are not installation DomTool at HCoop, see [[DomTool/NonHCoopSetup]] for details on configuring DomTool to run outside of HCoop.|
DomTool minimally requires an SML compiler, libpcre for regex handling, libssl for communications, and rsync to publish configuration.
For Debian, the following packages are required for a standard build:
mlton libpcre3-dev libssl-dev ml-nlffigen ml-yacc rsync
You may optionally install SML/NJ packages for interactive development:
1.1. A Note On Compilers
To use DomTool from an interactive SML REPL session, you will need a recent version of Standard ML of New Jersey. Version 110.74 is sufficient, so packages in Debian 6 and above are adequate, for other distributions you may need to compile it manually.
Why am I referencing two different compilers here? Well, developing with SML/NJ and building release binaries with MLton is standard practice in the SML world. SML/NJ supports separate compilation and interactive use, which are very helpful during development. MLton is a whole-program optimizing compiler that produces extremely efficient binaries, at the cost of much greater compile-time time and memory usage than SML/NJ.
2. Getting the source code
git clone git://git.hcoop.net/git/hcoop/domtool2.git
If you have been granted write permission to the repository and plan to commit code changes, then you'll want to check the repo out either via ssh or openafs using an account with credentials to write to the domtool git directory.
git clone ssh://USER@ssh.hcoop.net/afs/hcoop.net/user/h/hc/hcoop/.hcoop-git/domtool2.git git clone /afs/hcoop.net/user/h/hc/hcoop/.hcoop-git/domtool2.git
3. Building the standalone tools
First, in the domtool2 directory that you have checked out, create a file config.sml containing:
structure Config :> CONFIG = struct open ConfigDefault end
Heck, you could even go ahead and set some non-standard configuration values! If you leave it as is, you inherit the defaults, which should be appropriate for HCoop servers. If you are not installation DomTool at HCoop, see DomTool/NonHCoopSetup for details on configuring DomTool to run outside of HCoop.
Even if you set configuration parameters until you're blue in the face, this stuff probably won't work very well in environments that don't look much like Linux. Perhaps some day greater portability will become enough of a priority for us to fix that.
Once you have that done, the rest is easy! Just run
This will populate domtool2/bin/ with the compiled DomTool programs. As root, run
to copy these programs and some additional scripts to appropriate standard locations. Consult the Makefile if you'd like to see what those locations are ahead of time.
3.1. Reinstalling the standalone tools
If you want to reinstall domtool on machines that are running it already, then it is best to use a slightly modified set of instructions.
First, create a config.sml file as directed above, and run make.
If the current machine is a slave, then run
If the current machine is a server, then run
4. Building for SML/NJ
After following the same procedure as above for config.sml, run
as root. Now you should be able to run sml in the base domtool2 directory and run CM.make "src/domtool.cm";. If you don't see any error messages, then the DomTool modules are loaded and you can start poking them. For instance, running open Main; should print information on the primary entry-points.