aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md/Shaarli-images.md
diff options
context:
space:
mode:
authornodiscc <nodiscc@gmail.com>2017-01-26 18:52:54 +0100
committernodiscc <nodiscc@gmail.com>2017-06-18 00:19:49 +0200
commit53ed6d7d1e678d7486337ce67a2f17b30bac21ac (patch)
treef8bef0164a70bd03d2b9781951c01bdd018f1842 /doc/md/Shaarli-images.md
parentd5d22a6d07917865c44148ad76f43c65a929a890 (diff)
downloadShaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.gz
Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.tar.zst
Shaarli-53ed6d7d1e678d7486337ce67a2f17b30bac21ac.zip
Generate HTML documentation using MkDocs (WIP)
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
Diffstat (limited to 'doc/md/Shaarli-images.md')
-rw-r--r--doc/md/Shaarli-images.md72
1 files changed, 72 insertions, 0 deletions
diff --git a/doc/md/Shaarli-images.md b/doc/md/Shaarli-images.md
new file mode 100644
index 00000000..25f6cfdd
--- /dev/null
+++ b/doc/md/Shaarli-images.md
@@ -0,0 +1,72 @@
1## Get and run a Shaarli image
2
3### DockerHub repository
4The images can be found in the [`shaarli/shaarli`](https://hub.docker.com/r/shaarli/shaarli/)
5repository.
6
7### Available image tags
8- `latest`: master branch (tarball release)
9- `stable`: stable branch (tarball release)
10- `dev`: master branch (Git clone)
11
12All images rely on:
13- [Debian 8 Jessie](https://hub.docker.com/_/debian/)
14- [PHP5-FPM](http://php-fpm.org/)
15- [Nginx](http://nginx.org/)
16
17### Download from DockerHub
18```bash
19$ docker pull shaarli/shaarli
20latest: Pulling from shaarli/shaarli
2132716d9fcddb: Pull complete
2284899d045435: Pull complete
234b6ad7444763: Pull complete
24e0345ef7a3e0: Pull complete
255c1dd344094f: Pull complete
266422305a200b: Pull complete
277d63f861dbef: Pull complete
283eb97210645c: Pull complete
29869319d746ff: Already exists
30869319d746ff: Pulling fs layer
31902b87aaaec9: Already exists
32Digest: sha256:f836b4627b958b3f83f59c332f22f02fcd495ace3056f2be2c4912bd8704cc98
33Status: Downloaded newer image for shaarli/shaarli:latest
34```
35
36### Create and start a new container from the image
37```bash
38# map the host's :8000 port to the container's :80 port
39$ docker create -p 8000:80 shaarli/shaarli
40d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
41
42# launch the container in the background
43$ docker start d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
44d40b7af693d678958adedfb88f87d6ea0237186c23de5c4102a55a8fcb499101
45
46# list active containers
47$ docker ps
48CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
49d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 15 seconds ago Up 4 seconds 0.0.0.0:8000->80/tcp backstabbing_galileo
50```
51
52### Stop and destroy a container
53```bash
54$ docker stop backstabbing_galileo # those docker guys are really rude to physicists!
55backstabbing_galileo
56
57# check the container is stopped
58$ docker ps
59CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
60
61# list ALL containers
62$ docker ps -a
63CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
64d40b7af693d6 shaarli/shaarli /usr/bin/supervisor 5 minutes ago Exited (0) 48 seconds ago backstabbing_galileo
65
66# destroy the container
67$ docker rm backstabbing_galileo # let's put an end to these barbarian practices
68backstabbing_galileo
69
70$ docker ps -a
71CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
72```