Quick start

Your 5 minutes up&running promise™

circle-check

1. Download and unzip

file-download
797B

2. Login

Open terminal and login to registry

docker login registry.rechtlogisch.de -u [email protected]
circle-info

Please use provided credentials.

3. Run

Go to the path where docker-compose.yml was placed and run

docker compose up -d
circle-info

It might take up to 2 minutes to download all images. Feel free to grab a coffee meanwhile ☕️

4. Test API

You can test v3 endpoints with OpenAPI and v2 endpoints with Postman.

OpenAPI

Head over to the OpenAPI documentation, export it and import in your client software of choice.

OpenAPIchevron-right
circle-exclamation

5. Ready for production?

Setup productive environment.

Go to Settings section. You need to adjust some Docker environment variables.

Last updated