phoenix
e86ca4b2c8
All checks were successful
Rust Build / Check (push) Successful in 42s
Rust Build / Test Suite (push) Successful in 1m18s
Rust Build / Rustfmt (push) Successful in 29s
Rust Build / Clippy (push) Successful in 40s
Rust Build / build (push) Successful in 57s
Release Tagging / release (push) Successful in 35s
Closes #61 Reviewed-on: #73 Co-authored-by: phoenix <kundeng00@pm.me> Co-committed-by: phoenix <kundeng00@pm.me>
37 lines
1008 B
Markdown
37 lines
1008 B
Markdown
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`.
|