aboutsummaryrefslogtreecommitdiffhomepage
path: root/doc/md
diff options
context:
space:
mode:
authorB. van Berkum <dev@dotmpe.com>2017-10-03 00:33:39 +0200
committerB. van Berkum <dev@dotmpe.com>2017-10-03 00:35:27 +0200
commit60ed9b8f4142e99114661b5b8a5562aa75bffb48 (patch)
tree6d974f8a35e013253afe0a4a140a7b2ff84d15f7 /doc/md
parent22a30602cb31f9b1e36aabae4259561625b7ffe3 (diff)
downloadShaarli-60ed9b8f4142e99114661b5b8a5562aa75bffb48.tar.gz
Shaarli-60ed9b8f4142e99114661b5b8a5562aa75bffb48.tar.zst
Shaarli-60ed9b8f4142e99114661b5b8a5562aa75bffb48.zip
Typo's, unified structure a bit.
- Fixes inevitable typo that crept in. - Removed some blank lines, newlines, to match established whitespace use better. - Minor grammar improvement.
Diffstat (limited to 'doc/md')
-rw-r--r--doc/md/docker/docker-101.md12
-rw-r--r--doc/md/index.md3
2 files changed, 5 insertions, 10 deletions
diff --git a/doc/md/docker/docker-101.md b/doc/md/docker/docker-101.md
index d12a1324..271dcd5b 100644
--- a/doc/md/docker/docker-101.md
+++ b/doc/md/docker/docker-101.md
@@ -61,16 +61,14 @@ Digest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe
61Status: Downloaded newer image for debian:wheezy 61Status: Downloaded newer image for debian:wheezy
62``` 62```
63 63
64Docker re-uses layers already downloaded. Iow. if you have only images based on some Alpine or Ubuntu version for example, those can share disk space. 64Docker re-uses layers already downloaded. Iow. if you have images based only Alpine or some Ubuntu version for example, those can share disk space.
65 65
66### Start a container 66### Start a container
67A container is an instance created from an image, that can be run and that keeps running until its main process exits. Or until the user stops the container. 67A container is an instance created from an image, that can be run and that keeps running until its main process exits. Or until the user stops the container.
68 68
69The simplest way to start a container from image is ``docker run``. It also pulls the image for you if it is not locally available. For more advanced use, refer to ``docker create``. 69The simplest way to start a container from image is ``docker run``. It also pulls the image for you if it is not locally available. For more advanced use, refer to ``docker create``.
70 70
71Note that stopped containers are not destroyed, unless you specify ``--rm``. 71Note that stopped containers are not destroyed, unless you specify ``--rm``. To view all created, running and stopped containers, enter:
72To view all created, running and stopped containers, enter:
73
74```bash 72```bash
75$ docker ps -a 73$ docker ps -a
76``` 74```
@@ -78,8 +76,7 @@ $ docker ps -a
78Some containers may be designed or configured to be restarted, others are not. Note that both network ports and volumes of a container are created on start, and not editable later. 76Some containers may be designed or configured to be restarted, others are not. Note that both network ports and volumes of a container are created on start, and not editable later.
79 77
80### Access a running container 78### Access a running container
81A running container is accessible using ``docker exec``, or ``docker copy``. 79A running container is accessible using ``docker exec``, or ``docker copy``. You can use ``exec`` to start a root shell in the Shaarli container:
82You can use ``exec`` to start a root shell in the Shaarli container:
83```bash 80```bash
84$ docker exec -ti <container-name-or-id> bash 81$ docker exec -ti <container-name-or-id> bash
85``` 82```
@@ -90,8 +87,7 @@ Access can also be through one or more network ports, or disk volumes. Both are
90### Docker disk use 87### Docker disk use
91Trying out different images can fill some gigabytes of disk quickly. Besides images, the docker volumes usually take up most disk space. 88Trying out different images can fill some gigabytes of disk quickly. Besides images, the docker volumes usually take up most disk space.
92 89
93If you care only about trying out docker and not about what is running or saved, 90If you care only about trying out docker and not about what is running or saved, the following commands should help you out quickly:
94the following commands should help you out quickly:
95 91
96```bash 92```bash
97$ docker rmi -f $(docker images -aq) # remove or mark all images for disposal 93$ docker rmi -f $(docker images -aq) # remove or mark all images for disposal
diff --git a/doc/md/index.md b/doc/md/index.md
index 5f10227f..f83d1702 100644
--- a/doc/md/index.md
+++ b/doc/md/index.md
@@ -22,7 +22,7 @@ It runs the latest development version of Shaarli and is updated/reset daily.
22 22
23Login: `demo`; Password: `demo` 23Login: `demo`; Password: `demo`
24 24
25Docker users can start a personal instance from an [autobuild image](https://hub.docker.com/r/shaarli/shaarli/). For an example to start a temporary Shaarli at ``localhost:8000``, and to keeps the data you create (config, storage) during the session: 25Docker users can start a personal instance from an [autobuild image](https://hub.docker.com/r/shaarli/shaarli/). For an example to start a temporary Shaarli at ``localhost:8000``, and keep the data you create (config, storage) during the session:
26``` 26```
27MY_SHAARLI_VOLUME=$(cd /path/to/shaarli/data/ && pwd -P) 27MY_SHAARLI_VOLUME=$(cd /path/to/shaarli/data/ && pwd -P)
28docker run -ti --rm \ 28docker run -ti --rm \
@@ -32,7 +32,6 @@ docker run -ti --rm \
32``` 32```
33 33
34A brief guide on getting starting using docker is given in [Docker 101](docker/docker-101). 34A brief guide on getting starting using docker is given in [Docker 101](docker/docker-101).
35
36To learn more about user data and how to keep it across versions, please see [Upgrade and Migration](Upgrade-and-migration) documentation. 35To learn more about user data and how to keep it across versions, please see [Upgrade and Migration](Upgrade-and-migration) documentation.
37 36
38## Features 37## Features