vmario/docs
1
0
Fork 0
mirror of https://github.com/sismics/docs.git synced 2024-11-24 22:57:56 +01:00
Code Issues Packages Projects Releases Wiki Activity

README.md

Browse Source
This commit is contained in:
bgamard 2020-12-31 07:50:04 +01:00
parent af15116bf9
commit 558de7ba3f
1 changed files with 14 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@ -72,46 +72,33 @@ To build external URL, the server is expecting a `DOCS_BASE_URL` environment var
### Available environment variables ### Available environment variables
- General - General
- `DOCS_BASE_URL`: The base url used by the application. Generated url's will be using this as base.
- `DOCS_BASE_URL` -> The base url used by the application. Generated url's will be using this as base. - `DOCS_GLOBAL_QUOTA`: Defines the default quota applying to all users.
- `DOCS_GLOBAL_QUOTA` -> Defines the default quota applying to all users.
- Admin - Admin
- `DOCS_ADMIN_EMAIL_INIT`: Defines the e-mail-address the admin user should have upon initialization.
- `DOCS_ADMIN_EMAIL_INIT` -> Defines the e-mail-address the admin user should have upon initialization. - `DOCS_ADMIN_PASSWORD_INIT`: Defines the password the admin user should have upon initialization. Needs to be a bcrypt hash. **Be aware that `$` within the hash have to be escaped with a second `$`.**
- `DOCS_ADMIN_PASSWORD_INIT` -> Defines the password the admin user should have upon initialization. Needs to be a bcrypt hash. **Be aware that `$` within the hash have to be escaped with a second `$`.**
- Database - Database
- `DATABASE_URL`: The jdbc connection string to be used by `hibernate`.
- `DATABASE_URL` -> The jdbc connection string to be used by `hibernate`. - `DATABASE_USER`: The user which should be used for the database connection.
- `DATABASE_PASSWORD`: The password to be used for the database connection.
- `DATABASE_USER` -> The user which should be used for the database connection.
- `DATABASE_PASSWORD` -> The password to be used for the database connection.
- Language - Language
- `DOCS_DEFAULT_LANGUAGE`: The language which will be used as default. Currently supported values are:
- `DOCS_DEFAULT_LANGUAGE` -> The language which will be used as default. Currently supported values are:
- `eng`, `fra`, `ita`, `deu`, `spa`, `por`, `pol`, `rus`, `ukr`, `ara`, `hin`, `chi_sim`, `chi_tra`, `jpn`, `tha`, `kor`, `nld`, `tur`, `heb`, `hun`, `fin`, `swe`, `lav`, `dan` - `eng`, `fra`, `ita`, `deu`, `spa`, `por`, `pol`, `rus`, `ukr`, `ara`, `hin`, `chi_sim`, `chi_tra`, `jpn`, `tha`, `kor`, `nld`, `tur`, `heb`, `hun`, `fin`, `swe`, `lav`, `dan`
- E-Mail - E-Mail
- `DOCS_SMTP_HOSTNAME`: Hostname of the SMTP-Server to be used by Teedy.
- `DOCS_SMTP_HOSTNAME` -> Hostname of the SMTP-Server to be used by Teedy. - `DOCS_SMTP_PORT`: The port which should be used.
- `DOCS_SMTP_USERNAME`: The username to be used.
- `DOCS_SMTP_PORT` -> The port which should be used. - `DOCS_SMTP_PASSWORD`: The password to be used.
- `DOCS_SMTP_USERNAME` -> The username to be used.
- `DOCS_SMTP_PASSWORD` -> The password to be used.
### Examples ### Examples
In the following examples some passwords are exposed in cleartext. This was done in order to keep the examples simple. We strongly encourage you to use variables with an `.env` file or other means to securely store your passwords. In the following examples some passwords are exposed in cleartext. This was done in order to keep the examples simple. We strongly encourage you to use variables with an `.env` file or other means to securely store your passwords.
#### Using the internal db #### Using the internal database
```yaml ```yaml
version: '3' version: '3'
@ -134,7 +121,7 @@ services:
- ./docs/data:/data - ./docs/data:/data
``` ```
#### Using postgres #### Using PostgreSQL
```yaml ```yaml
version: '3' version: '3'