The SITMUN Application Stack is an example of how to deploy SITMUN as a multi-container application. It is designed to work in development and testing environments.
Before you begin, ensure you have met the following requirements:
Windows/Linux/Mac
machine.To install the SITMUN Application Stack, follow these steps:
Clone the repository and fetch and checkout nested SITMUN projects:
git clone --recurse-submodules https://github.com/sitmun/sitmun-application-stack.git
Change to the directory of the repository:
cd sitmun-application-stack
Create a new file named .env
inside the directory.
Open the .env
file in a text editor and add your GitHub personal access token (GITHUB_TOKEN
) in the following format:
GITHUB_TOKEN=your_personal_access_token
Start the SITMUN Application Stack:
docker compose up
This command will build and start all the services defined in the docker-compose.yml
file.
Access the SITMUN viewer application at http://localhost:9000/viewer. Use the public access which does not require authentication.
Access the SITMUN administrative application at http://localhost:9000/admin.
This requires authentication. The default username is admin
and the default password is admin
.
If the source code of the SITMUN stack is changed, fetch changes and rebuild the services:
git pull --recurse-submodules
docker compose up --build
The SITMUN Application Stack uses environment variables to configure the services.
The environment variables are defined in the .env
file.
The following environment variables are available:
GITHUB_TOKEN
: GitHub personal access token (classic).
The token is required to get npm
packages from GitHub Packages.The SITMUN Application Stack uses Docker Compose to define the services.
The services are defined in the docker-compose.yml
file.
The following services are available:
viewer
: SITMUN viewer applicationadmin
: SITMUN administrative applicationbackend
: SITMUN APIproxy
: SITMUN proxyFor testing purposes, the use of the proxy
is controlled by the sitmun.proxy.force
environment variable in backend
, which by default is true
.
Data is stored in the pgdata
volume, which is used by the postgres
service.
To stop and remove all services, volumes, and networks defined in the docker-compose.yml
file, use:
docker compose down -v
To contribute to SITMUN Application Stack, follow these steps:
Alternatively, see the GitHub documentation on creating a pull request.
This project uses the following license: European Union Public Licence V. 1.2.