Authenticate users from different internal services against Som Energia client-space
Before you begin, ensure you have met the following requirements:
- Python 3.8 or higher
- You should have installed
pipenv
. Instructions here -> https://pipenv.readthedocs.io/en/latest/#install-pipenv-today - You should have a
Linux/Mac
machine. Windows is not supported and we are not thinking in it. - An
nginx
installation - Optionally, a user with sudo permissions
Review internal documentation for deployment instructions.
We will assume that the folowing folder exists:
PROJECTS_PATH
=$HOME/projects
Checkout the project:
user@host:> git clone [email protected]:Som-Energia/som-cas.git $PROJECTS_PATH/som-cas
Walk throw $PROJECTS_PATH/som-cas
and install the requirements with pipenv
user@host:> cd $PROJECTS_PATH/som-cas
user@host:som-cas> pipenv install --dev
Copy conf.yaml.example
to config/conf.yaml
and adapt it to meet the current scenario.
If you want to place this file in other folder, set the environ variable SOM_CAS_CONFIG
with the full path of the configuration file.
Run migrations, create an admin user and run the server to check that everything fit.
user@host:som-cas> pipenv run ./manage.py migrate
user@host:som-cas> pipenv run ./manage.py createsuperuser
user@host:som-cas> pipenv run ./manage.py runserver
For testing configuration copy som_cas/tests/test.conf.yaml.example
to som_cas/tests/test.conf.yaml
and adapt it to meet the current scenario.
user@host:som-cas> pipenv run pytest som_cas
And that's it. Now you can start to develop in a new branch. Please, when you are finished, make a pull request and asign one of us. We will check the pull request and if is every thing is ok, we will acept it :D
If you want to contact with us, feel free to send an email to [email protected].
This project uses the following license: GNU AFFERO GENERAL PUBLIC LICENSE.