changes in readme to make docker cfg upgrade-safe

small addition in readme for port binding
This commit is contained in:
LH
2021-08-18 12:08:55 +02:00
parent 6bce4f1551
commit b53e086888
2 changed files with 18 additions and 7 deletions

View File

@ -39,10 +39,10 @@ In order to execute code submissions using Docker, source code files are written
### Optional Steps
- use Docker Machine or vagrant if there is no native support for docker on your OS
- if you want to use the app without docker (and hence without code execution) comment the validation `validate :working_docker_image?` in `models/execution_environments.rb` otherwise the seed will fail (because of missing docker connection)
- create seed data by executing `rake db:seed`
- if you already created a configuration for your local installation and want to use vagrant, too, be sure to log into the vagrant instance via ssh and add your database user manually to the database. Afterwards, create, migrate and seed.
- Use Docker Machine or vagrant if there is no native support for docker on your OS
- If you want to use the app without docker (and hence without code execution) comment the validation `validate :working_docker_image?` in `models/execution_environments.rb` otherwise the seed will fail (because of missing docker connection)
- Create seed data by executing `rake db:seed`
- If you already created a configuration for your local installation and want to use vagrant, too, be sure to log into the vagrant instance via ssh and add your database user manually to the database. Afterwards, create, migrate and seed.
## Production Setup
@ -53,4 +53,8 @@ In order to execute code submissions using Docker, source code files are written
- We use a [Prometheus Exporter](https://github.com/discourse/prometheus_exporter) and a [Telegraf Client](https://github.com/jgraichen/telegraf-ruby)
- The Telegraf client collects the data from the Prometheus endpoint, adds its own datasets and forwards them to an InfluxDB
- The Prometheus Exporter must be started separately **before** running the Rails server via `bundle exec prometheus_exporter`
- The InfluxDB data can be visualized using Grafana, for example. There is also an adapted [dashboard](docs/grafana/prometheus_exporter_grafana_dashboard.json) for this purpose
- The InfluxDB data can be visualized using Grafana, for example. There is also an adapted [dashboard](docs/grafana/prometheus_exporter_grafana_dashboard.json) for this purpose
## Additional Note
- As the underlying rails server uses port 3000 as the default seeting, you can use [authbind] (https://www.mwells.org/coding/2016/authbind-port-80-443/) to bind it to the regular 80/443 port.