This repository contains everything required to start the Perses demo, the documentation website, etc.
On the machine, in case you are doing a maintenance and at some point you will shut down all containers, you can't just
run podman-compose up -d.
That's because when you will kill the ssh connection, all containers will be stopped because it will send a signal
SIGHUP that will stop all processes in the current session.
Instead you will have to run the following command:
nohup podman-compose up &In case you just want to restart a container. You can do the following command:
podman-compose down <container_name>
podman-compose up -d <container_name>No need to use nohup in this case, as the podman-compose is still running in the background.
The process is killed if you are shutting down all containers.
We recommend you to create a python virtual environment.
python3 -m venv venv
source ./venv/bin/activate # Scripts instead of bin on windowsThen you can install the libs required to run the Perses website:
pip install -r requirements.txtAnd finally, you can run the server:
mkdocs serve -a "localhost:8080"To build the website, run:
mkdocs buildThen you can run:
podman-compose up -d websiteThen website is available at the url http://localhost:1313
In case you need to restart the demo server after a config change:
- build the new config:
sh scripts/generate_config.sh- restart the demo server:
podman-compose down demo
# wait a bit, otherwise the old instance could still be running and you'd get an "address already in use" error
podman-compose up -d demothe documentation website "compiled" files are stored in git. To update the website you thus have to run
mkdocs build & commit the changes it produces.