[odrs-web/readme-update: 19/22] Update README due to deployment changes




commit 02ea23fe72f3b3a6c3aab8ef8cae8b4acf5b26ab
Author: Bartłomiej Piotrowski <bpiotrowski gnome org>
Date:   Thu Apr 28 11:51:45 2022 +0200

    Update README due to deployment changes

 README.md | 53 ++++++++++-------------------------------------------
 1 file changed, 10 insertions(+), 43 deletions(-)
---
diff --git a/README.md b/README.md
index da445d9..d8ad6f7 100644
--- a/README.md
+++ b/README.md
@@ -2,54 +2,21 @@
 
 A Flask web service for submitting application reviews
 
-## How do I set up the database ##
+## Setting up local environment
 
-To set up the database tables do:
+The easiest way is to run `docker compose up` in the root directory. This will
+bring up a local ODRS instance with all needed services. Gunicorn can be
+directly accessed at http://localhost:8080, while nginx used for production
+traffic listens at http://localhost:8000.
 
-    CREATE DATABASE odrs;
-    CREATE USER 'test'@'localhost' IDENTIFIED BY 'test';
-    USE odrs;
-    GRANT ALL ON odrs.* TO 'test'@'localhost';
+## Deployment
 
-The default admin password is `Pa$$w0rd`
+New commits to the master branch are automatically deployed to the testing
+instance at https://odrs-dev.apps.openshift4.gnome.org/.
 
-## How do I backup the data ##
-
-You want to save the variable `ODRS_REVIEWS_SECRET` so that old review data
-can be used on the new instance.
-
-    mysqldump odrs > backup.sql
-
-## How do I restore from a backup ##
-
-    mysql
-      CREATE DATABASE odrs;
-      use odrs;
-      source backup.sql;
-
-## Can I clean up the event log a bit? ##
-
-    mysql
-      DELETE FROM eventlog WHERE message = 'already reviewed';
-      DELETE FROM eventlog WHERE message = 'duplicate vote';
-      DELETE FROM eventlog WHERE message = 'getting';
-      DELETE FROM eventlog WHERE message = 'getting moderatable reviews';
-      DELETE FROM eventlog WHERE message LIKE 'voted % on review';
-
-## How to I use distro packages ##
-
-    pkcon install python3-PyMySQL python3-flask python3-flask-wtf \
-      python3-flask-login
+A commit can be promoted to production environment by manually starting the
+`odrs` job [here](https://gitlab.gnome.org/Infrastructure/odrs-web/-/jobs).
 
 ## I have a question
 
 Email me or grab me on IRC (`hughsie libera chat`).
-
-## How to build the docker image?
-
-    podman build . \
-        --build-arg ODRS_REVIEWS_SECRET=1 \
-        --build-arg SQLALCHEMY_DATABASE_URI=mysql+pymysql://test:test@localhost/odrs?charset=utf8mb4
-    podman images
-    podman run --env-file env.cfg <image>
-    podman run --env-file env.cfg -it --entrypoint /bin/bash <image>


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]