ExternalVendorCode/devilbox
1
0
Fork 0
mirror of https://github.com/cytopia/devilbox.git synced 2024-12-22 06:07:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

DVL-016 Info about docker logs

Browse Source
This commit is contained in:
cytopia 2017-06-10 15:19:06 +02:00
parent 11242dac1f
commit 221ebcc8ff
No known key found for this signature in database
GPG Key ID: 6D56EDB8695128A2
2 changed files with 46 additions and 99 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
docs/Run.md
View File

@ -25,6 +25,10 @@
3. [Attach/Detach during run-time](#3-attach-detach-during-run-time)
1. [Attach during run-time](#3-1-attach-during-run-time)
2. [Detach during run-time](#3-2-detach-during-run-time)
4. [Docker logs](#4-docker-logs)
1. [All logs](#4-1-all-logs)
1. [Specific logs](#4-2-specific-logs)
1. [Tail logs](#4-3-tail-logs)
---
@ -63,7 +67,7 @@ $ docker-compose up httpd php bind mysql
$ docker-compose up -d httpd php bind mysql
```
**Note:** `httpd`, `php` and `bind` are base container that will **always** be started if specified or not. (Defined by `depends_on` in `docker-compose.yml`). So the above could also be achieved by simply specifying `mysql` only.
**Start Note:** `httpd`, `php` and `bind` are base container that will **always** be started if specified or not. (Defined by `depends_on` in `docker-compose.yml`). So the above could also be achieved by simply specifying `mysql` only.
```shell
# Foreground
@ -73,6 +77,8 @@ $ docker-compose up mysql
$ docker-compose up -d mysql
```
**Log Note:** When you do not specify httpd, php and bind in foreground start, their docker-logs will not be shown and you will have to explicitly use `docker-compose logs` to view their stdout/stderr output. Refer to the Log section below.
##### 1.3.2 Starting httpd, php, bind, pgsql and redis
```shell
@ -83,7 +89,7 @@ $ docker-compose up httpd php bind pgsql redis
$ docker-compose up -d httpd php bind pgsql redis
```
**Note:** `httpd`, `php` and `bind` are base container that will **always** be started if specified or not. (Defined by `depends_on` in `docker-compose.yml`). So the above could also be achieved by simply specifying `pgsql` and `redis` only.
**Start Note:** `httpd`, `php` and `bind` are base container that will **always** be started if specified or not. (Defined by `depends_on` in `docker-compose.yml`). So the above could also be achieved by simply specifying `pgsql` and `redis` only.
```shell
# Foreground
@ -92,6 +98,8 @@ $ docker-compose up pgsql redis
# Background
$ docker-compose up -d pgsql redis
```
**Log Note:** When you do not specify httpd, php and bind in foreground start, their docker-logs will not be shown and you will have to explicitly use `docker-compose logs` to view their stdout/stderr output. Refer to the Log section below.
### 2. Stop the devilbox
@ -131,3 +139,32 @@ You can also stop specific containers during runtime if they are not needed anym
```shell
$ docker-compose stop redis
```
### 4. Docker Logs
Services started in background mode (`-d`) or those that were started as dependencies (`http` and `php`) will always only log to docker logs and not to stdout/stderr.
#### 4.1 All logs
In order to view logs of all started containers type:
```shell
$ docker-compose logs
```
#### 4.2 Specific logs
In order to view logs of a specific container, name it explicitly:
```shell
$ docker-compose logs redis
```
#### 4.3 Tail logs
There is also a version similar to `tail -f` to keep logs updated all the time.
```shell
$ docker-compose logs -f
```

104
docs/Usage.md
View File

@ -15,116 +15,26 @@
## Usage
1. [Start and Stop](#1-start-and-stop)
1. [Normal Start](#1-1-normal-start)
2. [Background Start](#)
3. [Selective Start](#)
4. [Normal Stop](#)
5. [Selective Stop](#)
6. [Attach/Detach during run-time](#)
2. [Work inside the PHP container](#)
1. [Work inside the PHP container](#)
1. [As devilbox user](#)
2. [As root user](#)
3. [Available tools](#)
4. [Available URLs](#)
3. [Creating Projects](#)
2. [Creating Projects](#)
1. [Creating projects on the docker host](#)
2. [Creating projects from inside the PHP container](#)
4. [Backups](#)
3. [Backups](#)
1. [Backup MySQL database](#)
2. [Backup PgSQL database](#)
5. [DNS](#)
4. [DNS](#)
1. [/etc/hosts](#)
2. [Auto-DNS](#)
6. [Intranet](#)
7. [Emails](#)
8. [Log files](#)
5. [Intranet](#)
6. [Emails](#)
7. [Log files](#)
---
### 1. Start and Stop
Starting and stopping containers is done via docker-compose. If you have never worked with it before, have a look at their documentation for an [overview](https://docs.docker.com/compose/reference/overview/), [up](https://docs.docker.com/compose/reference/up/) and [stop](https://docs.docker.com/compose/reference/stop/) commands.
#### 1.1 Normal Start
The normal start will bring up **all** container defined in *docker-compose.yml* and will stay in forground making it possible to stop them via Ctrl+c.
```shell
$ docker-compose up
```
#### 1.2 Background Start
Instead of having the docker-compose run stay in foreground, you can also send it to the background by adding `-d` as an argument. The following will bring up **all** container and send docker-compose to background.
```shell
$ docker-compose up -d
```
#### 1.3 Selective Start
There is no need to always bring up **all** container, if you just need a few at the moment. In order to do so, simply specify the container by name that you actually need.
##### 1.3.1 Starting httpd, php, bind and mysql
```shell
# Foreground
$ docker-compose up httpd php bind mysql
# Background
$ docker-compose up -d httpd php bind mysql
```
**Note:** `httpd`, `php` and `bind` are base container that will **always** be started if specified or not. (Defined by `depends_on` in `docker-compose.yml`). So the above could also be achieved by simply specifying `mysql` only.
```shell
# Foreground
$ docker-compose up mysql
# Background
$ docker-compose up -d mysql
```
##### 1.3.2 Starting httpd, php, bind, pgsql and redis
```shell
# Foreground
$ docker-compose up httpd php bind pgsql redis
# Background
$ docker-compose up -d httpd php bind pgsql redis
```
**Note:** `httpd`, `php` and `bind` are base container that will **always** be started if specified or not. (Defined by `depends_on` in `docker-compose.yml`). So the above could also be achieved by simply specifying `pgsql` and `redis` only.
```shell
# Foreground
$ docker-compose up pgsql redis
# Background
$ docker-compose up -d pgsql redis
```
#### 1.4 Normal Stop
1. If you started up docker compose in foreground mode (without `-d`), you can hit `ctrl+c` to gracefull stop or **twice** `ctrl+c` to kill the running containers.<br/>**Note:** Automatically started containers that were not specified (such as `http` or `php`) will have to be stopped manually via `docker-compose down` afterwards.
2. If you started up docker compose in background mode (with `-d`), go back to the devilbox directory (where the `docker-compose.yml` file resides and type `docker-compose down` to gracefully stop or `docker-compose kill` to kill them immediately.
Best pracice would be to start the container in the background (with `-d`) and use `docker compose down` to gracefully stop all of them.
#### 1.5 Selective stop
You can also stop specific containers during runtime if they are not needed anymore. You might have started httpd, php, bind, mysql and redis and decided that redis was not needed. So go ahead and remove redis from the running container stack.
```shell
$ docker-compose stop redis
```
#### 1.6 Attach/Detach during run-time
### 2. Creating Projects
This section is about how to start, stop, view and enter (all or a selection of some) containers. If you want to know how to choose the container type version (e.g. which mysql version or which php version) refer to the **[Configuration](Configuration.md)** section.