phoenix/icarus_auth
1
0
Fork 0
Code Issues 4 Pull Requests Actions Packages Projects Releases 52 Wiki Activity
Files
3db7bc330b80ee8ca801bd7fbaa508e6580c1552
icarus_auth/README.md
phoenix 76f7bbc9e2 tsk-61: Updating readme
2025-10-20 12:16:43 -04:00

1008 B
Raw Blame History

A auth web API services for the Icarus project.

Getting Started

The easiest way to get started is through docker. This assumes that docker is already installed on your system. Copy the .env.docker.sample as .env. Most of the data in the env file doesn't need to be modified. The SECRET_KEY variable should be changed since it will be used for token generation. The SECRET_PASSPHASE should also be changed when in production mode, but make sure the respective passphrase database table record exists.

To enable or disable registrations, use TRUE or FALSE for the ENABLE_REGISTRATION variable. By default it is TRUE.

Build image

docker compose build

Start images

docker compose up -d --force-recreate

Bring it down

docker compose down -v

Pruning

docker system prune -a

To view the OpenAPI spec, run the project and access /swagger-ui. If running through docker, the url would be something like http://localhost:8000/swagger-ui.