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

Prerequisites

You will need Leiningen 2.0 or above installed.

You will need node and bower installed.

Running

In development

To start a web server for the application during development, run:

lein bower install
lein ring server

In production

To deploy Smeagol as a stand-alone application, compile it with:

lein bower install
lein 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 two 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)'

You can run the jar file with:

java -jar smeagol-VERSION-standalone.jar

Alternatively, if you want to deploy to a servlet container (which I would strongly recommend), the simplest thing is to run:

lein bower install
lein ring uberwar

(a command which I'm sure Smeagol would entirely appreciate) and deploy the resulting war file. NOTE that if your Servlet container is configured to unpack war files you do not need to supply the environment variables specified above, but if it does not you must do so.

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.