You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+11-22Lines changed: 11 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,12 +17,18 @@ The recommended and only supported way for production deployments is to run the
17
17
18
18
### Configuration
19
19
20
-
The backend can be configured with the following environment variables
20
+
:warning: If you do not configure a postgresql database, sqlite will automatically be used. Mount a persistent volume to the `/data` directory - this is where the sqlite database is stored. If you do not do this, you will lose all data every time the container is deleted.
|`GIN_MODE`| One of `release`, `debug`|`release`| The mode that gin runs in. Only set this to `debug` on your development environment! |
27
+
|`LOG_FORMAT`| One of `json`, `human`|`json` if `GIN_MODE` is `release`, otherwise `human`| If log output is written human readable or as JSON. |
28
+
|`DB_HOST`|`string`|| hostname or address of postgresql |
29
+
|`DB_USER`|`string`|| username for the postgresql connection |
30
+
|`DB_PASSWORD`|`string`|| password for `DB_USER`|
31
+
|`DB_NAME`|`string`|| name of the database to use |
26
32
27
33
### Deployment methods
28
34
@@ -59,23 +65,6 @@ ingress:
59
65
- envelope-zero.example.com
60
66
```
61
67
62
-
### Database backends
63
-
64
-
Envelope Zero currently supports sqlite and postgresql as database backends. While sqlite is supported, it is highly recommended to use postgresql for production purposes.
65
-
66
-
#### sqlite
67
-
68
-
No configuration is needed, but you need to mount a persistent volume to the `/app/data` directory or the backend won’t start.
69
-
70
-
#### postgresql
71
-
72
-
Set the following environment variables:
73
-
74
-
- `DB_HOST`: The hostname for the postgresql instance
75
-
- `DB_USER`: The username to connect with
76
-
- `DB_PASSWORD`: The password for `DB_USER`
77
-
- `DB_NAME`: The name of the database to use
78
-
79
68
## Supported Versions
80
69
81
70
This project is under heavy development. Therefore, only the latest release is supported.
0 commit comments