Repository: incubator-guacamole-manual Updated Branches: refs/heads/master 8ac254870 -> 4e18295bc
GUACAMOLE-409: include instructions for using Dockerfile in README Project: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/commit/47037238 Tree: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/tree/47037238 Diff: http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/diff/47037238 Branch: refs/heads/master Commit: 47037238642be4f630db0b630caf038896b52b72 Parents: 6908176 Author: Carl Harris <[email protected]> Authored: Sun Oct 8 09:54:53 2017 -0400 Committer: Carl Harris <[email protected]> Committed: Sun Oct 8 20:11:01 2017 -0400 ---------------------------------------------------------------------- README | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-guacamole-manual/blob/47037238/README ---------------------------------------------------------------------- diff --git a/README b/README index 9d80b41..0bac7c1 100644 --- a/README +++ b/README @@ -83,6 +83,51 @@ processor called "xsltproc", applying the standard DocBook XSL stylesheets. ------------------------------------------------------------ + Building and viewing the manual using Docker +------------------------------------------------------------ + +The guacamole-manual package includes a Dockerfile that can be used to build +an Apache httpd Docker image that contains the Guacamole user manual. + +By building and running the resulting container, a developer can work on the +user manual without the need to install docbook and related dependencies on +his/her workstation. The resulting container can also be used to serve the +manual to Guacamole users on a network. + +Docker CE version 1.6 or later is required to build the image. + +Build the Guacamole manual container image by running the following command in +the directory that contains this Dockerfile: + + $ docker image build -t guacamole/manual . + +Run the resulting container using the following command: + + $ docker container run -p 8080:80 guacamole/manual + +You'll see some startup messages from Apache httpd on your terminal when you +start up the container. Once the container is running you can then view the +HTML version of the manual by accessing http://localhost:8080 using your web +browser. + +If another process on the host is already using port 8080, you will need to +change the corresponding argument in the command used to start the container. + +As a developer working on the documentation, it will be necessary to stop the +container and run the build again each time you wish to see changes you've +made to the documentation source. + +By default, the container image will contain only the HTML variant of the +Guacamole user manual. If you also wish to serve the PDF variant, use the +following command to build container image + + $ docker image build --build-arg TARGET=all -t guacamole/manual . + +You can view the PDF variant of the manual by accessing +http://localhost:8080/gug.pdf using your web browser. + + +------------------------------------------------------------ Reporting problems ------------------------------------------------------------
