Commit cea336de authored by Michał 'rysiek' Woźniak's avatar Michał 'rysiek' Woźniak
Browse files

readme documents the entrypoint script environment variables now

parent beaf5239
...@@ -2,6 +2,47 @@ ...@@ -2,6 +2,47 @@
This is a dockerized [Uniqush](https://uniqush.org/) setup. This [Debian](https://www.debian.org/)-based image only contains Uniqush -- as per docker philosophy, a `redis` server has to be run separately; the [`redis` docker image](https://hub.docker.com/_/redis/) might be a good choice. This is a dockerized [Uniqush](https://uniqush.org/) setup. This [Debian](https://www.debian.org/)-based image only contains Uniqush -- as per docker philosophy, a `redis` server has to be run separately; the [`redis` docker image](https://hub.docker.com/_/redis/) might be a good choice.
## Configuration ## Configuration and operation
*TBD* By default `$UNIQUSH_USER` is created with with `$UNIQUSH_UID` (if provided), in `$UNIQUSH_GROUP` with `$UNIQUSH_GID` (if provided); `/usr/bin/uniqush-push` daemon is then run as this user and group.
\ No newline at end of file
A configuration file is created only if there is no [uniqush config file](https://uniqush.org/documentation/config.html) present in `/etc/uniqush/uniqush-push.conf/` (for instance, by volume-mounting it into the container). This configuration file is created based on the values of environment variables documented below.
## Environment variables
- `UNIQUSH_USER` (default: `uniqush`)
- `UNIQUSH_UID`
The user (and optionally `uid`) to run `uniqush-push` daemon as. If the user does not exist, it will be created (with `$UNIQUSH_UID` as `uid`, if provided; first available `uid` otherwise), and will be put in `$UNIQUSH_GROUP` group.
If both `$UNIQUSH_USER` and `$UNIQUSH_UID` are provided, and there is an existing user with `$UNIQUSH_USER`, with a different `uid`, the startup script will fail with an error.
- `UNIQUSH_GROUP` (default: `uniqush`)
- `UNIQUSH_GID`
The group to run the `uniqush-push` daemon. If the group does not exist, it will be created (with `$UNIQUSH_GID` as `gid`, if provided; first available `gid` otherwise).
If both `$UNIQUSH_GROUP` and `$UNIQUSH_GID` are provided, and there is an existing user with `$UNIQUSH_GROUP`, but with a different `gid`, the startup script will fail with an error.
- `UNIQUSH_LOGFILE` (default: `/var/log/uniqush`)
Path to the logfile.
- `UNIQUSH_LOGLEVEL` (default: `standard`)
The loglevel to use in all sections of the created config file. Valid values are `off`, `standard`, `verbose`. The `off` value sets also the `log` option to `off`; remaining options set it to `on`.
- `UNIQUSH_WEBFRONTEND_ADDR` (default: `0.0.0.0:9898`)
The address (`IP`:`port`) the webfrontend should listen for connections on. By default listening on all interfaces -- since it'ss going to be run within a docker container, `localhost` would not be accessible from outside of it at all.
- `UNIQUSH_DATABASE_ENGINE` (default: `redis`)
- `UNIQUSH_DATABASE_NAME` (default: `uniqush`)
- `UNIQUSH_DATABASE_HOST` (default: `redis`)
- `UNIQUSH_DATABASE_PORT` (default `0`)
- `UNIQUSH_DATABASE_PASSWORD` (default: empty string)
- `UNIQUSH_DATABASE_EVERYSEC` (default: `600`)
- `UNIQUSH_DATABASE_LEASTDIRTY` (default: `10`)
- `UNIQUSH_DATABASE_CACHESIZE` (default: `1024`)
Settings used in the `Database` section of the configuration file. Consult [Uniqush configuration documentation](https://uniqush.org/documentation/config.html) for further information. Probably the most important one is `UNIQUSH_DATABASE_HOST`, useful for telling `uniqush-push` where a Redis server is available.
\ No newline at end of file
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment