phoenix
010ee6aef5
schedtxt_auth Build / Rustfmt (push) Successful in 57s
schedtxt_auth Build / Test Suite (push) Successful in 1m23s
schedtxt_auth Build / Check (push) Successful in 1m23s
schedtxt_auth Build / build (push) Successful in 1m20s
schedtxt_auth Build / Clippy (push) Successful in 1m47s
Reviewed-on: #23
23 lines
567 B
Markdown
23 lines
567 B
Markdown
# schedtxt_auth
|
|
Auth API for `schedtxt` project.
|
|
|
|
|
|
## Getting started
|
|
Quickest way to get started is with docker, make sure that it is installed. Copy over
|
|
the `.env.docker.sample` file and name it `.env`.
|
|
|
|
For `SECRET_KEY` provide a key that is at least 32-characters. This is used for token
|
|
creation. Additionally, provide credentials for the database for the `DB_*` keys.
|
|
|
|
Make sure that `ENABLE_REGISTRATION` is set to true, otherwise registration will not work.
|
|
|
|
Build the container
|
|
```
|
|
docker compose build
|
|
```
|
|
|
|
Bring up the container
|
|
```
|
|
docker compose up
|
|
```
|