docker: update image and usage documentation

Relates to https://github.com/shaarli/Shaarli/issues/1153

Signed-off-by: VirtualTam <virtualtam@flibidi.net>
This commit is contained in:
VirtualTam 2018-06-17 13:45:39 +02:00
parent 2a3fe990dd
commit c064d3179e
2 changed files with 13 additions and 7 deletions

View file

@ -8,7 +8,7 @@ Read first:
### Docker test images ### Docker test images
Test Dockerfiles are located under `docker/tests/<distribution>/Dockerfile`, Test Dockerfiles are located under `tests/docker/<distribution>/Dockerfile`,
and can be used to build Docker images to run Shaarli test suites under common and can be used to build Docker images to run Shaarli test suites under common
Linux environments. Linux environments.
@ -27,7 +27,7 @@ What's behind the curtains:
- test PHP dependencies (OS packages) - test PHP dependencies (OS packages)
- Composer - Composer
- the local workspace is mapped to the container's `/shaarli/` directory, - 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) (running tests as `root` would bypass permission checks and may hide issues)
- the tests are run inside the container. - the tests are run inside the container.
@ -36,7 +36,7 @@ What's behind the curtains:
```bash ```bash
# build the Debian 9 Docker image # build the Debian 9 Docker image
$ cd /path/to/shaarli $ cd /path/to/shaarli
$ cd docker/test/debian9 $ cd tests/docker/debian9
$ docker build -t shaarli-test:debian9 . $ docker build -t shaarli-test:debian9 .
``` ```

View file

@ -8,9 +8,9 @@ The images can be found in the [`shaarli/shaarli`](https://hub.docker.com/r/shaa
repository. repository.
### Available image tags ### Available image tags
- `latest`: latest branch (tarball release) - `latest`: latest branch
- `master`: master branch (tarball release) - `master`: master branch
- `stable`: stable branch (tarball release) - `stable`: stable branch
The `latest` and `master` images rely on: The `latest` and `master` images rely on:
@ -24,7 +24,13 @@ The `stable` image relies on:
- [PHP5-FPM](http://php-fpm.org/) - [PHP5-FPM](http://php-fpm.org/)
- [Nginx](http://nginx.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 ### Download from DockerHub
```bash ```bash