feat: add minimal-connector to compose

This commit is contained in:
Michel Jonathan Schmitz
2019-07-25 09:55:21 +02:00
parent 23f4f2de2f
commit 203a8127f5
5 changed files with 46 additions and 0 deletions

View File

@@ -106,6 +106,25 @@ This is a small program that shows the usage of the [api](https://gitlab.com/ope
data from TypeScript code. Feel free to copy the [minimal-connector](https://gitlab.com/openstapps/minimal-connector/)
and write your own connector with it.
## Add your connector
You may want to integrate your connectors in the `docker-compose.yml` to
deploy your whole StApps-backend-environment in a single command. Use the
`systemd` directory in this project as an example of how to deploy
your connector(s) and configure `systemd` services and timers.
The service will try to restart a named container. That means for successful
execution the container needs to be started once before with the appropriate
command.
```shell
docker-compose up minimal-connector
```
To enable the service that runs the connector periodically execute:
```shell
systemctl --now enable /absolute/path/minimal-deployment/minimal-connector/minimal-connector.service /absolute/path/minimal-deployment/minimal-connector/minimal-connector.timer
```
This command will immediately start the service on execution.
## Round off your deployment with the [proxy](https://gitlab.com/openstapps/proxy)
The backend is exposed on the port 3000 now. This means anyone can import data into your backend and you can only run
one version of the backend at a time. Have a look at the [proxy](https://gitlab.com/openstapps/proxy/) to secure and