Signed-off-by: Jerome Jutteau <jerome@jutteau.fr>
+# Run Jirafeau through a pre-made Docker image
Jirafeau is a small PHP application so running it inside a docker is pretty straightforward.
Jirafeau is a small PHP application so running it inside a docker is pretty straightforward.
-## Get Jirafeau's docker image
-
-### Pull docker image from Docker Hub
+```
+docker pull mojo42/jirafeau:latest
+docker run -d -p 8080:80 mojo42/jirafeau:latest
+```
-`docker pull mojo42/jirafeau`
+Then connect on [locahost:8080](http://localhost:8080/).
-### Build your own docker image
+# Build your own Jirafeau docker image
```
git clone https://gitlab.com/mojo42/Jirafeau.git
cd Jirafeau
```
git clone https://gitlab.com/mojo42/Jirafeau.git
cd Jirafeau
-docker build -t mojo42/jirafeau:latest .
-```
-
-## Run Jirafeau image
-
-Once you have your Jirafeau's image, you can run a quick & dirty Jirafeau using:
-```
-docker run -d -p 8080:80 mojo42/jirafeau
+docker build -t your/jirafeau:latest .
-and then connect on [locahost:8080](http://localhost:8080/) and proceed to installation.
Jirafeau is run without privilidges with user id 2009. To make it able to open privilidged ports you can pass the capability, just stay with 8080 and use a reverse proxy or map the port 80:8080.
```
Jirafeau is run without privilidges with user id 2009. To make it able to open privilidged ports you can pass the capability, just stay with 8080 and use a reverse proxy or map the port 80:8080.
```
Note that Jirafeau image does not provide any SSL/TLS. You may be interrested in using [docker compose](https://docs.docker.com/compose/) combined with [Let's Encrypt](https://letsencrypt.org/).
Note that Jirafeau image does not provide any SSL/TLS. You may be interrested in using [docker compose](https://docs.docker.com/compose/) combined with [Let's Encrypt](https://letsencrypt.org/).
Jirafeau docker image accept some options through environment variables to ease its configuration.
More details about options in `lib/config.original.php`.
Jirafeau docker image accept some options through environment variables to ease its configuration.
More details about options in `lib/config.original.php`.