Skip to content
This repository has been archived by the owner on Dec 27, 2023. It is now read-only.

Commit

Permalink
docs(docker/quickstart): move options to separate file
Browse files Browse the repository at this point in the history
- also remove versions info as this changes quickly

Change-Id: I9deb2678f44941ee481c8bdd8e62f33cd304ab66
Reviewed-on: http://gerrit.tine20.com/customers/17851
Reviewed-by: Philipp Schüle <p.schuele@metaways.de>
Tested-by: Philipp Schüle <p.schuele@metaways.de>
  • Loading branch information
pschuele committed Sep 10, 2020
1 parent aed8320 commit 3f9f921
Show file tree
Hide file tree
Showing 4 changed files with 113 additions and 119 deletions.
56 changes: 56 additions & 0 deletions docs/docker/DOCKER-OPTIONS-DE.md
@@ -0,0 +1,56 @@
Tine 2.0 Business Edition Docker Optionen
---
[www.tine20.com](https://www.tine20.com/) | [GitHub](https://github.com/tine20/tine20) | [Dockerfile](https://github.com/tine20/tine20/blob/main/ci/dockerimage/Dockerfile)

#### Optionen
| Option | Wert | Beschreibung |
|---|---|---|
| TINE20_ACCEPTED_TERMS_VERSION | __0__ | Die Version der akzeptierten Begriffe muss die aktuelle oder neuere Version sein.
| TINE20_ BUILDTYPE | __PRODUCTION__, DEVELOMENT | Muss auf DEVELOMENT eingestellt sein, damit das Webpack ordnungsgemäß funktioniert.
| TINE20_LOGGER_PRIORITY | __5__,0-7 |
| TINE20_FILESDIR | `/var/lib/tine20/files` |
| TINE20_TMPDIR | `/var/lib/tine20/tmp` |
| TINE20_DATABASE_HOST | | verpflichtend
| TINE20_DATABASE_DBNAME | | verpflichtend
| TINE20_DATABASE_USERNAME | | verpflichtend
| TINE20_DATABASE_PASSWORD | | verpflichtend
| TINE20_DATABASE_TABLEPREFIX | tine20_ |
| TINE20_DATABASE_ADAPTER | __pdo_mysql__ |
| TINE20_SETUPUSER_USERNAME | | verpflichtend
| TINE20_SETUPUSER_PASSWORD | | verpflichtend
| TINE20_LOGIN_USERNAME | | verpflichtend
| TINE20_LOGIN_PASSWORD | | verpflichtend
| TINE20_CACHING_ACTIVE | __true__, false |
| TINE20_CACHING_LIFETIME | 3600 |
| TINE20_CACHING_BACKEND | __File__, Redis |
| TINE20_CACHING_PATH | `/var/lib/tine20/caching` |
| TINE20_CACHING_REDIS_HOST | | verpflichtend wenn TINE20_CACHING_BACKEND == Redis
| TINE20_CACHING_REDIS_POR | 6379 |
| TINE20_CACHING_REDIS_PREFIX | master |
| TINE20_SESSION_LIFETIME | 86400 |
| TINE20_SESSION_BACKEND | __File__,Redis |
| TINE20_SESSION_HOST | `/var/lib/tine20/sessions` |
| TINE20_SESSION_PORT | 6379 |
| TINE20_SESSION_PATH | | mandatory if TINE20_SESSION_BACKEND == Redis
| TINE20_CREDENTIALCACHESCHAREDKEY | | verpflichtend
| TINE20__* | | Alle Eigenschaften, die mit setup.php --setconfig festgelegt werden können, können auch mit TINE20__<app>_<property> or for Tinebase with TINE20__<property> festgelegt werden.
| NGINX_CLIENT_MAX_BODY_SIZE | 1m
| NGINX_KEEPALIVE_TIMEOUT | 65
| NGINX_TCP_NOPUSH | off
| NGINX_GZIP | off
| NGINX_GZIP_STATIC | off
| NGINXV_SERVER_NAME | _
| NGINXV_CLIENT_MAX_BODY_SIZE | 24M
| PHPFPM_DYNAMIC | dynamic | sollte pm genannt werden
| PHPFPM_PM_MAX_CHILDREN | 5
| PHPFPM_PM_START_SERVER | 2
| PHPFPM_PM_MIN_SPARE_SERVERS | 1
| PHPFPM_PM_MAX_SPARE_SERVERS | 3
| PHPFPM_PM_MAX_REQUETS | 500
| PHP_MAX_EXECUTION_TIME | 30
| PHP_MAX_INPUT_TIME | 60
| PHP_MEMORY_LIMIT | 1024M
| PHP_POST_MAX_SIZE | 8M
| PHP_UPLOAD_MAX_FILESIZE |2M
| PHP_MAX_FILE_UPLOADS | 20
| PHP_DEFAULT_SOCKET_TIMEOUT | 60
56 changes: 56 additions & 0 deletions docs/docker/DOCKER-OPTIONS-EN.md
@@ -0,0 +1,56 @@
Tine 2.0 Business Edition Docker Options
---
[www.tine20.com](https://www.tine20.com/) | [GitHub](https://github.com/tine20/tine20) | [Dockerfile](https://github.com/tine20/tine20/blob/main/ci/dockerimage/Dockerfile)

#### Options
| Option | Value | Description |
|---|---|---|
| TINE20_ACCEPTED_TERMS_VERSION | __0__ | Accepted terms version must be the current terms version or newer.
| TINE20_ BUILDTYPE | __PRODUCTION__, DEVELOMENT | Must be set to DEVELOPMENT for webpack to function correctly.
| TINE20_LOGGER_PRIORITY | __5__,0-7 |
| TINE20_FILESDIR | `/var/lib/tine20/files` |
| TINE20_TMPDIR | `/var/lib/tine20/tmp` |
| TINE20_DATABASE_HOST | | mandatory
| TINE20_DATABASE_DBNAME | | mandatory
| TINE20_DATABASE_USERNAME | | mandatory
| TINE20_DATABASE_PASSWORD | | mandatory
| TINE20_DATABASE_TABLEPREFIX | tine20_ |
| TINE20_DATABASE_ADAPTER | __pdo_mysql__ |
| TINE20_SETUPUSER_USERNAME | | mandatory
| TINE20_SETUPUSER_PASSWORD | | mandatory
| TINE20_LOGIN_USERNAME | | mandatory
| TINE20_LOGIN_PASSWORD | | mandatory
| TINE20_CACHING_ACTIVE | __true__, false |
| TINE20_CACHING_LIFETIME | 3600 |
| TINE20_CACHING_BACKEND | __File__, Redis |
| TINE20_CACHING_PATH | `/var/lib/tine20/caching` |
| TINE20_CACHING_REDIS_HOST | | mandatory if TINE20_CACHING_BACKEND == Redis
| TINE20_CACHING_REDIS_POR | 6379 |
| TINE20_CACHING_REDIS_PREFIX | master |
| TINE20_SESSION_LIFETIME | 86400 |
| TINE20_SESSION_BACKEND | __File__,Redis |
| TINE20_SESSION_HOST | `/var/lib/tine20/sessions` |
| TINE20_SESSION_PORT | 6379 |
| TINE20_SESSION_PATH | | mandatory if TINE20_SESSION_BACKEND == Redis
| TINE20_CREDENTIALCACHESCHAREDKEY | | mandatory
| TINE20__* | | All property which can be set with setup.php --setconfig, can also set with TINE20__<app>_<property> or for Tinebase with TINE20__<property>.
| NGINX_CLIENT_MAX_BODY_SIZE | 1m
| NGINX_KEEPALIVE_TIMEOUT | 65
| NGINX_TCP_NOPUSH | off
| NGINX_GZIP | off
| NGINX_GZIP_STATIC | off
| NGINXV_SERVER_NAME | _
| NGINXV_CLIENT_MAX_BODY_SIZE | 24M
| PHPFPM_DYNAMIC | dynamic | should be named pm
| PHPFPM_PM_MAX_CHILDREN | 5
| PHPFPM_PM_START_SERVER | 2
| PHPFPM_PM_MIN_SPARE_SERVERS | 1
| PHPFPM_PM_MAX_SPARE_SERVERS | 3
| PHPFPM_PM_MAX_REQUETS | 500
| PHP_MAX_EXECUTION_TIME | 30
| PHP_MAX_INPUT_TIME | 60
| PHP_MEMORY_LIMIT | 1024M
| PHP_POST_MAX_SIZE | 8M
| PHP_UPLOAD_MAX_FILESIZE |2M
| PHP_MAX_FILE_UPLOADS | 20
| PHP_DEFAULT_SOCKET_TIMEOUT | 60
61 changes: 1 addition & 60 deletions docs/docker/DOCKER-QUICKSTART-DE.md
Expand Up @@ -2,12 +2,6 @@ Tine 2.0 Business Edition Docker Image
---
[www.tine20.com](https://www.tine20.com/) | [GitHub](https://github.com/tine20/tine20) | [Dockerfile](https://github.com/tine20/tine20/blob/main/ci/dockerimage/Dockerfile)

##### Versions
| Tag | Status | Versions |
|---|---|---|
| *2020.11-7.3-alpine* | beta | 2020.11, php 7.3, alpine
| __2019.11-7.3-alpine__ | stable | 2019.11, php 7.3, alpine

### Schnellstart

Dies ist eine schnelle und leichte Möglichkeit, Tine 2.0 auszuprobieren. Hierfür benötigen Sie Docker und Docker Compose (https://docs.docker.com/compose/).
Expand Down Expand Up @@ -100,62 +94,9 @@ Dieses Image enthält den Tine 2.0-Code, PHP-FPM und Nginx. Zusätzlich benötig
#### Path
| Path | Definition |
|---|---|
| `/etc/tine20/config.inc.php` | Tine 2.0's Hauptkonfigurationsdatei.
| `/etc/tine20/config.inc.php` | Tine 2.0 Hauptkonfigurationsdatei.
| `/etc/tine20/conf.d/*` | Tine 2.0 Konfigurationsdateien werden automatisch eingeschlossen.
| `/var/lib/tine20/files` | Speichern der User-Daten. Dateien wie die im Tine 2.0-Dateimanager
| `/var/lib/tine20/tmp` | Temporäre Dateispeicherung
|`/var/lib/tine20/caching` | Wird zum Zwischenspeichern verwendet, wenn `TINE20_CACHING_BACKEND == 'File'`
|`/var/lib/tine20/sessions` | Wird als Sitzungsspeicher verwendet, wenn `TINE20_SESSION_BACKEND == 'File'`

#### Options
| Option | Value | Definition |
|---|---|---|
| TINE20_ACCEPTED_TERMS_VERSION | __0__ | Die Version der akzeptierten Begriffe muss die aktuelle oder neuere Version sein.
| TINE20_ BUILDTYPE | __PRODUCTION__, DEVELOMENT | Muss auf DEVELOMENT eingestellt sein, damit das Webpack ordnungsgemäß funktioniert.
| TINE20_LOGGER_PRIORITY | __5__,0-7 |
| TINE20_FILESDIR | `/var/lib/tine20/files` |
| TINE20_TMPDIR | `/var/lib/tine20/tmp` |
| TINE20_DATABASE_HOST | | verpflichtend
| TINE20_DATABASE_DBNAME | | verpflichtend
| TINE20_DATABASE_USERNAME | | verpflichtend
| TINE20_DATABASE_PASSWORD | | verpflichtend
| TINE20_DATABASE_TABLEPREFIX | tine20_ |
| TINE20_DATABASE_ADAPTER | __pdo_mysql__ |
| TINE20_SETUPUSER_USERNAME | | verpflichtend
| TINE20_SETUPUSER_PASSWORD | | verpflichtend
| TINE20_LOGIN_USERNAME | | verpflichtend
| TINE20_LOGIN_PASSWORD | | verpflichtend
| TINE20_CACHING_ACTIVE | __true__, false |
| TINE20_CACHING_LIFETIME | 3600 |
| TINE20_CACHING_BACKEND | __File__, Redis |
| TINE20_CACHING_PATH | `/var/lib/tine20/caching` |
| TINE20_CACHING_REDIS_HOST | | verpflichtend wenn TINE20_CACHING_BACKEND == Redis
| TINE20_CACHING_REDIS_POR | 6379 |
| TINE20_CACHING_REDIS_PREFIX | master |
| TINE20_SESSION_LIFETIME | 86400 |
| TINE20_SESSION_BACKEND | __File__,Redis |
| TINE20_SESSION_HOST | `/var/lib/tine20/sessions` |
| TINE20_SESSION_PORT | 6379 |
| TINE20_SESSION_PATH | | mandatory if TINE20_SESSION_BACKEND == Redis
| TINE20_CREDENTIALCACHESCHAREDKEY | | verpflichtend
| TINE20__* | | Alle Eigenschaften, die mit setup.php --setconfig festgelegt werden können, können auch mit TINE20__<app>_<property> or for Tinebase with TINE20__<property> festgelegt werden.
| NGINX_CLIENT_MAX_BODY_SIZE | 1m
| NGINX_KEEPALIVE_TIMEOUT | 65
| NGINX_TCP_NOPUSH | off
| NGINX_GZIP | off
| NGINX_GZIP_STATIC | off
| NGINXV_SERVER_NAME | _
| NGINXV_CLIENT_MAX_BODY_SIZE | 24M
| PHPFPM_DYNAMIC | dynamic | sollte pm genannt werden
| PHPFPM_PM_MAX_CHILDREN | 5
| PHPFPM_PM_START_SERVER | 2
| PHPFPM_PM_MIN_SPARE_SERVERS | 1
| PHPFPM_PM_MAX_SPARE_SERVERS | 3
| PHPFPM_PM_MAX_REQUETS | 500
| PHP_MAX_EXECUTION_TIME | 30
| PHP_MAX_INPUT_TIME | 60
| PHP_MEMORY_LIMIT | 1024M
| PHP_POST_MAX_SIZE | 8M
| PHP_UPLOAD_MAX_FILESIZE |2M
| PHP_MAX_FILE_UPLOADS | 20
| PHP_DEFAULT_SOCKET_TIMEOUT | 60
59 changes: 0 additions & 59 deletions docs/docker/DOCKER-QUICKSTART-EN.md
Expand Up @@ -2,12 +2,6 @@ Tine 2.0 Business Edition Docker Image
---
[www.tine20.com](https://www.tine20.com/) | [GitHub](https://github.com/tine20/tine20) | [Dockerfile](https://github.com/tine20/tine20/blob/main/ci/dockerimage/Dockerfile)

##### Versions
| Tag | Status | Versions |
|---|---|---|
| *2020.11-7.3-alpine* | beta | 2020.11, php 7.3, alpine
| __2019.11-7.3-alpine__ | stable | 2019.11, php 7.3, alpine

### Quickstart
This is an easy way to try out tine20. You need Docker and Docker Compose (https://docs.docker.com/compose/).

Expand Down Expand Up @@ -101,56 +95,3 @@ This image contains the Tine 2.0 code, PHP-FPM, and Nginx. Additionally, a datab
| `/var/lib/tine20/tmp` | Temporary file storage
|`/var/lib/tine20/caching` | Used for caching if `TINE20_CACHING_BACKEND == 'File'`
|`/var/lib/tine20/sessions` | Used as session store if `TINE20_SESSION_BACKEND == 'File'`

#### Options
| Option | Value | Description |
|---|---|---|
| TINE20_ACCEPTED_TERMS_VERSION | __0__ | Accepted terms version must be the current terms version or newer.
| TINE20_ BUILDTYPE | __PRODUCTION__, DEVELOMENT | Must be set to DEVELOPMENT for webpack to function correctly.
| TINE20_LOGGER_PRIORITY | __5__,0-7 |
| TINE20_FILESDIR | `/var/lib/tine20/files` |
| TINE20_TMPDIR | `/var/lib/tine20/tmp` |
| TINE20_DATABASE_HOST | | mandatory
| TINE20_DATABASE_DBNAME | | mandatory
| TINE20_DATABASE_USERNAME | | mandatory
| TINE20_DATABASE_PASSWORD | | mandatory
| TINE20_DATABASE_TABLEPREFIX | tine20_ |
| TINE20_DATABASE_ADAPTER | __pdo_mysql__ |
| TINE20_SETUPUSER_USERNAME | | mandatory
| TINE20_SETUPUSER_PASSWORD | | mandatory
| TINE20_LOGIN_USERNAME | | mandatory
| TINE20_LOGIN_PASSWORD | | mandatory
| TINE20_CACHING_ACTIVE | __true__, false |
| TINE20_CACHING_LIFETIME | 3600 |
| TINE20_CACHING_BACKEND | __File__, Redis |
| TINE20_CACHING_PATH | `/var/lib/tine20/caching` |
| TINE20_CACHING_REDIS_HOST | | mandatory if TINE20_CACHING_BACKEND == Redis
| TINE20_CACHING_REDIS_POR | 6379 |
| TINE20_CACHING_REDIS_PREFIX | master |
| TINE20_SESSION_LIFETIME | 86400 |
| TINE20_SESSION_BACKEND | __File__,Redis |
| TINE20_SESSION_HOST | `/var/lib/tine20/sessions` |
| TINE20_SESSION_PORT | 6379 |
| TINE20_SESSION_PATH | | mandatory if TINE20_SESSION_BACKEND == Redis
| TINE20_CREDENTIALCACHESCHAREDKEY | | mandatory
| TINE20__* | | All property which can be set with setup.php --setconfig, can also set with TINE20__<app>_<property> or for Tinebase with TINE20__<property>.
| NGINX_CLIENT_MAX_BODY_SIZE | 1m
| NGINX_KEEPALIVE_TIMEOUT | 65
| NGINX_TCP_NOPUSH | off
| NGINX_GZIP | off
| NGINX_GZIP_STATIC | off
| NGINXV_SERVER_NAME | _
| NGINXV_CLIENT_MAX_BODY_SIZE | 24M
| PHPFPM_DYNAMIC | dynamic | should be named pm
| PHPFPM_PM_MAX_CHILDREN | 5
| PHPFPM_PM_START_SERVER | 2
| PHPFPM_PM_MIN_SPARE_SERVERS | 1
| PHPFPM_PM_MAX_SPARE_SERVERS | 3
| PHPFPM_PM_MAX_REQUETS | 500
| PHP_MAX_EXECUTION_TIME | 30
| PHP_MAX_INPUT_TIME | 60
| PHP_MEMORY_LIMIT | 1024M
| PHP_POST_MAX_SIZE | 8M
| PHP_UPLOAD_MAX_FILESIZE |2M
| PHP_MAX_FILE_UPLOADS | 20
| PHP_DEFAULT_SOCKET_TIMEOUT | 60

0 comments on commit 3f9f921

Please sign in to comment.