From: VirtualTam Date: Sun, 17 Jun 2018 11:45:39 +0000 (+0200) Subject: docker: update image and usage documentation X-Git-Tag: v0.10.0~19^2 X-Git-Url: https://git.immae.eu/?p=github%2Fshaarli%2FShaarli.git;a=commitdiff_plain;h=c064d3179e0396983bdf8dee545388e4142ed842 docker: update image and usage documentation Relates to https://github.com/shaarli/Shaarli/issues/1153 Signed-off-by: VirtualTam --- diff --git a/doc/md/Unit-tests-Docker.md b/doc/md/Unit-tests-Docker.md index c2de7cc7..59bd5b45 100644 --- a/doc/md/Unit-tests-Docker.md +++ b/doc/md/Unit-tests-Docker.md @@ -8,7 +8,7 @@ Read first: ### Docker test images -Test Dockerfiles are located under `docker/tests//Dockerfile`, +Test Dockerfiles are located under `tests/docker//Dockerfile`, and can be used to build Docker images to run Shaarli test suites under common Linux environments. @@ -27,7 +27,7 @@ What's behind the curtains: - test PHP dependencies (OS packages) - Composer - the local workspace is mapped to the container's `/shaarli/` directory, -- the files are rsync'd to so tests are run using a standard Linux user account +- the files are rsync'd so tests are run using a standard Linux user account (running tests as `root` would bypass permission checks and may hide issues) - the tests are run inside the container. @@ -36,7 +36,7 @@ What's behind the curtains: ```bash # build the Debian 9 Docker image $ cd /path/to/shaarli -$ cd docker/test/debian9 +$ cd tests/docker/debian9 $ docker build -t shaarli-test:debian9 . ``` diff --git a/doc/md/docker/shaarli-images.md b/doc/md/docker/shaarli-images.md index 12f7b5d1..e6fbff64 100644 --- a/doc/md/docker/shaarli-images.md +++ b/doc/md/docker/shaarli-images.md @@ -8,9 +8,9 @@ The images can be found in the [`shaarli/shaarli`](https://hub.docker.com/r/shaa repository. ### Available image tags -- `latest`: latest branch (tarball release) -- `master`: master branch (tarball release) -- `stable`: stable branch (tarball release) +- `latest`: latest branch +- `master`: master branch +- `stable`: stable branch The `latest` and `master` images rely on: @@ -24,7 +24,13 @@ The `stable` image relies on: - [PHP5-FPM](http://php-fpm.org/) - [Nginx](http://nginx.org/) -Additional [Dockerfiles](https://github.com/shaarli/Shaarli/tree/master/docker) are provided for the `arm32v7` platform, relying on [Linuxserver.io Alpine armhf images](https://hub.docker.com/r/lsiobase/alpine.armhf/). These images must be built using [`docker build`](https://docs.docker.com/engine/reference/commandline/build/) on an `arm32v7` machine or using an emulator such as [qemu](https://resin.io/blog/building-arm-containers-on-any-x86-machine-even-dockerhub/). +Additional Dockerfiles are provided for the `arm32v7` platform, relying on +[Linuxserver.io Alpine armhf +images](https://hub.docker.com/r/lsiobase/alpine.armhf/). These images must be +built using [`docker +build`](https://docs.docker.com/engine/reference/commandline/build/) on an +`arm32v7` machine or using an emulator such as +[qemu](https://resin.io/blog/building-arm-containers-on-any-x86-machine-even-dockerhub/). ### Download from DockerHub ```bash