From 6f59a4a5b2c861a826fc26add28e96f7303a528a Mon Sep 17 00:00:00 2001 From: Georgios Kalpakas Date: Wed, 17 May 2017 17:08:16 +0300 Subject: [PATCH] docs(aio): minor docs fixes for `aio-builds-setup/` --- aio/aio-builds-setup/docs/_TOC.md | 2 +- .../docs/vm-setup--create-docker-image.md | 4 +- .../docs/vm-setup--start-docker-container.md | 44 +++++++++---------- 3 files changed, 25 insertions(+), 25 deletions(-) diff --git a/aio/aio-builds-setup/docs/_TOC.md b/aio/aio-builds-setup/docs/_TOC.md index d9c0b03780..16aa208e19 100644 --- a/aio/aio-builds-setup/docs/_TOC.md +++ b/aio/aio-builds-setup/docs/_TOC.md @@ -20,7 +20,7 @@ ## Starting the docker container -- [Create docker image](vm-setup--start-docker-container.md) +- [Start docker container](vm-setup--start-docker-container.md) ## Miscellaneous diff --git a/aio/aio-builds-setup/docs/vm-setup--create-docker-image.md b/aio/aio-builds-setup/docs/vm-setup--create-docker-image.md index 4a0c240536..77caef0664 100644 --- a/aio/aio-builds-setup/docs/vm-setup--create-docker-image.md +++ b/aio/aio-builds-setup/docs/vm-setup--create-docker-image.md @@ -6,11 +6,11 @@ ## Build docker image -- `/scripts/build.sh [[:] [--build-arg = ...]]` +- `/scripts/create-image.sh [[:] [--build-arg = ...]]` - You can overwrite the default environment variables inside the image, by passing new values using `--build-arg`. -**Note:** The build script has to execute docker commands with `sudo`. +**Note:** The script has to execute docker commands with `sudo`. ## Example diff --git a/aio/aio-builds-setup/docs/vm-setup--start-docker-container.md b/aio/aio-builds-setup/docs/vm-setup--start-docker-container.md index 8628664f21..880624a907 100644 --- a/aio/aio-builds-setup/docs/vm-setup--start-docker-container.md +++ b/aio/aio-builds-setup/docs/vm-setup--start-docker-container.md @@ -7,16 +7,16 @@ command: ``` sudo docker run \ - -d \ + --detach \ --dns 127.0.0.1 \ --name \ - -p 80:80 \ - -p 443:443 \ + --publish 80:80 \ + --publish 443:443 \ --restart unless-stopped \ - [-v :/etc/ssl/localcerts:ro] \ - -v :/aio-secrets:ro \ - -v :/var/www/aio-builds \ - [-v :/var/log/aio] \ + [--volume :/etc/ssl/localcerts:ro] \ + --volume :/aio-secrets:ro \ + --volume :/var/www/aio-builds \ + [--volume :/var/log/aio] \ [:] ``` @@ -27,7 +27,7 @@ can be found [here](https://docs.docker.com/engine/reference/run/). sudo docker run \ # Start as a daemon. - -d \ + --detach \ # Use the local DNS server. # (This is necessary for mapping internal URLs, e.g. for the Node.js upload-server.) @@ -37,9 +37,9 @@ sudo docker run \ # Useful for running `docker` commands, e.g.: `docker stop ` --name \ - # Map ports of the hosr VM (left) to ports of the docker container (right) - -p 80:80 \ - -p 443:443 \ + # Map ports of the host VM (left) to ports of the docker container (right) + --publish 80:80 \ + --publish 443:443 \ # Automatically restart the container (unless it was explicitly stopped by the user). # (This ensures that the container will be automatically started on boot.) @@ -48,22 +48,22 @@ sudo docker run \ # The directory the contains the SSL certificates. # (See [here](vm-setup--create-host-dirs-and-files.md) for more info.) # If not provided, the container will use self-signed certificates. - [-v :/etc/ssl/localcerts:ro] \ + [--volume :/etc/ssl/localcerts:ro] \ # The directory the contains the secrets (e.g. GitHub token, JWT secret, etc). # (See [here](vm-setup--set-up-secrets.md) for more info.) - -v :/aio-secrets:ro \ + --volume :/aio-secrets:ro \ # The uploaded build artifacts will stored to and served from this directory. # (If you are using a persistent disk - as described [here](vm-setup--attach-persistent-disk.md) - # this will be a directory inside the disk.) - -v :/var/www/aio-builds \ + --volume :/var/www/aio-builds \ # The directory where the logs are being kept. # (See [here](vm-setup--create-host-dirs-and-files.md) for more info.) # If not provided, the logs will be kept inside the container, which means they will be lost # whenever a new container is created. - [-v :/var/log/aio] \ + [--volume :/var/log/aio] \ # The name of the docker image to use (and an optional tag; defaults to `latest`). # (See [here](vm-setup--create-docker-image.md) for instructions on how to create the iamge.) @@ -78,15 +78,15 @@ by the container for accesing secrets and SSL certificates and keeping the build ``` sudo docker run \ - -d \ + --detach \ --dns 127.0.0.1 \ --name foobar-builds-1 \ - -p 80:80 \ - -p 443:443 \ + --publish 80:80 \ + --publish 443:443 \ --restart unless-stopped \ - -v /etc/ssl/localcerts:/etc/ssl/localcerts:ro \ - -v /foobar-secrets:/aio-secrets:ro \ - -v /mnt/disks/foobar-builds:/var/www/aio-builds \ - -v /foobar-logs:/var/log/aio \ + --volume /etc/ssl/localcerts:/etc/ssl/localcerts:ro \ + --volume /foobar-secrets:/aio-secrets:ro \ + --volume /mnt/disks/foobar-builds:/var/www/aio-builds \ + --volume /foobar-logs:/var/log/aio \ foobar-builds ```