Skip to content

Latest commit

 

History

History
85 lines (67 loc) · 7.31 KB

README.md

File metadata and controls

85 lines (67 loc) · 7.31 KB

Stemmaweb Middleware

This module holds the source code of the middleware that is used to connect the frontend to the backend, taking care of authentication and authorization. The middleware is a Python Flask application, exposing REST endpoints to the frontend.

Table of Contents

Running Locally

You can decide whether you would like to run the application locally using Docker or by installing the dependencies and starting the server using Poetry.

Regardless of the method you choose, you will need to specify the following environment variables to start the server successfully. As the table below shows, some of these have default values (hence they are optional) and some are required.

Variable Description Default
STEMMAREST_ENDPOINT The URL where the Stemmarest backend is running http://127.0.0.1:8080/stemmarest
STEMMAWEB_MIDDLEWARE_URL The URL where this middleware is running ''
STEMMAWEB_STATIC The directory that holds the static files in the front-end (for production mode service) static
SECRET_KEY Secret key for the Flask application, used by Flask-Login.
Generate it by executing python -c 'import secrets; print(secrets.token_hex())' in your shell.		 🚫
GOOGLE_CLIENT_ID Google OAuth client ID 🚫
GOOGLE_CLIENT_SECRET Google OAuth client secret 🚫
GITHUB_CLIENT_ID GitHub OAuth client identifier 🚫
GITHUB_CLIENT_SECRET GitHub OAuth client secret 🚫
RECAPTCHA_SITE_KEY reCAPTCHA public identifier 🚫
RECAPTCHA_SECRET_KEY reCAPTCHA private key 🚫
STEMMAWEB_FRONTEND_URL The URL of the frontend, if the frontend is running separately. Will be set as the redirect destination after Google OAuth ''
LOG_LEVEL Logging verbosity DEBUG
LOGFILE Destination file to store the logs, relative to this module's root stemmaweb_middleware.log
LOG_BACKTRACE Whether error backtraces should be logged True
GUNICORN_WORKERS Number of workers to be spawned by gunicorn in the production deployment. Passed to --workers 🚫
GUNICORN_BIND Address to bind the WSGI server to. Passed to --bind 🚫

Running with Poetry

If you don't have Poetry installed on your machine you can do so by following the official docs. You will also need Make to run commands easily.

Please create a .env file and fill it with the environment variables described above. You can use the .env.example file as a template.

Install the dependencies using Poetry, then start the server:

poetry install
make serve

Running with Docker

Build the image using the following command:

docker build -t stemmaweb-middleware .

Run the image using the command below, after replacing the environment variables with your own values:

docker run -it \
    -p 3000:3000 \
	-e STEMMAREST_ENDPOINT=http://127.0.0.1:8080/stemmarest \
	-e STEMMAWEB_MIDDLEWARE_URL=http://127.0.0.1:3000 \
	-e SECRET_KEY= \
	-e GOOGLE_CLIENT_ID= \
	-e GOOGLE_CLIENT_SECRET= \
	-e STEMMAWEB_FRONTEND_URL=http://127.0.0.1:5000 \
	-e LOG_LEVEL=DEBUG \
	-e LOGFILE=stemmaweb_middleware.log \
	-e LOG_BACKTRACE=True \
	stemmaweb-middleware

Please note that in most cases running the middleware alone is not desired, since it is a single component of a broader stack. It is highly advised to run the whole stack using the Docker Compose, as described in the project's root-level README. In that case, all the environment variables will be sourced from the root-level .env* files.