53ed6d7d1e
MkDocs is a static site generator geared towards building project documentation. Documentation source files are written in Markdown, and configured with a single YAML file. * http://www.mkdocs.org/ * http://www.mkdocs.org/user-guide/configuration/ Ref. #312 * remove pandoc-generated HTML documentation * move markdown doc to doc/md/, * mkdocs.yml: * generate HTML doc in doc/html * add pages TOC/ordering * use index.md as index page * Makefile: remove execute permissions from generated files * Makefile: rewrite htmlpages GFM to markdown conversion using sed: awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks * Add mkdocs.yml to .gitattributes, exclude this file from release archives * Makefile: rename: htmldoc -> doc_html target * run make doc: pull latest markdown documentation from wiki * run make htmlpages: update html documentation
73 lines
2.5 KiB
Markdown
73 lines
2.5 KiB
Markdown
## Get and run a Shaarli image
|
|
|
|
### DockerHub repository
|
|
The images can be found in the [`shaarli/shaarli`](https://hub.docker.com/r/shaarli/shaarli/)
|
|
repository.
|
|
|
|
### Available image tags
|
|
- `latest`: master branch (tarball release)
|
|
- `stable`: stable branch (tarball release)
|
|
- `dev`: master branch (Git clone)
|
|
|
|
All images rely on:
|
|
- [Debian 8 Jessie](https://hub.docker.com/_/debian/)
|
|
- [PHP5-FPM](http://php-fpm.org/)
|
|
- [Nginx](http://nginx.org/)
|
|
|
|
### Download from DockerHub
|
|
```bash
|
|
$ docker pull shaarli/shaarli
|
|
latest: Pulling from shaarli/shaarli
|
|
32716d9fcddb: Pull complete
|
|
84899d045435: Pull complete
|
|
4b6ad7444763: Pull complete
|
|
e0345ef7a3e0: Pull complete
|
|
5c1dd344094f: Pull complete
|
|
6422305a200b: Pull complete
|
|
7d63f861dbef: Pull complete
|
|
3eb97210645c: Pull complete
|
|
869319d746ff: Already exists
|
|
869319d746ff: Pulling fs layer
|
|
902b87aaaec9: Already exists
|
|
Digest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98
|
|
Status: Downloaded newer image for shaarli/shaarli:latest
|
|
```
|
|
|
|
### Create and start a new container from the image
|
|
```bash
|
|
# map the host's :8000 port to the container's :80 port
|
|
$ docker create -p 8000:80 shaarli/shaarli
|
|
d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
|
|
|
|
# launch the container in the background
|
|
$ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
|
|
d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
|
|
|
|
# list active containers
|
|
$ docker ps
|
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
|
d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000->80/tcp backstabbing_galileo
|
|
```
|
|
|
|
### Stop and destroy a container
|
|
```bash
|
|
$ docker stop backstabbing_galileo # those docker guys are really rude to physicists!
|
|
backstabbing_galileo
|
|
|
|
# check the container is stopped
|
|
$ docker ps
|
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
|
|
|
# list ALL containers
|
|
$ docker ps -a
|
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
|
d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) 48 seconds ago backstabbing_galileo
|
|
|
|
# destroy the container
|
|
$ docker rm backstabbing_galileo # let's put an end to these barbarian practices
|
|
backstabbing_galileo
|
|
|
|
$ docker ps -a
|
|
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
|
|
```
|