OBS-Matcher

Dependencies

python3
python3-dev
python3-venv
libpq-dev
git
build-essential
postgresql
redis

Install

Unix

git clone https://github.com/sandhose/obs-matcher
cd obs-matcher
virtualenv venv
source venv/bin/activate
python3 setup.py install
python3 setup.py develop

Create Postgresql Database

# You may need to create the postgresql database before all :
#sudo su - postgres -c "initdb --locale en_US. UTF-8 -D 'var/lib/postgres/data'"
systemctl start postgresql
sudo -u postgres psql
>>> CREATE ROLE <user> INHERIT LOGIN;
>>> CREATE DATABASE <matcher>;
>>> GRANT ALL PRIVILEGES ON DATABASE <matcher> TO <user>;
Ctrl+D
# Upgrade the database
matcher db upgrade

NOTE: the <user> user needs to be superuser to be able to create extensions. Alternatively, you can create them on the <matcher> database from another superuser before running matcher db upgrade:

>>> CREATE EXTENSION tablefunc
>>> CREATE EXTENSION pg_trgm
>>> CREATE EXTENSION hstore

Usage

# Initiate virtualenv
source venv/bin/activate
# Run local server
gunicorn -w 8 matcher:app --reload
# In another shell, run the celery worker
celery -l info -A matcher:celery

Documentation

# Compile documentation
cd doc
make html

Browse to /path/to/obs-matcher/doc

Run on Docker

# Generate the secret key and postgres password
mkdir secrets
openssl rand -base64 48 > secrets/postgres-password
openssl rand -base64 48 > secrets/secret-key

# Copy the dev override (tweak it if needed)
cp docker-compose.dev.yml docker-compose.override.yml

# Build the docker images
docker-compose build

# Run the app
docker-compose up