X-Git-Url: https://git.p6c8.net/jirafeau/pcanterino.git/blobdiff_plain/b33335fdd70b6d414a7d609e2f62a499b50c872f..e89ffa8b97e5bd2dcfe08db4f8944690629f3ced:/docker/README.md?ds=sidebyside diff --git a/docker/README.md b/docker/README.md index 0ee1a96..77dddd8 100644 --- a/docker/README.md +++ b/docker/README.md @@ -20,6 +20,47 @@ cd Jirafeau docker build -t your/jirafeau:latest . ``` +## Docker Compose + +You can use the `docker-compose.yaml` from [here](../docker-compose.yaml) + +### Run Container + +```sh +docker compose up -d +``` + +### 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,6 +77,7 @@ 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). @@ -54,11 +96,13 @@ Available options: - `ONE_TIME_DOWNLOAD_PRESELECTED`: set to 1 or 0 to preselect the checkbox for one time downloads. - `ENABLE_CRYPT`: set to 1 or 0 to enable or disable server side encryption. - `DEBUG`: set to 1 or 0 to enable or disable debug mode. +- `DEBUG_ENFORCE_CLASSIC_UPLOAD`: set to 1 or 0 to enforce the classic (synchronous) file upload mechanism. - `MAXIMAL_UPLOAD_SIZE`: maximal file size allowed (expressed in MB). - `UPLOAD_PASSWORD`: set one or more passwords to access Jirafeau (separated by comma). - `UPLOAD_IP`: set one or more ip allowed to upload files (separated by comma). - `UPLOAD_IP_NO_PASSWORD`: set one or more ip allowed to upload files without password (separated by comma). - `PROXY_IP`: set one or more proxy ip (separated by comma). +- `DISALLOWED_EXTENSIONS`: forbid specific file extensions from being uploaded (separated by comma). - `STORE_UPLOADER_IP`: set to 1 or 0 to enable or disable keeping sender's IP with the _link_ file. - `DOWNLOAD_PASSWORD_REQUIREMENT`: set to 'optional' (default), 'required' or 'generated' to make a password for downloading optional, required or generated - `DOWNLOAD_PASSWORD_GEN_LEN`: set length of generated download passwords