StardustShard/dolltags
1
0
Fork 0
Code Issues 13 Pull requests Wiki Activity

updated the readme too

Browse source
This commit is contained in:
Artemis 2025-02-08 18:42:22 +01:00
parent 761e1daf23
commit f74187843c
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
README.md
View file

@ -36,17 +36,19 @@ In both cases, the daemon/CLI requires a configuration file, by default named `R
Likewise, the assets and template directories will be by default loaded from the CWD but can be pointed to a custom directory using the environment variable `ASSETS_PATH`.
However, the template directory is expected to be in the CWD with no way to change it as-is for now (it will try to search in `$PWD/templates`).
The configuration file requires two keys, shown below.
The configuration file requires three keys, shown below.
```toml
[default]
secret_key = "use `openssl rand -base64 32` to generate it"
public_url = "set the canonical url to your instance here"
[default.databases.dolltags]
url = "postgres://dolltags:password@localhost/dolltags"
```
- `secret_key` is required to securely handle the user sessions; changing the secret key will immediately disconnect any previously-working session
- `public_url` is required to generate the QrCode image URLs that are used to allow users to download and use those QrCodes wherever they want to offer direct access (e.g. pet tags, ID cards, etc). Example: `public_url="https://dolltags.pet/"`
- `url` for the database follows the PostgreSQL connection URL format and should support all its arguments and variants
Once you have it deployed, to get an admin account there is currently no easy way to promote a user so the current procedure is the following.