summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-04-20 14:16:14 +0200
committerChristian Poessinger <christian@poessinger.com>2019-04-20 14:16:14 +0200
commit0a0e3c5ebd835a4d90f47ba47300cd1841845bbc (patch)
treeeb4ac69028ac61e2c4145f4eb70e7ecf57d52507 /README.md
parentc208ed8d03ac8f4c6be2ff698d60f6a6bf8fe0db (diff)
downloadvyos-documentation-0a0e3c5ebd835a4d90f47ba47300cd1841845bbc.tar.gz
vyos-documentation-0a0e3c5ebd835a4d90f47ba47300cd1841845bbc.zip
Docker: update Dockerfile and description
Diffstat (limited to 'README.md')
-rw-r--r--README.md18
1 files changed, 7 insertions, 11 deletions
diff --git a/README.md b/README.md
index 0ac09cb0..87484405 100644
--- a/README.md
+++ b/README.md
@@ -20,22 +20,18 @@ Required Debian Packages:
## Docker
-## Create Container
+Using our [Dockerfile](docker/Dockerfile) you create your own Docker container
+that is used to build a VyOS documentation.
+
+## Setup
```bash
-$ docker build -t vyos-docu - < Dockerfile
+$ docker build -t vyos-docu docker
```
-### Build Documentation
+### Build
Linux
```bash
-$ docker run -v `pwd`:`pwd` -w `pwd`/docs -i -t --rm vyos-docu bash
-```
-
-Windows PowerShell
-```powershell
-docker run -v "$($pwd.path):/vyos" -w "/vyos/docs" -i -t --rm vyos-docu bash
+$ docker run --rm -it -v "$(pwd)":/vyos -w /vyos/docs -e GOSU_UID=$(id -u) -e GOSU_GID=$(id -g) vyos-docu make html
```
-
-Inside the container you can then build the documentation as stated above.