X-Git-Url: https://git.p6c8.net/jirafeau.git/blobdiff_plain/8d680388c6ee5495386a31ea22d794df26d5c910..3529495482bde49c353d7338c81b8dc8fbae197a:/docker/README.md diff --git a/docker/README.md b/docker/README.md index 4407ae8..33c9fc0 100644 --- a/docker/README.md +++ b/docker/README.md @@ -1,33 +1,36 @@ -# 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 +```shell +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 -``` +```shell 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: -``` -docker run -d -p 80:80 --sysctl net.ipv4.ip_unprivileged_port_start=80 mojo42/jirafeau + +```shell +docker run -d -p 80:80 --sysctl net.ipv4.ip_unprivileged_port_start=80 registry.gitlab.com/jirafeau/jirafeau ``` 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`. @@ -61,19 +64,29 @@ Available options: - `DOWNLOAD_PASSWORD_POLICY_REGEX`: regex to check against if password policy is set to regex 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 + +```shell +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 registry.gitlab.com/jirafeau/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: -``` + +```shell docker volume create jirafeau_data -docker run -it --rm -p 8080:80 --mount source=jirafeau_data,target=/data mojo42/jirafeau:latest +docker run -it --rm -p 8080:80 --mount source=jirafeau_data,target=/data registry.gitlab.com/jirafeau/jirafeau:latest +``` + +It is also possible to put Jirafeau data into an already existing directory outside the container: + +```shell +mkdir /tmp/jirafeau_data +docker run -it --rm -p 8080:80 -v /tmp/jirafeau_data:/data registry.gitlab.com/jirafeau/jirafeau:latest + ``` ## Few notes