azpsen/tailfin
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix readme formatting

Browse Source
This commit is contained in:
april 2023-12-28 17:26:50 -06:00
parent 941dbe527c
commit 99e47765de
1 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

26
api/README.md
View File

@ -73,34 +73,34 @@ $ python app.py
To configure Tailfin, modify the `.env` file. Some of these options should be changed before running the server. All To configure Tailfin, modify the `.env` file. Some of these options should be changed before running the server. All
available options are detailed below: available options are detailed below:
`DB_URI`: Address of MongoDB instance. Default: localhost `DB_URI`: Address of MongoDB instance. Default: `localhost`
<br /> <br />
`DB_PORT`: Port of MongoDB instance. Default: 27017 `DB_PORT`: Port of MongoDB instance. Default: `27017`
<br /> <br />
`DB_NAME`: Name of the database to be used by Tailfin. Default: tailfin `DB_NAME`: Name of the database to be used by Tailfin. Default: `tailfin`
`DB_USER`: Username for MongoDB authentication. Default: tailfin-api `DB_USER`: Username for MongoDB authentication. Default: `tailfin-api`
<br /> <br />
`DB_PWD`: Password for MongoDB authentication. Default: tailfin-api-password `DB_PWD`: Password for MongoDB authentication. Default: `tailfin-api-password`
`REFRESH_TOKEN_EXPIRE_MINUTES`: Duration in minutes to keep refresh token active before invalidating it. Default: `REFRESH_TOKEN_EXPIRE_MINUTES`: Duration in minutes to keep refresh token active before invalidating it. Default:
10080 (7 days) `10080` (7 days)
<br /> <br />
`ACCESS_TOKEN_EXPIRE_MINUTES`: Duration in minutes to keep access token active before invalidating it. Default: 30 `ACCESS_TOKEN_EXPIRE_MINUTES`: Duration in minutes to keep access token active before invalidating it. Default: `30`
`JWT_ALGORITHM`: Encryption algorithm to use for access and refresh tokens. Default: HS256 `JWT_ALGORITHM`: Encryption algorithm to use for access and refresh tokens. Default: `HS256`
<br /> <br />
`JWT_SECRET_KEY`: Secret key used to encrypt and decrypt access tokens. Default: please-change-me `JWT_SECRET_KEY`: Secret key used to encrypt and decrypt access tokens. Default: `please-change-me`
<br /> <br />
`JWT_REFRESH_SECRET_KEY`: Secret key used to encrypt and decrypt refresh tokens. Default: change-me-i-beg-of-you `JWT_REFRESH_SECRET_KEY`: Secret key used to encrypt and decrypt refresh tokens. Default: `change-me-i-beg-of-you`
`TAILFIN_ADMIN_USERNAME`: Username of the default admin user that is created on startup if no admin users exist. `TAILFIN_ADMIN_USERNAME`: Username of the default admin user that is created on startup if no admin users exist.
Default: admin Default: `admin`
<br /> <br />
`TAILFIN_ADMIN_PASSWORD`: Password of the default admin user that is created on startup if no admin users exist. `TAILFIN_ADMIN_PASSWORD`: Password of the default admin user that is created on startup if no admin users exist.
Default: change-me-now Default: `change-me-now`
`TAILFIN_PORT`: Port to run the local Tailfin API server on. Default: 8081 `TAILFIN_PORT`: Port to run the local Tailfin API server on. Default: `8081`
## Usage <a name="usage"></a> ## Usage <a name="usage"></a>