Temporary setup procedure:
- Install Docker Compose on Linux or OS X. Windows power users who've installed Python and
pipcan try this hint from the Docker Compose repository.
- Determine whether you want to create an HTTP-only local instance of KoBo Toolbox, or a HTTPS publicly-accessible server instance (for testing, there are workarounds if your server is not yet publicly accessible).
- Create a symlink from either
ln -s docker-compose.local.yml docker-compose.yml). Otherwise, you'll have to prefix all Docker Compose commands like
docker-compose -f docker-compose.local.yml.
- Pull the latest images from Docker Hub:
- Build any overridden images:
- Edit the appropriate environment file,
envfile.server.txt, filling in all mandatory variables, and optional variables as needed.
- Make a
secretsdirectory in the project root and copy the SSL certificate and key files to
secrets/ssl.keyrespectively. The certificate and key are expected to use exactly these filenames and must comprise either a wildcard or SAN certificate+key pair which are valid for the domain and subdomains specified in
- If testing on a server that is not publicly accessible at the subdomains you've specified in
envfile.server.txt, put an entry in your host machine's
/etc/hostsfile for each of the three subdomains you entered to reroute such requests to your machine's address (e.g.
192.168.1.1 kf-local.kobotoolbox.org). Also, uncomment and configure the
- Make a
- Optionally clear persisted files from previous runs, taking care that you are in the
sudo rm -rf .vols/ log/.
- Optionally stop and clear previously built
docker-compose stop; docker-compose rm.
- Start the server:
docker-compose up(or with
up -dto run in background).
- Logs for an individual container can be viewed by using the container name from your
docker-compose logs enketo_express.
- KoBoCAT login redirect (e.g https://kc-local.kobotoolbox.org -> https://kf-local.kobotoolbox.org/accounts/login/?next=/kobocat/ -> https://kf-local.kobotoolbox.org/kobocat/ ->
Docker Pull Command