From 950c35a2b0fa9c0bc1a25e8dd9182b32242c6865 Mon Sep 17 00:00:00 2001 From: Jonatan Ziegler Date: Fri, 28 Jul 2023 13:11:58 +0200 Subject: [PATCH] readme backend docker --- README.md | 2 +- backend/README.md | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 9555f07f..19f20570 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ **Application for communication and collective exchange of menu information in university catering facilities.** -| 🚧 | This project is still in a very early state and WIP! | +| 🚧 | This project is still in a early state and WIP! | |------------|:-----------------------------------------------------------| diff --git a/backend/README.md b/backend/README.md index 74d653cf..3a119cf5 100644 --- a/backend/README.md +++ b/backend/README.md @@ -3,6 +3,24 @@ Backend application for providing and synchronizing meal plan data of the cantee [^1]: https://www.sw-ka.de/de/hochschulgastronomie/speiseplan/ + +## Deploy using Docker +The docker container can be run using +``` +docker run \ + -p 80:80 + -e DATABASE_URL="postgres://:@:/" + -e SMTP_SERVER= \ + -e SMTP_PORT= \ + -e SMTP_USERNAME= \ + -e SMTP_PASSWORD= \ + -e ADMIN_EMAIL= \ + -e FLICKR_API_KEY= \ + ghcr.io/kronos-et-al/mensa-app +``` + +Running the container requires a postgres database, connection to a mail server and a flickr api key. + ## Building - Run `cargo fmt` to format all code files. - Run `cargo clippy` to check for errors and recommendations.