Knah-Tsaeb/MyShaarli
Knah-Tsaeb/MyShaarli
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Minor docker-101 doc updates, typos fixed #983

Browse source
This commit is contained in:
B. van Berkum 2017-10-06 00:25:50 +02:00
parent 2f65b3dd53
commit df8becac4f
1 changed files with 9 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
doc/md/docker/docker-101.md
View file

@ -61,26 +61,26 @@ Digest: sha256:c584131da2ac1948aa3e66468a4424b6aea2f33acba7cec0b631bdb56254c4fe
Status: Downloaded newer image for debian:wheezy Status: Downloaded newer image for debian:wheezy
``` ```
Docker re-uses layers already downloaded. Iow. if you have images based only Alpine or some Ubuntu version for example, those can share disk space. Docker re-uses layers already downloaded. In other words if you have images based on Alpine or some Ubuntu version for example, those can share disk space.
### Start a container ### Start a container
A 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. A 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.
The 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``. The 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``.
Note that stopped containers are not destroyed, unless you specify ``--rm``. To view all created, running and stopped containers, enter: Stopped containers are not destroyed, unless you specify ``--rm``. To view all created, running and stopped containers, enter:
```bash ```bash
$ docker ps -a $ docker ps -a
``` ```
Some 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. Some containers may be designed or configured to be restarted, others are not. Also remember both network ports and volumes of a container are created on start, and not editable later.
### Access a running container ### Access a running container
A running container is accessible using ``docker exec``, or ``docker copy``. You can use ``exec`` to start a root shell in the Shaarli container: A running container is accessible using ``docker exec``, or ``docker copy``. You can use ``exec`` to start a root shell in the Shaarli container:
```bash ```bash
$ docker exec -ti <container-name-or-id> bash $ docker exec -ti <container-name-or-id> bash
``` ```
Note the names and ID's of containers are list in ``docker ps``. You an even type only one or two letters of the ID, given they are unique. Note the names and ID's of containers are listed in ``docker ps``. You can even type only one or two letters of the ID, given they are unique.
Access can also be through one or more network ports, or disk volumes. Both are specified on and fixed on ``docker create`` or ``run``. Access can also be through one or more network ports, or disk volumes. Both are specified on and fixed on ``docker create`` or ``run``.
@ -92,15 +92,15 @@ $ docker logs -f <container-name-or-id>
### Docker disk use ### Docker disk use
Trying out different images can fill some gigabytes of disk quickly. Besides images, the docker volumes usually take up most disk space. Trying out different images can fill some gigabytes of disk quickly. Besides images, the docker volumes usually take up most disk space.
If you care only about trying out docker and not about what is running or saved, the following commands should help you out quickly: If you care only about trying out docker and not about what is running or saved, the following commands should help you out quickly if you run low on disk space:
```bash ```bash
$ docker rmi -f $(docker images -aq) # remove or mark all images for disposal $ docker rmi -f $(docker images -aq) # remove or mark all images for disposal
$ docker volume rm $(docker volume ls -q) # remove all volumes $ docker volume rm $(docker volume ls -q) # remove all volumes
``` ```
### SystemD config ### Systemd config
Systemd is the process manager of choice on ubuntu. Once you have a ``docker`` service installed, you can add use the following steps to set up Shaarli to run on system start. Systemd is the process manager of choice on Debian-based distributions. Once you have a ``docker`` service installed, you can use the following steps to set up Shaarli to run on system start.
```bash ```bash
systemctl enable /etc/systemd/system/docker.shaarli.service systemctl enable /etc/systemd/system/docker.shaarli.service
@ -120,7 +120,7 @@ Requires=docker.service
[Service] [Service]
Restart=always Restart=always
# Put any environment you want in here, like $host- or $domainname in this example # Put any environment you want in an included file, like $host- or $domainname in this example
EnvironmentFile=/etc/sysconfig/box-environment EnvironmentFile=/etc/sysconfig/box-environment
# It's just an example.. # It's just an example..
@ -128,10 +128,8 @@ ExecStart=/usr/bin/docker run \
-p 28010:80 \ -p 28010:80 \
--name ${hostname}-shaarli \ --name ${hostname}-shaarli \
--hostname shaarli.${domainname} \ --hostname shaarli.${domainname} \
\
-v /srv/docker-volumes-local/shaarli-data:/var/www/shaarli/data:rw \ -v /srv/docker-volumes-local/shaarli-data:/var/www/shaarli/data:rw \
-v /etc/localtime:/etc/localtime:ro \ -v /etc/localtime:/etc/localtime:ro \
\
shaarli/shaarli:latest shaarli/shaarli:latest
ExecStop=/usr/bin/docker rm -f ${hostname}-shaarli ExecStop=/usr/bin/docker rm -f ${hostname}-shaarli