Shoot provides a Dockerfile and docker-compose file.
The docker-compose file will:
- Set up a basic Shoot instance (single process
npm run startequivalent) - Set up a postgres database
It will not set up any optional dependencies.
It is a bare-bones installation for those who wish to get up and running quickly. For those who wish to set up more sophisticated Shoot instances, you must still do so manually.
Requirements:
A minimal set of configuration is required to run Shoot.
The configuration is mounted on ./config.
You may use the Shoot CLI to generate keys as normal. Follow the installation instructions to see how to do so.
Then, add the remaining required values to the generated config:
federation.instance_url: can just be "http://localhost:3001" for a simple local setupfederation.webapp_url: can be the same asfederation.instance_url
The Postgres database is persisted via a volume. Do not compose down as you will lose the volume. User content uploaded to Shoot (i.e. when not using s3) is also persisted to a volume.
Simply run the following:
docker compose upYou will now have a Shoot instance running on port 3001
Set Shoot's database.url config to postgres://postgres:postgres@localhost as defined by docker-compose.yml.
You may now use the Shoot CLI as normal. If you wish to do database operations, the postgres container must up.
You do not need to make any changes to config when you restart the Shoot container, as the docker compose file overwrites the database.url.