From 8c443b19cd3334a91f31d6cbbeaf4ba4733afd70 Mon Sep 17 00:00:00 2001 From: Wolfgang Ludger Hottgenroth Date: Sun, 29 Aug 2021 13:16:50 +0200 Subject: [PATCH] docs --- .gitignore | 4 ++-- api/run.sh | 14 -------------- readme.md | 4 +++- 3 files changed, 5 insertions(+), 17 deletions(-) delete mode 100755 api/run.sh diff --git a/.gitignore b/.gitignore index 3602310..e921d7a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +1,5 @@ __pycache__/ ENV -./api/config/dbconfig.ini -./api/config/authservice.pub +api/config/dbconfig.ini +api/config/authservice.pub diff --git a/api/run.sh b/api/run.sh deleted file mode 100755 index e8e252f..0000000 --- a/api/run.sh +++ /dev/null @@ -1,14 +0,0 @@ -#!/bin/bash - -. ENV - -IMAGE_NAME="registry.hottis.de/hv2/hv2-api" -VERSION=0.0.x - - -docker run \ - -d \ - --rm \ - --name "hv2-api" \ - -p 5000:5000 - ${IMAGE_NAME}:${VERSION} diff --git a/readme.md b/readme.md index 00590dd..acdbf11 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,6 @@ * all tools provide should work on Linux and on Windows, shell scripts are avoided * templates files must be generated at development time, generated files must be put into the repository * use ``generate.py`` in the umbrella project's root without any arguments to generate all template files in all subdirectories using the ``schema.json`` from the umbrella project's root -* to start the API set the required env variables (see ``ENV.tmp``) and run ``test.py`` from the API subproject +* to start the API set the required env variables (see ``ENV.tmp``) or the configuration files in the subdirectory ``./config`` and run ``test.py`` from the API subproject +* make sure these configuration files are not added to the repository, they contain secrets +