IT4Change/ohmyform-api
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

update environment doc

Browse Source
This commit is contained in:
Michael Schramm 2021-05-02 16:04:44 +02:00
parent 9327514e83
commit e9e53b4149
1 changed files with 14 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
doc/environment.md
View File

@ -9,6 +9,18 @@
| HIDE_CONTRIB | `false` | decide if backlings to ohmyform should be added | | HIDE_CONTRIB | `false` | decide if backlings to ohmyform should be added |
| SIGNUP_DISABLED | `false` | if users can sign up | | SIGNUP_DISABLED | `false` | if users can sign up |
| LOGIN_NOTE | *not set* | Info box on top of login screen | | LOGIN_NOTE | *not set* | Info box on top of login screen |
| LOCALES_PATH | *not set* | Path to translated elementes in backend like emails |
## Default Account
*username and email are unique on an instance*
| Name | Default Value | Description |
| ---- | ------------- | ----------- |
| CREATE_ADMIN | `false` | if `true` will create a super admin |
| ADMIN_USERNAME | `root` | username for the default admin user |
| ADMIN_EMAIL | `admin@ohmyform.com` | email to send notifications |
| ADMIN_PASSWORD | `root` | password for user |
## Mailing ## Mailing
@ -27,4 +39,5 @@
| DATABASE_LOGGING | `false` | if `true` all db interactions will be logged to stdout | | DATABASE_LOGGING | `false` | if `true` all db interactions will be logged to stdout |
| DATABASE_MIGRATE | `true` | can be used in load balanced environments to only allow one container to perform migrations / manually execute migrations | DATABASE_MIGRATE | `true` | can be used in load balanced environments to only allow one container to perform migrations / manually execute migrations
| DATABASE_SSL | `false` | if `true` will require ssl database connection | | DATABASE_SSL | `false` | if `true` will require ssl database connection |
| REDIS_HOST | *not set* | required in multinode environments |
| REDIS_PORT | `6379` | port for redis |