smeagol/resources/public/content/Deploying Smeagol.md

Deploying as a stand-alone application

To deploy Smeagol as a stand-alone application, either download the jar file for the release you want to deploy, or clone the source and compile it with:

lein bower install
lein ring uberjar

This will create a jar file in the target directory, named smeagol-VERSION-standalone.jar.

Smeagol cannot access either its configuration or its content from the jar file. Consequently you should set up three environment variables:

1. SMEAGOL_CONFIG should be the full or relative pathname of a Smeagol Configuration file;
2. SMEAGOL_CONTENT_DIR should be the full or relative pathname of the directory from which Smeagol should serve content (which may initially be empty, but must be writable by the process which runs Smeagol)'
3. SMEAGOL_PASSWD should be the full or relative pathname of a Smeagol Passwd file - see Security and authentication. This file must contain an entry for at least your initial user, and, if you want to administer users through the user interface, must be writable by the process which runs Smeagol);

You can run the jar file with:

java -jar smeagol-VERSION-standalone.jar

Deploying within a servlet container

To deploy Smeagol within a servlet container, either download the jar file for the release you want to deploy, or clone the source and compile it with:

lein bower install
lein ring uberwar

This will create a war file in the target directory, named smeagol-VERSION-standalone.war. Deploy this to your servlet container in the normal way; details will depend on your container. Instructions for Tomcat are here.

The problem with this is that unless the environment variables (see above) were already set up in the environment of the servlet container at the time when the servlet container were launched, Smeagol will run with its built-in defaults. This will run perfectly satisfactorily provided your servlet container is configured to unpack war files, which most are.

Experimental Docker image

You can now run Smeagol as a Docker image. Read more about Using the Docker Image.

To run my Docker image, use

docker run simonbrooke/smeagol

Smeagol will run, obviously, on the IP address of your Docker image, on port 8080. To find the IP address, start the image using the command above and then use

docker inspect --format '{{ .NetworkSettings.IPAddress }}' $(docker ps -q)

Suppose this prints '10.10.10.10', then the URL to browse to will be http://10.10.10.10:8080/smeagol/

This image is experimental, but it does seem to work fairly well. What it does not yet do, however, is push the git repository to a remote location, so when you tear the Docker image down your edits will be lost. My next objective for this image is for it to have a cammand line parameter being the git address of a repository from which it can initialise the Wiki content, and to which it will periodically push local changes to the Wiki content.

To build your own Docker image, run:

lein clean
lein bower install
lein ring uberwar
lein docker build

This will build a new Docker image locally; you can, obviously, push it to your own Docker repository if you wish.