Merge pull request #2099 from nupplaphil/friendica
Friendica: Update doc
This commit is contained in:
commit
19ec6e3732
|
|
@ -54,12 +54,16 @@ Friendica requires background tasks to fetch and send all kind of messages and m
|
||||||
- `FRIENDICA_NO_VALIDATION` If set to `true`, the URL and E-Mail validation will be disabled.
|
- `FRIENDICA_NO_VALIDATION` If set to `true`, the URL and E-Mail validation will be disabled.
|
||||||
- `FRIENDICA_DATA` Set the name of the storage provider (e.g `Filesystem` to use filesystem), default ist the DB backend.
|
- `FRIENDICA_DATA` Set the name of the storage provider (e.g `Filesystem` to use filesystem), default ist the DB backend.
|
||||||
- `FRIENDICA_DATA_DIR` The data directory of the Friendica server (Default: /var/www/data).
|
- `FRIENDICA_DATA_DIR` The data directory of the Friendica server (Default: /var/www/data).
|
||||||
|
- `FRIENDICA_UPDATE` Force starting the Friendica update even it's the same version (Default: `false`).
|
||||||
|
|
||||||
**Friendica Logging**
|
**Friendica Logging**
|
||||||
|
|
||||||
- `FRIENDICA_DEBUGGING` If set to `true`, the logging of Friendica is enabled.
|
- `FRIENDICA_DEBUGGING` If set to `true`, the logging of Friendica is enabled.
|
||||||
- `FRIENDICA_LOGFILE` (optional) The path to the logfile (Default: /var/www/friendica.log).
|
- `FRIENDICA_LOGFILE` (optional) The path to the logfile (Default: /var/www/friendica.log).
|
||||||
- `FRIENDICA_LOGLEVEL` (optional) The loglevel to log (Default: notice).
|
- `FRIENDICA_LOGLEVEL` (optional) The loglevel to log (Default: notice).
|
||||||
|
- `FRIENDICA_LOGGER` (optional) Set the type - stream, syslog, monolog (Default: stream).
|
||||||
|
- `FRIENDICA_SYSLOG_FLAGS` (optional) In case syslog is used, set the corresponding flags (Default: `LOG_PID | LOG_ODELAY | LOG_CONS | LOG_PERROR`).
|
||||||
|
- `FRIENDICA_SYSLOG_FACTORY` (optional) In case syslog is used, set the corresponding factory (Default: `LOG_USER`).
|
||||||
|
|
||||||
**Database** (**required at installation**)
|
**Database** (**required at installation**)
|
||||||
|
|
||||||
|
|
@ -76,6 +80,11 @@ Friendica requires background tasks to fetch and send all kind of messages and m
|
||||||
- `REDIS_PW` (optional) The password for the redis instance (in case of locking).
|
- `REDIS_PW` (optional) The password for the redis instance (in case of locking).
|
||||||
- `REDIS_DB` (optional) The database instance of the redis instance (in case of locking).
|
- `REDIS_DB` (optional) The database instance of the redis instance (in case of locking).
|
||||||
|
|
||||||
|
**PHP limits**
|
||||||
|
|
||||||
|
- `PHP_MEMORY_LIMIT` (default `512M`) This sets the maximum amount of memory in bytes that a script is allowed to allocate. This is meant to help prevent poorly written scripts from eating up all available memory, but it can prevent normal operation if set too tight.
|
||||||
|
- `PHP_UPLOAD_LIMIT` (default `512M`) This sets the upload limit (`post_max_size` and `upload_max_filesize`) for big files. Note that you may have to change other limits depending on your client, webserver or operating system.
|
||||||
|
|
||||||
## Administrator account
|
## Administrator account
|
||||||
|
|
||||||
Because Friendica links the administrator account to a specific mail address, you **have** to set a valid address for `MAILNAME`.
|
Because Friendica links the administrator account to a specific mail address, you **have** to set a valid address for `MAILNAME`.
|
||||||
|
|
@ -324,25 +333,7 @@ Then run `docker-compose up -d`, now you can access Friendica at http://localhos
|
||||||
|
|
||||||
# Special settings for DEV/RC images
|
# Special settings for DEV/RC images
|
||||||
|
|
||||||
The `*-dev` and `*-rc` branches are having additional possibilities to get the latest sources of Friendica.
|
The `*-dev` and `*-rc` branches are directly downloaded and verified at each docker start to ensure that the latest sources are used. The parameter `FRIENDICA_UPGRADE` is required to be `true` (Default: `false`) to activate this behavior.
|
||||||
|
|
||||||
## Possible Environment Variables
|
|
||||||
|
|
||||||
The following environment variables are possible for these kind of images too:
|
|
||||||
|
|
||||||
**Develop/Release Candidate Settings**
|
|
||||||
|
|
||||||
- `FRIENDICA_UPGRADE` If set to `true`, a develop or release candidat node will get updated at startup.
|
|
||||||
- `FRIENDICA_REPOSITORY` If set, a custom repository will be chosen (Default: `friendica`)
|
|
||||||
- `FRIENDICA_ADDONS_REPO` If set, a custom repository for the addons will be chosen (Default: `friendica`)
|
|
||||||
- `FRIENDICA_VERSION` If set, a custom branch will be chosen (Default is based on the chosen image version)
|
|
||||||
- `FRIENDICA_ADDONS` If set, a custom branch for the addons will be chosen (Default is based on the chosen image version)
|
|
||||||
|
|
||||||
## Updating to a newer version
|
|
||||||
|
|
||||||
You don't need to pull the image for each commit in [friendica](https://github.com/friendica/friendica/). Instead, the release candidate or develop branch will get updated if no installation was found or the environment variable `FRIENDICA_UPGRADE` is set to `true`.
|
|
||||||
|
|
||||||
It will clone the latest Friendica version and copy it to your working directory.
|
|
||||||
|
|
||||||
# Questions / Issues
|
# Questions / Issues
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue