unillett/idig repository overview

⁠Introduction

Docker configuration for the iDig server.

⁠Development with Docker

⁠Docker installation

A working Docker⁠ installation is mandatory.

⁠Docker environment file

Please make sure to copy & rename the example.env file to .env.

cp example.env .env

You can replace the values if needed, but the default ones should work.

⁠Starting the server

To start iDig server with Docker, you need to use the docker compose up command from the project root directory (add -d if you want to run in the background and silence the logs). This command will automatically download the latest docker image, and start the iDig server, the root directory will be mapped to the server-data folder.

Once the server is running, you can access it at http://localhost:9000.

⁠Server configuration

You can use the configuration commands when you're connected to the idig-server container.

# Connect to the running container
docker exec -it idig-server bash

# Create a project named Agora in the data folder
idig-server create data/Agora

# Add a user to the Agora project
idig-server adduser data/Agora bruce myPassw0rd

...

⁠Server updates

The server files are needed, you should initialize the idig-server submodule if it's not already done.

git submodule init
git submodule update

To update the server with the latest code changes, you should first pull the latest changes from the iDig repository⁠.

git submodule update --remote idig-server

Then, you can use the following commands to update the server (projects data will be persisted through the server-data folder).

docker compose down
docker compose build
docker compose up -d

Test the server, then commit and push the changes. The updated image will be automatically created on Docker Hub⁠.

⁠Deployment with Docker

Copy & rename the docker-compose.override.yml.prod file to docker-compose.override.yml.

cp docker-compose.override.yml.prod docker-compose.override.yml

You can replace the values if needed, but the default ones should work for production.

Build & run all the containers for this project:

docker compose up -d

Use a reverse proxy configuration to map the url to port 9000.