You will get an strapi instance with the content model for rpb provided. User accounts and content entries are not included.
Install Docker Engine by follwing the guide for your distro.
Install Docker Compose as a plugin.
Alternatively, you may want to use the Docker Desktop environment which includes a GUI and all Docker components.
$ git clone https://github.com/hbz/strapi-rpb.git
$ cd strapi-rpb
For development on your local machine you can use Docker compose:
$ docker compose up
to spin up the two docker containers. The strapi app is accessible at http://localhost:8000/.
You first need to create an admin user via the GUI or via the CLI.
In order to access the content-types through the REST API you need to set the appropriate permissions. Go to http://localhost:8000/admin/settings/users-permissions/roles, click on the respective role and set the permissions for each content-type. For more details please have a look at the docs of the Users & Permissions plugin.
To open a bash in your container (e.g. to use strapi CLI commands), run:
$ docker exec -it strapi-rpb bash
To see changes made to the lookup plugin in your admin UI, run (in the project root directory):
$ cd -
$ strapi build
Some config (e.g. field labels) is actually stored in the DB, not in repo files.
It can be dumped to a file inside the container and copied to the local repo with:
docker compose exec strapi-rpb strapi config:dump -f config.json
docker compose cp strapi-rpb:./opt/app/config.json .
Reverse for restoring from the file:
docker compose cp config.json strapi-rpb:./opt/app/
docker compose exec strapi-rpb strapi config:restore -f config.json
The current config dump is checked into the repo as config.json. Caution: credentials (eg. API Tokens) will also be dumped into this file. Be sure your config contains non-sensitiv data only. In doubt you should not commit your config.
When running the restore command you can choose from different strategies: replace (default), merge, keep.
Read more in the Strapi docs.
To deploy changes, go to the repo directory, pull the changes, and rebuild the container (sudo docker compose down ; sudo docker compose -f docker-compose-prod.yml up -d --build).
For details on our setup see https://dienst-wiki.hbz-nrw.de/display/SEM/RPB (internal).