X-Git-Url: https://git.p6c8.net/jirafeau_project.git/blobdiff_plain/071702bff9dacc7269d3726eb61cf20238e64d23..b269224a37d80a40ef609bf5a8e4ed2e8ab2838d:/docker/README.md?ds=inline diff --git a/docker/README.md b/docker/README.md index 10ee322..cf70ec8 100644 --- a/docker/README.md +++ b/docker/README.md @@ -20,6 +20,41 @@ cd Jirafeau docker build -t your/jirafeau:latest . ``` +## Docker Compose + +You can use the `docker-compose.yaml` from [here](../docker-compose.yaml) + +### Custom Theme + +1. copy the theme data from the running container + + ```sh + docker compose cp web:/www/media jirafeau_media + ``` + +2. mount the theme data + + ```yaml + #.... + volumes: + - ./jirafeau_media/your_theme:/www/media/your_theme + ``` + +3. set the environment variable + + ```yaml + # .... + environment: + STYLE: 'your_theme' + DARK_STYLE: 'your_theme' + ``` + +4. run the compose file + + ```sh + docker compose up -d + ``` + ## Security You may be interested in running Jirafeau on port 80: @@ -36,8 +71,11 @@ Jirafeau's docker image accepts some options through environment variables to ea More details about options in `lib/config.original.php`. Available options: + - `ADMIN_PASSWORD`: setup a specific admin password. If not set, a random password will be generated. - `ADMIN_IP`: set one or more ip allowed to access admin interface (separated by comma). +- `LANG`: choose the language for jirafeau (default auto). +- `AVAILABILITIES`: change the array for availablibilities that the user can select (see `docker-compose.yaml` for an example how to do that). Availability is the time the file should be available before it can be deleted. - `WEB_ROOT`: setup a specific domain to point at when generating links (e.g. 'jirafeau.mydomain.com/'). - `VAR_ROOT`: setup a specific path where to place files. default: '/data'. - `FILE_HASH`: can be set to `md5`, `partial_md5` or `random` (default).