]> git.p6c8.net - jirafeau/pcanterino.git/blobdiff - docker/README.md
Updated README
[jirafeau/pcanterino.git] / docker / README.md
index 0ee1a9621d2c29f77d0eba868f22514d164a31d0..77dddd8863f8452bd273c1d2cf6614e756d66882 100644 (file)
@@ -20,6 +20,47 @@ cd Jirafeau
 docker build -t your/jirafeau:latest .
 ```
 
 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:
 ## 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:
 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).
 - `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.
 - `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).
 - `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
 - `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

patrick-canterino.de