Skip to content

Commit 73f1bf8

Browse files
committed
Update README with API_INIT_FILE description
Added documentation for the `API_INIT_FILE` variable to outline its purpose in initializing user data at startup. Also adjusted the table formatting for consistency and clarity.
1 parent ee0e97d commit 73f1bf8

1 file changed

Lines changed: 8 additions & 7 deletions

File tree

README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,14 @@ The application reads its configuration from the following environment variables
1010

1111
### General Configuration (`ApplicationEnv`)
1212

13-
| Variable | Description | Default Value | Required? |
14-
|----------------------------|------------------------------------------------------|----------------------------|-----------|
15-
| `API_SECRET_AUTHORIZATION` | Secret used to encrypt and decrypt API token claims. | N/A | Yes |
16-
| `PORT` | The port on which the application runs. | `1080` | No |
17-
| `CONTEXT_PATH` | The base path used for API routing. | `/api/private-network/v1/` | No |
18-
| `PEERS_RESOURCE_PATH` | Filesystem path for peer resource connections. | `/etc/wireguard/` | No |
19-
| `API_SECRET_KEY` | The key used for API security. | N/A | Yes |
13+
| Variable | Description | Default Value | Required? |
14+
|----------------------------|-------------------------------------------------------------------------|----------------------------|-----------|
15+
| `API_SECRET_AUTHORIZATION` | Secret used to encrypt and decrypt API token claims. | N/A | Yes |
16+
| `API_SECRET_KEY` | The api private key used for API security. | N/A | Yes |
17+
| `PORT` | The port on which the application runs. | `1080` | No |
18+
| `CONTEXT_PATH` | The base path used for API routing. | `/api/private-network/v1/` | No |
19+
| `PEERS_RESOURCE_PATH` | Filesystem path for peer resource connections. | `/etc/wireguard/` | No |
20+
| `API_INIT_FILE` | Add the first user data that will be created at the application startup | N/A | No |
2021

2122
### Database Configuration (`DBEnv`)
2223

0 commit comments

Comments
 (0)