1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
moby--moby/man
Jana Radhakrishnan bf2b8ec816 Make daemon to start with no userlandproxy by default
This PR makes a user visible behavior change with userland
proxy disabled by default and rely on hairpin NAT to be enabled
by default. This may not work in older (unsupported) kernels
where the user will be forced to enable userlandproxy if needed.

      - Updated the Docs
      - Changed the integration-cli to start with userlandproxy
	desiabled by default.

Signed-off-by: Jana Radhakrishnan <mrjana@docker.com>
2015-09-11 11:58:35 -07:00
..
docker-attach.1.md
docker-build.1.md Add ulimit to docker build. 2015-07-23 10:26:06 +08:00
docker-commit.1.md fix format man-commit 2015-08-19 10:07:32 -04:00
docker-cp.1.md docs: Updated for docker cp and its API changes 2015-07-21 15:30:20 -07:00
docker-create.1.md Signal to stop a container. 2015-09-10 19:56:05 -04:00
docker-diff.1.md
docker-events.1.md
docker-exec.1.md Updated test to check for exec --privileged side-effects 2015-08-13 16:37:20 +10:00
docker-export.1.md Unify docker commands' usage in man and help 2015-07-02 10:33:26 +08:00
docker-history.1.md add -H to SYNOPSIS man-history 2015-08-19 09:35:52 -04:00
docker-images.1.md Fix #8048 : make docker images repository:tag work 2015-08-13 08:50:09 +02:00
docker-import.1.md adding message option to the import subcommand 2015-08-25 02:55:04 +00:00
docker-info.1.md
docker-inspect.1.md Add STOPSIGNAL instruction to dockerfiles. 2015-09-10 19:56:05 -04:00
docker-kill.1.md
docker-load.1.md Carry man page for 14637 2015-07-24 13:39:29 -07:00
docker-login.1.md update reference to config file 2015-07-10 18:55:47 +00:00
docker-logout.1.md Unify docker commands' usage in man and help 2015-07-02 10:33:26 +08:00
docker-logs.1.md Moving man pages out of docs 2015-06-10 13:43:35 -07:00
docker-pause.1.md
docker-port.1.md
docker-ps.1.md Add 'ancestor' ps filter for image 2015-08-26 22:59:48 +02:00
docker-pull.1.md correct man docker-pull 2015-09-04 16:34:40 -04:00
docker-push.1.md Modify man pages for image-naming 2015-07-13 15:49:41 -04:00
docker-rename.1.md
docker-restart.1.md
docker-rm.1.md Fix docker-rm man page formatting 2015-07-26 04:18:48 +02:00
docker-rmi.1.md Robert P.J. Day found this problems in man pages 2015-07-13 08:59:03 -04:00
docker-run.1.md Signal to stop a container. 2015-09-10 19:56:05 -04:00
docker-save.1.md
docker-search.1.md Fix man pages 2015-07-20 11:47:59 -04:00
docker-start.1.md
docker-stats.1.md Docker stats: display Block IO stats 2015-07-31 21:26:32 +08:00
docker-stop.1.md Signal to stop a container. 2015-09-10 19:56:05 -04:00
docker-tag.1.md man docker-tag minor fixup 2015-09-04 10:10:03 -04:00
docker-top.1.md Unify docker commands' usage in man and help 2015-07-02 10:33:26 +08:00
docker-unpause.1.md
docker-version.1.md add --format flag to docker version 2015-07-13 19:10:56 -04:00
docker-volume-create.1.md update docker volume man pages 2015-09-09 19:16:39 +02:00
docker-volume-inspect.1.md update docker volume man pages 2015-09-09 19:16:39 +02:00
docker-volume-ls.1.md update docker volume man pages 2015-09-09 19:16:39 +02:00
docker-volume-rm.1.md update docker volume man pages 2015-09-09 19:16:39 +02:00
docker-wait.1.md
docker.1.md Make daemon to start with no userlandproxy by default 2015-09-11 11:58:35 -07:00
Dockerfile Bump go-md2man to 1.0.3 2015-07-21 10:42:02 -04:00
Dockerfile.5.md man Dockerfile ADD/COPY/FROM clarify 2015-09-03 09:08:25 -04:00
md2man-all.sh
README.md man: convert docker/docs/man to docker/man 2015-06-24 23:31:12 +08:00

Docker Documentation

This directory contains the Docker user manual in the Markdown format. Do not edit the man pages in the man1 directory. Instead, amend the Markdown (*.md) files.

Generating man pages from the Markdown files

The recommended approach for generating the man pages is via a Docker container using the supplied Dockerfile to create an image with the correct environment. This uses go-md2man, a pure Go Markdown to man page generator.

Building the md2man image

There is a Dockerfile provided in the docker/man directory.

Using this Dockerfile, create a Docker image tagged docker/md2man:

docker build -t docker/md2man .

Utilizing the image

Once the image is built, run a container using the image with volumes:

docker run -v /<path-to-git-dir>/docker/man:/docs:rw \
-w /docs -i docker/md2man /docs/md2man-all.sh

The md2man Docker container will process the Markdown files and generate the man pages inside the docker/man/man1 directory using Docker volumes. For more information on Docker volumes see the man page for docker run and also look at the article [Sharing Directories via Volumes] (https://docs.docker.com/use/working_with_volumes/).