Manages user related data as well as authentication and permissions. Connects to Keycloak and optionally AD or OpenLDAP

This project is using Poetry to handle the dependencies. Installtion instruction for poetry can be found at https://python-poetry.org/docs/#installation

1. Clone the project.

   git clone https://github.com/PilotDataPlatform/auth.git
   

2. Install dependencies.

   poetry install
   

3. Add environment variables into .env. Use .env.schema as a reference.

4. Run setup scripts for postgres

   • Create DB
   • Create Schemas

5. Run migration using alembic.

   poetry run alembic upgrade head
   

6. Run SQL script to populate casbin permissions

   • Casbin Script

7. Run application.

   poetry run python run.py
   

This project can also be started using Docker.

1. To build and start the service within the Docker container, run:

   docker compose up
   

2. Migrations should run automatically after the previous step. They can also be manually triggered:

   docker compose run --rm alembic upgrade head
   

• Pilot Platform API Documentation
• Pilot Platform Helm Charts

You can contribute the project in following ways:

• Report a bug.
• Suggest a feature.
• Open a pull request for fixing issues or adding functionality. Please consider using pre-commit in this case.