Copied information about Docker from README files from next-release to master

[jirafeau.git] / docker / README.md

diff --git a/docker/README.md b/docker/README.md
index 8d367ea48dffb456855f48a17f084516dbeb66e4..8252795c297303e679b4421fe9f8e9e649bd501f 100644 (file)
--- a/docker/README.md
+++ b/docker/README.md
@@ -1,24 +1,26 @@
-# Run Jirafeau through a pre-made Docker image
+# Jirafeau's Docker image
+
+## Run Jirafeau through a pre-made Docker image
 
 Jirafeau is a small PHP application so running it inside a docker container is pretty straightforward.
 
 ```
-docker pull mojo42/jirafeau:latest
-docker run -it --rm -p 8080:80 mojo42/jirafeau:latest
+docker pull registry.gitlab.com/jirafeau/jirafeau:latest
+docker run -it --rm -p 8080:80 registry.gitlab.com/jirafeau/jirafeau:latest
 ```
 
 Then connect on [localhost:8080](http://localhost:8080/).
 The admin console is located on `/admin.php`, check console output to get auto-generated admin password.
 
-# Build your own Jirafeau docker image
+## Build your own Jirafeau docker image
 
 ```
-git clone https://gitlab.com/mojo42/Jirafeau.git
+git clone https://gitlab.com/jirafeau/Jirafeau.git
 cd Jirafeau
 docker build -t your/jirafeau:latest .
 ```
 
-# Security
+## Security
 
 You may be interested in running Jirafeau on port 80:
 ```
@@ -27,13 +29,14 @@ docker run -d -p 80:80 --sysctl net.ipv4.ip_unprivileged_port_start=80 mojo42/ji
 
 Note that Jirafeau image does not provide any SSL/TLS. You may be interested in using [docker compose](https://docs.docker.com/compose/) combined with [Let's Encrypt](https://letsencrypt.org/).
 
-# Options
+## Options
 
 Jirafeau's docker image accepts some options through environment variables to ease its configuration.
 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).
 - `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).
@@ -41,7 +44,8 @@ Available options:
 - `TITLE`: set Jirafeau instance title.
 - `ORGANISATION`: set organisation (in ToS).
 - `CONTACTPERSON`: set contact person (in ToS).
-- `STYLE`: apply a specific style.
+- `STYLE`: apply a specific style from the media folder.
+- `DARK_STYLE`: apply a specific style for browsers in dark mode.
 - `AVAILABILITY_DEFAULT`: setup which availability shows by default.
 - `ONE_TIME_DOWNLOAD`: set to 1 or 0 to enable or disable one time downloads.
 - `ENABLE_CRYPT`: set to 1 or 0 to enable or disable server side encryption.
@@ -63,9 +67,9 @@ Example:
 docker run -it -p 8080:80 --rm -e ADMIN_PASSWORD='p4ssw0rd' -e WEB_ROOT='jirafeau.mydomain.com/' -e UPLOAD_PASSWORD='foo,bar' -e PREVIEW=0  mojo42/jirafeau:latest
 ```
 
-# Data Storage
+## Data storage
 
-Files and links are stored in `/data` by default. Sub folders are automatically created with needed permissions at creation if needed.
+Files and links are stored in `/data` by default. Subfolders are automatically created with needed permissions at creation if needed.
 Note that configuration is not stored in /data.
 
 Example of using a dedicated volume to store Jirafeau data separately from the container: