diff --git a/docs/Dockerfile b/docs/Dockerfile index 02e0553eb7..3df7a0c712 100644 --- a/docs/Dockerfile +++ b/docs/Dockerfile @@ -4,21 +4,10 @@ MAINTAINER Mary Anthony (@moxiegirl) # To get the git info for this repo COPY . /src -COPY . /docs/content/engine/ +COPY . /docs/content/ -# Sed to process GitHub Markdown -# 1-2 Remove comment code from metadata block -# 3 Remove .md extension from link text -# 4 Change ](/ to ](/project/ in links -# 5 Change ](word) to ](/project/word) -# 6 Change ](../../ to ](/project/ -# 7 Change ](../ to ](/project/word) -# -# -RUN find /docs/content/engine -type f -name "*.md" -exec sed -i.old \ - -e '/^/g' \ - -e '/^/g' \ - -e 's/\([(]\)\(.*\)\(\.md\)/\1\2/g' \ - -e 's/\(\]\)\([(]\)\(\/\)/\1\2\/engine\//g' \ - -e 's/\(\][(]\)\([A-z]*[)]\)/\]\(\/engine\/\2/g' \ - -e 's/\(\][(]\)\(\.\.\/\)/\1\/engine\//g' {} \; +WORKDIR /docs/content + +RUN /docs/content/touch-up.sh + +WORKDIR /docs diff --git a/docs/articles/basics.md b/docs/articles/basics.md index 948fa7bd14..a7df1ca221 100644 --- a/docs/articles/basics.md +++ b/docs/articles/basics.md @@ -47,7 +47,9 @@ image cache. > characters of the full image ID - which can be found using > `docker inspect` or `docker images --no-trunc=true`. -{{ include "no-remote-sudo.md" }} +> **Note:** if you are using a remote Docker daemon, such as Boot2Docker, +> then _do not_ type the `sudo` before the `docker` commands shown in the +> documentation's examples. ## Running an interactive shell diff --git a/docs/articles/certificates.md b/docs/articles/certificates.md index 366c020d02..16c73d1b24 100644 --- a/docs/articles/certificates.md +++ b/docs/articles/certificates.md @@ -4,7 +4,8 @@ title = "Using certificates for repository client verification" description = "How to set up and use certificates with a registry to verify access" keywords = ["Usage, registry, repository, client, root, certificate, docker, apache, ssl, tls, documentation, examples, articles, tutorials"] [menu.main] -parent = "smn_registry" +parent = "mn_docker_hub" +weight = 7 +++ diff --git a/docs/articles/registry_mirror.md b/docs/articles/registry_mirror.md index 0a2d4f4ea4..13461d5187 100644 --- a/docs/articles/registry_mirror.md +++ b/docs/articles/registry_mirror.md @@ -4,7 +4,8 @@ title = "Run a local registry mirror" description = "How to set up and run a local registry mirror" keywords = ["docker, registry, mirror, examples"] [menu.main] -parent = "smn_registry" +parent = "mn_docker_hub" +weight = 8 +++ diff --git a/docs/docker-hub/accounts.md b/docs/docker-hub/accounts.md index d2f20c971d..8fb24018e2 100644 --- a/docs/docker-hub/accounts.md +++ b/docs/docker-hub/accounts.md @@ -5,6 +5,7 @@ description = "Docker Hub accounts" keywords = ["Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, docs, documentation"] [menu.main] parent = "smn_pubhub" +weight = 1 +++ diff --git a/docs/docker-hub/builds.md b/docs/docker-hub/builds.md index 34c5e9c657..1d05d3ba98 100644 --- a/docs/docker-hub/builds.md +++ b/docs/docker-hub/builds.md @@ -5,6 +5,7 @@ description = "Docker Hub Automated Builds" keywords = ["Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, docs, documentation, trusted, builds, trusted builds, automated builds"] [menu.main] parent = "smn_pubhub" +weight = 3 +++ diff --git a/docs/docker-hub/home.md b/docs/docker-hub/home.md index 251335a4ad..c2e44e17a4 100644 --- a/docs/docker-hub/home.md +++ b/docs/docker-hub/home.md @@ -1,5 +1,6 @@ diff --git a/docs/docker-hub/repos.md b/docs/docker-hub/repos.md index d9ce722da7..ada258e43f 100644 --- a/docs/docker-hub/repos.md +++ b/docs/docker-hub/repos.md @@ -5,6 +5,7 @@ description = "Your Repositories on Docker Hub" keywords = ["Docker, docker, registry, accounts, plans, Dockerfile, Docker Hub, webhooks, docs, documentation"] [menu.main] parent = "smn_pubhub" +weight = 2 +++ diff --git a/docs/examples/couchdb_data_volumes.md b/docs/examples/couchdb_data_volumes.md index 707c04c18c..3c8f620ff0 100644 --- a/docs/examples/couchdb_data_volumes.md +++ b/docs/examples/couchdb_data_volumes.md @@ -4,7 +4,7 @@ title = "Dockerizing a CouchDB service" description = "Sharing data between 2 couchdb databases" keywords = ["docker, example, package installation, networking, couchdb, data volumes"] [menu.main] -parent = "smn_remoteapi" +parent = "smn_applied" +++ diff --git a/docs/include/no-remote-sudo.md b/docs/include/no-remote-sudo.md deleted file mode 100644 index 065b0cbfd7..0000000000 --- a/docs/include/no-remote-sudo.md +++ /dev/null @@ -1,3 +0,0 @@ -> **Note:** if you are using a remote Docker daemon, such as Boot2Docker, -> then _do not_ type the `sudo` before the `docker` commands shown in the -> documentation's examples. diff --git a/docs/installation/mac.md b/docs/installation/mac.md index 4c0c1e9442..ee5fcaaef9 100644 --- a/docs/installation/mac.md +++ b/docs/installation/mac.md @@ -14,7 +14,7 @@ You can install Docker using Boot2Docker to run `docker` commands at your comman Choose this installation if you are familiar with the command-line or plan to contribute to the Docker project on GitHub. -[Download Kitematic](https://kitematic.com/download) Alternatively, you may want to try -#Ubuntu +# Ubuntu Docker is supported on these Ubuntu operating systems: diff --git a/docs/installation/windows.md b/docs/installation/windows.md index b03c945385..ee62d4a6ec 100644 --- a/docs/installation/windows.md +++ b/docs/installation/windows.md @@ -53,7 +53,9 @@ is developed, you can launch only Linux containers from your Windows machine. ## Running Docker -{{ include "no-remote-sudo.md" }} +> **Note:** if you are using a remote Docker daemon, such as Boot2Docker, +> then _do not_ type the `sudo` before the `docker` commands shown in the +> documentation's examples. **Boot2Docker Start** will automatically start a shell with environment variables correctly set so you can start using Docker right away: diff --git a/docs/misc/faq.md b/docs/misc/faq.md index 9aee9ed094..2108ddc16c 100644 --- a/docs/misc/faq.md +++ b/docs/misc/faq.md @@ -36,7 +36,9 @@ Windows*](../installation/windows/#windows) installation guides. The small Linux distribution boot2docker can be run inside virtual machines on these two operating systems. -{{ include "no-remote-sudo.md" }} +> **Note:** if you are using a remote Docker daemon, such as Boot2Docker, +> then _do not_ type the `sudo` before the `docker` commands shown in the +> documentation's examples. ### How do containers compare to virtual machines? diff --git a/docs/misc/index.md b/docs/misc/index.md index 532ddfd01d..ae54d9e694 100644 --- a/docs/misc/index.md +++ b/docs/misc/index.md @@ -1,12 +1,10 @@ diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml deleted file mode 100644 index 4be277a6cb..0000000000 --- a/docs/mkdocs.yml +++ /dev/null @@ -1,230 +0,0 @@ -site_name: Docker Documentation -#site_url: https://docs.docker.com/ -site_url: / -site_description: Documentation for fast and lightweight Docker container based virtualization framework. -site_favicon: img/favicon.png - -dev_addr: '0.0.0.0:8000' - -repo_url: https://github.com/docker/docker/ - -docs_dir: sources - -include_search: true - -use_absolute_urls: true - -# theme: docker -theme_dir: ./theme/mkdocs/ -theme_center_lead: false - -copyright: Copyright © 2014-2015, Docker, Inc. -google_analytics: ['UA-6096819-11', 'docker.io'] - -pages: - -# Introduction: -- ['index.md', 'About', 'Docker'] -- ['introduction/understanding-docker.md', 'About', 'Understanding Docker'] -- ['release-notes.md', 'About', 'Release notes'] -- ['reference/glossary.md', 'About', 'Glossary'] -- ['introduction/index.md', '**HIDDEN**'] - - -# Installation: -- ['installation/index.md', '**HIDDEN**'] -- ['installation/ubuntulinux.md', 'Installation', 'Ubuntu'] -- ['installation/mac.md', 'Installation', 'Mac OS X'] -- ['kitematic/index.md', 'Installation', 'Kitematic on OS X'] -- ['installation/windows.md', 'Installation', 'Microsoft Windows'] -- ['installation/testing-windows-docker-client.md', 'Installation', 'Building and testing the Windows Docker client'] -- ['installation/amazon.md', 'Installation', 'Amazon EC2'] -- ['installation/archlinux.md', 'Installation', 'Arch Linux'] -- ['installation/binaries.md', 'Installation', 'Binaries'] -- ['installation/centos.md', 'Installation', 'CentOS'] -- ['installation/cruxlinux.md', 'Installation', 'CRUX Linux'] -- ['installation/debian.md', 'Installation', 'Debian'] -- ['installation/fedora.md', 'Installation', 'Fedora'] -- ['installation/frugalware.md', 'Installation', 'FrugalWare'] -- ['installation/google.md', 'Installation', 'Google Cloud Platform'] -- ['installation/gentoolinux.md', 'Installation', 'Gentoo'] -- ['installation/softlayer.md', 'Installation', 'IBM Softlayer'] -- ['installation/joyent.md', 'Installation', 'Joyent Compute Service'] -- ['installation/azure.md', 'Installation', 'Microsoft Azure'] -- ['installation/rackspace.md', 'Installation', 'Rackspace Cloud'] -- ['installation/rhel.md', 'Installation', 'Red Hat Enterprise Linux'] -- ['installation/oracle.md', 'Installation', 'Oracle Linux'] -- ['installation/SUSE.md', 'Installation', 'SUSE'] -- ['compose/install.md', 'Installation', 'Docker Compose'] - -# User Guide: -- ['userguide/index.md', 'User Guide', 'The Docker user guide' ] -- ['userguide/dockerhub.md', 'User Guide', 'Getting started with Docker Hub' ] -- ['userguide/dockerizing.md', 'User Guide', 'Dockerizing applications' ] -- ['userguide/usingdocker.md', 'User Guide', 'Working with containers' ] -- ['userguide/dockerimages.md', 'User Guide', 'Working with Docker images' ] -- ['userguide/dockerlinks.md', 'User Guide', 'Linking containers together' ] -- ['userguide/dockervolumes.md', 'User Guide', 'Managing data in containers' ] -- ['userguide/labels-custom-metadata.md', 'User Guide', 'Apply custom metadata' ] -- ['userguide/dockerrepos.md', 'User Guide', 'Working with Docker Hub' ] -- ['userguide/level1.md', '**HIDDEN**' ] -- ['userguide/level2.md', '**HIDDEN**' ] -- ['compose/index.md', 'User Guide', 'Docker Compose' ] -- ['compose/production.md', 'User Guide', '    ▪  Use Compose in production' ] -- ['compose/extends.md', 'User Guide', '    ▪  Extend Compose services' ] -- ['machine/index.md', 'User Guide', 'Docker Machine' ] -- ['swarm/index.md', 'User Guide', 'Docker Swarm' ] -- ['kitematic/userguide.md', 'User Guide', 'Kitematic'] - -# Docker Hub docs: -- ['docker-hub/index.md', 'Docker Hub', 'Docker Hub' ] -- ['docker-hub/accounts.md', 'Docker Hub', 'Accounts'] -- ['docker-hub/userguide.md', 'Docker Hub', 'User Guide'] -- ['docker-hub/repos.md', 'Docker Hub', 'Your Repositories'] -- ['docker-hub/builds.md', 'Docker Hub', 'Automated Builds'] -- ['docker-hub/official_repos.md', 'Docker Hub', 'Official Repositories'] - -# Docker Hub Enterprise: -- ['docker-hub-enterprise/index.md', 'Docker Hub Enterprise', 'Overview' ] -- ['docker-hub-enterprise/quick-start.md', 'Docker Hub Enterprise', 'Quick Start: Basic Workflow' ] -- ['docker-hub-enterprise/userguide.md', 'Docker Hub Enterprise', 'User Guide' ] -- ['docker-hub-enterprise/adminguide.md', 'Docker Hub Enterprise', 'Admin Guide' ] -- ['docker-hub-enterprise/install.md', 'Docker Hub Enterprise', '  Installation' ] -- ['docker-hub-enterprise/configuration.md', 'Docker Hub Enterprise', '  Configuration options' ] -- ['docker-hub-enterprise/support.md', 'Docker Hub Enterprise', 'Support' ] -- ['docker-hub-enterprise/release-notes.md', 'Docker Hub Enterprise', 'Release notes' ] - -# Examples: -- ['examples/index.md', '**HIDDEN**'] -- ['examples/nodejs_web_app.md', 'Examples', 'Dockerizing a Node.js web application'] -- ['examples/mongodb.md', 'Examples', 'Dockerizing MongoDB'] -- ['examples/running_redis_service.md', 'Examples', 'Dockerizing a Redis service'] -- ['examples/postgresql_service.md', 'Examples', 'Dockerizing a PostgreSQL service'] -- ['examples/running_riak_service.md', 'Examples', 'Dockerizing a Riak service'] -- ['examples/running_ssh_service.md', 'Examples', 'Dockerizing an SSH service'] -- ['examples/couchdb_data_volumes.md', 'Examples', 'Dockerizing a CouchDB service'] -- ['examples/apt-cacher-ng.md', 'Examples', 'Dockerizing an Apt-Cacher-ng service'] -- ['compose/django.md', 'Examples', 'Getting started with Compose and Django'] -- ['compose/rails.md', 'Examples', 'Getting started with Compose and Rails'] -- ['compose/wordpress.md', 'Examples', 'Getting started with Compose and Wordpress'] -- ['kitematic/minecraft-server.md', 'Examples', 'Kitematic: Minecraft server'] -- ['kitematic/nginx-web-server.md', 'Examples', 'Kitematic: Ngnix web server'] -- ['kitematic/rethinkdb-dev-database.md', 'Examples', 'Kitematic: RethinkDB development database'] - -# Articles -- ['articles/index.md', '**HIDDEN**'] -- ['articles/basics.md', 'Articles', 'Docker basics'] -- ['articles/networking.md', 'Articles', 'Advanced networking'] -- ['articles/security.md', 'Articles', 'Security'] -- ['articles/https.md', 'Articles', 'Running Docker with HTTPS'] -- ['articles/registry_mirror.md', 'Articles', 'Run a local registry mirror'] -- ['articles/host_integration.md', 'Articles', 'Automatically starting containers'] -- ['articles/baseimages.md', 'Articles', 'Creating a base image'] -- ['articles/dockerfile_best-practices.md', 'Articles', 'Best practices for writing Dockerfiles'] -- ['articles/certificates.md', 'Articles', 'Using certificates for repository client verification'] -- ['articles/using_supervisord.md', 'Articles', 'Using Supervisor'] -- ['articles/configuring.md', 'Articles', 'Configuring Docker'] -- ['articles/cfengine_process_management.md', 'Articles', 'Process management with CFEngine'] -- ['articles/puppet.md', 'Articles', 'Using Puppet'] -- ['articles/chef.md', 'Articles', 'Using Chef'] -- ['articles/dsc.md', 'Articles', 'Using PowerShell DSC'] -- ['articles/ambassador_pattern_linking.md', 'Articles', 'Cross-Host linking using ambassador containers'] -- ['articles/runmetrics.md', 'Articles', 'Runtime metrics'] -- ['articles/b2d_volume_resize.md', 'Articles', 'Increasing a Boot2Docker volume'] -- ['articles/systemd.md', 'Articles', 'Controlling and configuring Docker using Systemd'] - -# Reference -- ['reference/index.md', '**HIDDEN**'] -- ['reference/commandline/index.md', '**HIDDEN**'] -- ['reference/commandline/cli.md', 'Reference', 'Docker command line'] -- ['reference/builder.md', 'Reference', 'Dockerfile'] -- ['faq.md', 'Reference', 'FAQ'] -- ['reference/run.md', 'Reference', 'Run reference'] -- ['reference/logging/journald.md', '**HIDDEN**'] -- ['compose/cli.md', 'Reference', 'Compose command line'] -- ['compose/yml.md', 'Reference', 'Compose yml'] -- ['compose/env.md', 'Reference', 'Compose ENV variables'] -- ['compose/completion.md', 'Reference', 'Compose commandline completion'] -- ['swarm/discovery.md', 'Reference', 'Swarm discovery'] -- ['swarm/scheduler/strategy.md', 'Reference', 'Swarm strategies'] -- ['swarm/scheduler/filter.md', 'Reference', 'Swarm filters'] -- ['swarm/API.md', 'Reference', 'Swarm API'] -- ['reference/api/index.md', '**HIDDEN**'] -- ['registry/index.md', 'Reference', 'Docker Registry 2.0'] -- ['registry/deploying.md', 'Reference', '    ▪  Deploy a registry' ] -- ['registry/configuration.md', 'Reference', '    ▪  Configure a registry' ] -- ['registry/storagedrivers.md', 'Reference', '    ▪  Storage driver model' ] -- ['registry/notifications.md', 'Reference', '    ▪  Work with notifications' ] -- ['registry/spec/api.md', 'Reference', '    ▪  Registry Service API v2' ] -- ['registry/spec/json.md', 'Reference', '    ▪  JSON format' ] -- ['registry/spec/auth/token.md', 'Reference', '    ▪  Authenticate via central service' ] -- ['reference/api/hub_registry_spec.md', 'Reference', 'Docker Hub and Registry 1.0'] -- ['reference/api/registry_api.md', 'Reference', '    ▪ Docker Registry API v1'] -- ['reference/api/registry_api_client_libraries.md', 'Reference', '    ▪ Docker Registry 1.0 API client libraries'] -#- ['reference/image-spec-v1.md', 'Reference', 'Docker Image Specification v1.0.0'] -- ['reference/api/docker-io_api.md', 'Reference', 'Docker Hub API'] -#- ['reference/image-spec-v1.md', 'Reference', 'Docker Image Specification v1.0.0'] -- ['reference/api/docker_remote_api.md', 'Reference', 'Docker Remote API'] -- ['reference/api/docker_remote_api_v1.20.md', 'Reference', 'Docker Remote API v1.20'] -- ['reference/api/docker_remote_api_v1.19.md', 'Reference', 'Docker Remote API v1.19'] -- ['reference/api/docker_remote_api_v1.18.md', 'Reference', 'Docker Remote API v1.18'] -- ['reference/api/docker_remote_api_v1.17.md', 'Reference', 'Docker Remote API v1.17'] -- ['reference/api/docker_remote_api_v1.16.md', 'Reference', 'Docker Remote API v1.16'] -- ['reference/api/docker_remote_api_v1.15.md', '**HIDDEN**'] -- ['reference/api/docker_remote_api_v1.14.md', '**HIDDEN**'] -- ['reference/api/docker_remote_api_v1.13.md', '**HIDDEN**'] -- ['reference/api/docker_remote_api_v1.12.md', '**HIDDEN**'] -- ['reference/api/docker_remote_api_v1.11.md', '**HIDDEN**'] -- ['reference/api/docker_remote_api_v1.10.md', '**HIDDEN**'] -- ['reference/api/docker_remote_api_v1.9.md', '**HIDDEN**'] -- ['reference/api/docker_remote_api_v1.8.md', '**HIDDEN**'] -- ['reference/api/docker_remote_api_v1.7.md', '**HIDDEN**'] -- ['reference/api/docker_remote_api_v1.6.md', '**HIDDEN**'] -- ['reference/api/docker_remote_api_v1.5.md', '**HIDDEN**'] -- ['reference/api/docker_remote_api_v1.4.md', '**HIDDEN**'] -- ['reference/api/docker_remote_api_v1.3.md', '**HIDDEN**'] -- ['reference/api/docker_remote_api_v1.2.md', '**HIDDEN**'] -- ['reference/api/docker_remote_api_v1.1.md', '**HIDDEN**'] -- ['reference/api/docker_remote_api_v1.0.md', '**HIDDEN**'] -- ['reference/api/remote_api_client_libraries.md', 'Reference', 'Docker Remote API client libraries'] -- ['reference/api/docker_io_accounts_api.md', 'Reference', 'Docker Hub accounts API'] -- ['kitematic/faq.md', 'Reference', 'Kitematic: FAQ'] -- ['kitematic/known-issues.md', 'Reference', 'Kitematic: Known issues'] - -# Hidden registry files -- ['registry/storage-drivers/azure.md', '**HIDDEN**' ] -- ['registry/storage-drivers/filesystem.md', '**HIDDEN**' ] -- ['registry/storage-drivers/inmemory.md', '**HIDDEN**' ] -- ['registry/storage-drivers/s3.md', '**HIDDEN**' ] - -- ['jsearch.md', '**HIDDEN**'] - -# - ['static_files/README.md', 'static_files', 'README'] -- ['terms/index.md', '**HIDDEN**'] -- ['terms/layer.md', '**HIDDEN**'] -- ['terms/index.md', '**HIDDEN**'] -- ['terms/registry.md', '**HIDDEN**'] -- ['terms/container.md', '**HIDDEN**'] -- ['terms/repository.md', '**HIDDEN**'] -- ['terms/filesystem.md', '**HIDDEN**'] -- ['terms/image.md', '**HIDDEN**'] - - -# Project: -- ['project/index.md', '**HIDDEN**'] -- ['project/who-written-for.md', 'Contributor', 'README first'] -- ['project/software-required.md', 'Contributor', 'Get required software for Linux or OS X'] -- ['project/software-req-win.md', 'Contributor', 'Get required software for Windows'] -- ['project/set-up-git.md', 'Contributor', 'Configure Git for contributing'] -- ['project/set-up-dev-env.md', 'Contributor', 'Work with a development container'] -- ['project/test-and-docs.md', 'Contributor', 'Run tests and test documentation'] -- ['project/make-a-contribution.md', 'Contributor', 'Understand contribution workflow'] -- ['project/find-an-issue.md', 'Contributor', 'Find an issue'] -- ['project/work-issue.md', 'Contributor', 'Work on an issue'] -- ['project/create-pr.md', 'Contributor', 'Create a pull request'] -- ['project/review-pr.md', 'Contributor', 'Participate in the PR review'] -- ['project/advanced-contributing.md', 'Contributor', 'Advanced contributing'] -- ['project/get-help.md', 'Contributor', 'Where to get help'] -- ['project/coding-style.md', 'Contributor', 'Coding style guide'] -- ['project/doc-style.md', 'Contributor', 'Documentation style guide'] - diff --git a/docs/project/advanced-contributing.md b/docs/project/advanced-contributing.md index ce3514bcca..04d5086297 100644 --- a/docs/project/advanced-contributing.md +++ b/docs/project/advanced-contributing.md @@ -5,6 +5,7 @@ description = "Explains workflows for refactor and design proposals" keywords = ["contribute, project, design, refactor, proposal"] [menu.main] parent = "smn_contribute" +weight=6 +++ diff --git a/docs/project/coding-style.md b/docs/project/coding-style.md index 3b2b3af10d..224d2bc02a 100644 --- a/docs/project/coding-style.md +++ b/docs/project/coding-style.md @@ -4,7 +4,8 @@ title = "Coding style checklist" description = "List of guidelines for coding Docker contributions" keywords = ["change, commit, squash, request, pull request, test, unit test, integration tests, Go, gofmt, LGTM"] [menu.main] -parent = "mn_opensource" +parent = "smn_contribute" +weight=7 +++ diff --git a/docs/project/create-pr.md b/docs/project/create-pr.md index 1b6b0c98e7..dacb39b07c 100644 --- a/docs/project/create-pr.md +++ b/docs/project/create-pr.md @@ -5,6 +5,7 @@ description = "Basic workflow for Docker contributions" keywords = ["contribute, pull request, review, workflow, beginner, squash, commit"] [menu.main] parent = "smn_contribute" +weight=4 +++ diff --git a/docs/project/doc-style.md b/docs/project/doc-style.md index dfefc8fa34..fe6b6453a1 100644 --- a/docs/project/doc-style.md +++ b/docs/project/doc-style.md @@ -5,6 +5,7 @@ description = "Style guide for Docker documentation describing standards and con keywords = ["style, guide, docker, documentation"] [menu.main] parent = "mn_opensource" +weight=100 +++ diff --git a/docs/project/find-an-issue.md b/docs/project/find-an-issue.md index d1d45d725b..590795c22d 100644 --- a/docs/project/find-an-issue.md +++ b/docs/project/find-an-issue.md @@ -1,10 +1,11 @@ diff --git a/docs/project/review-pr.md b/docs/project/review-pr.md index a61a6be13d..841431b42a 100644 --- a/docs/project/review-pr.md +++ b/docs/project/review-pr.md @@ -5,6 +5,7 @@ description = "Basic workflow for Docker contributions" keywords = ["contribute, pull request, review, workflow, beginner, squash, commit"] [menu.main] parent = "smn_contribute" +weight=5 +++ diff --git a/docs/project/set-up-dev-env.md b/docs/project/set-up-dev-env.md index e3f7753ce0..06e6c01100 100644 --- a/docs/project/set-up-dev-env.md +++ b/docs/project/set-up-dev-env.md @@ -5,6 +5,7 @@ description = "How to use Docker's development environment" keywords = ["development, inception, container, image Dockerfile, dependencies, Go, artifacts"] [menu.main] parent = "smn_develop" +weight=5 +++ diff --git a/docs/project/set-up-git.md b/docs/project/set-up-git.md index 41e1a5295c..93cd0b351a 100644 --- a/docs/project/set-up-git.md +++ b/docs/project/set-up-git.md @@ -5,6 +5,7 @@ description = "Describes how to set up your local machine and repository" keywords = ["GitHub account, repository, clone, fork, branch, upstream, Git, Go, make "] [menu.main] parent = "smn_develop" +weight=4 +++ diff --git a/docs/project/software-req-win.md b/docs/project/software-req-win.md index 97e78ce56c..ef72200560 100644 --- a/docs/project/software-req-win.md +++ b/docs/project/software-req-win.md @@ -5,6 +5,7 @@ description = "How to set up a server to test Docker Windows client" keywords = ["development, inception, container, image Dockerfile, dependencies, Go, artifacts, windows"] [menu.main] parent = "smn_develop" +weight=3 +++ diff --git a/docs/project/software-required.md b/docs/project/software-required.md index 5a3173cf94..cbe10a830f 100644 --- a/docs/project/software-required.md +++ b/docs/project/software-required.md @@ -5,6 +5,7 @@ description = "Describes the software required to contribute to Docker" keywords = ["GitHub account, repository, Docker, Git, Go, make, "] [menu.main] parent = "smn_develop" +weight=2 +++ diff --git a/docs/project/test-and-docs.md b/docs/project/test-and-docs.md index 1382b356b0..7b0a59f322 100644 --- a/docs/project/test-and-docs.md +++ b/docs/project/test-and-docs.md @@ -4,7 +4,8 @@ title = "Run tests and test documentation" description = "Describes Docker's testing infrastructure" keywords = ["make test, make docs, Go tests, gofmt, contributing, running tests"] [menu.main] -parent = "smn_contribute" +parent = "smn_develop" +weight=6 +++ diff --git a/docs/project/work-issue.md b/docs/project/work-issue.md index 7d5c3b7525..6f13c2c179 100644 --- a/docs/project/work-issue.md +++ b/docs/project/work-issue.md @@ -5,6 +5,7 @@ description = "Basic workflow for Docker contributions" keywords = ["contribute, pull request, review, workflow, beginner, squash, commit"] [menu.main] parent = "smn_contribute" +weight=3 +++ diff --git a/docs/reference/api/docker_remote_api_v1.10.md b/docs/reference/api/docker_remote_api_v1.10.md index b9b29d5bf6..bf617fe3cb 100644 --- a/docs/reference/api/docker_remote_api_v1.10.md +++ b/docs/reference/api/docker_remote_api_v1.10.md @@ -1,5 +1,6 @@ diff --git a/docs/reference/api/docker_remote_api_v1.15.md b/docs/reference/api/docker_remote_api_v1.15.md index 2babf795c4..b874566fd3 100644 --- a/docs/reference/api/docker_remote_api_v1.15.md +++ b/docs/reference/api/docker_remote_api_v1.15.md @@ -5,6 +5,7 @@ description = "API Documentation for Docker" keywords = ["API, Docker, rcli, REST, documentation"] [menu.main] parent = "smn_remoteapi" +weight = 6 +++ diff --git a/docs/reference/api/docker_remote_api_v1.16.md b/docs/reference/api/docker_remote_api_v1.16.md index ef57a439dc..7b5af951e3 100644 --- a/docs/reference/api/docker_remote_api_v1.16.md +++ b/docs/reference/api/docker_remote_api_v1.16.md @@ -5,6 +5,7 @@ description = "API Documentation for Docker" keywords = ["API, Docker, rcli, REST, documentation"] [menu.main] parent = "smn_remoteapi" +weight = 5 +++ diff --git a/docs/reference/api/docker_remote_api_v1.17.md b/docs/reference/api/docker_remote_api_v1.17.md index 5ae73bde30..6efd29c824 100644 --- a/docs/reference/api/docker_remote_api_v1.17.md +++ b/docs/reference/api/docker_remote_api_v1.17.md @@ -5,6 +5,7 @@ description = "API Documentation for Docker" keywords = ["API, Docker, rcli, REST, documentation"] [menu.main] parent = "smn_remoteapi" +weight = 4 +++ diff --git a/docs/reference/api/docker_remote_api_v1.18.md b/docs/reference/api/docker_remote_api_v1.18.md index 072ec356b4..9a3fae8fea 100644 --- a/docs/reference/api/docker_remote_api_v1.18.md +++ b/docs/reference/api/docker_remote_api_v1.18.md @@ -5,6 +5,7 @@ description = "API Documentation for Docker" keywords = ["API, Docker, rcli, REST, documentation"] [menu.main] parent = "smn_remoteapi" +weight = 3 +++ diff --git a/docs/reference/api/docker_remote_api_v1.19.md b/docs/reference/api/docker_remote_api_v1.19.md index ea4c1fa5a9..e6bda81fc9 100644 --- a/docs/reference/api/docker_remote_api_v1.19.md +++ b/docs/reference/api/docker_remote_api_v1.19.md @@ -5,6 +5,7 @@ description = "API Documentation for Docker" keywords = ["API, Docker, rcli, REST, documentation"] [menu.main] parent = "smn_remoteapi" +weight = 2 +++ diff --git a/docs/reference/api/docker_remote_api_v1.20.md b/docs/reference/api/docker_remote_api_v1.20.md index bf9be3c3a5..e1f3ed2c00 100644 --- a/docs/reference/api/docker_remote_api_v1.20.md +++ b/docs/reference/api/docker_remote_api_v1.20.md @@ -5,6 +5,7 @@ description = "API Documentation for Docker" keywords = ["API, Docker, rcli, REST, documentation"] [menu.main] parent="smn_remoteapi" +weight = 1 +++ diff --git a/docs/reference/api/hub_registry_spec.md b/docs/reference/api/hub_registry_spec.md index 6459e94cc9..adcd9d582e 100644 --- a/docs/reference/api/hub_registry_spec.md +++ b/docs/reference/api/hub_registry_spec.md @@ -1,14 +1,14 @@ -# The Docker Hub and the Registry 1.0 spec +# The Docker Hub and the Registry v1 ## The three roles diff --git a/docs/reference/api/registry_api.md b/docs/reference/api/registry_api.md index b43b1e7775..9da7cae683 100644 --- a/docs/reference/api/registry_api.md +++ b/docs/reference/api/registry_api.md @@ -1,6 +1,7 @@ e26efd418c48 -Step 1 : RUN yum install httpd - ---> Running in cf274900ea35 - -One of the configured repositories failed (Fedora 21 - x86_64), -and yum doesn't have enough cached data to continue. At this point the only -safe thing yum can do is fail. There are a few ways to work "fix" this: - -[output truncated] -``` - - -**Affected Versions**: All previous versions of Docker Engine when SELinux -is enabled. - -Docker **highly recommends** that all customers running previous versions of -Docker Engine update to this release. - -#### **How to workaround this issue** - -Customers who choose not to install this update have two options. The -first option is to disable SELinux. This is *not recommended* for production -systems where SELinux is typically required. - -The second option is to pass the following parameter in to `docker run`. - - --security-opt=label:type:docker_t - -This parameter cannot be passed to the `docker build` command. - -#### **Upgrade notes** - -When upgrading, make sure you stop DHE first, perform the Engine upgrade, and -then restart DHE. - -If you are running with SELinux enabled, previous Docker Engine releases allowed -you to bind-mount additional volumes or files inside the container as follows: - - $ docker run -it -v /home/user/foo.txt:/foobar.txt:ro - -In the 1.6.2-cs5 release, you must ensure additional bind-mounts have the correct -SELinux context. For example, if you want to mount `foobar.txt` as read-only -into the container, do the following to create and test your bind-mount: - -1. Add the `z` option to the bind mount when you specify `docker run`. - - $ docker run -it -v /home/user/foo.txt:/foobar.txt:ro,z - -2. Exec into your new container. - - For example, if your container is `bashful_curie`, open a shell on the - container: - - $ docker exec -it bashful_curie bash - -3. Use `cat` to check the permissions on the mounted file. - - $ cat /foobar.txt - the contents of foobar appear - - If you see the file's contents, your mount succeeded. If you receive a - `Permission denied` message and/or the `/var/log/audit/audit.log` file on - your Docker host contains an AVC Denial message, the mount did not succeed. - - type=AVC msg=audit(1432145409.197:7570): avc: denied { read } for pid=21167 comm="cat" name="foobar.txt" dev="xvda2" ino=17704136 scontext=system_u:system_r:svirt_lxc_net_t:s0:c909,c965 tcontext=unconfined_u:object_r:user_home_t:s0 tclass=file - - Recheck your command line to make sure you passed in the `z` option. - - -### CS Docker Engine 1.6.2-cs4 -(13 May 2015) - -Fix mount regression for `/sys`. - -### CS Docker Engine 1.6.1-cs3 -(11 May 2015) - -Docker Engine version 1.6.1 has been released to address several vulnerabilities -and is immediately available for all supported platforms. Users are advised to -upgrade existing installations of the Docker Engine and use 1.6.1 for new installations. - -It should be noted that each of the vulnerabilities allowing privilege escalation -may only be exploited by a malicious Dockerfile or image. Users are advised to -run their own images and/or images built by trusted parties, such as those in -the official images library. - -Please send any questions to security@docker.com. - - -#### **[CVE-2015-3629](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2015-3629) Symlink traversal on container respawn allows local privilege escalation** - -Libcontainer version 1.6.0 introduced changes which facilitated a mount namespace -breakout upon respawn of a container. This allowed malicious images to write -files to the host system and escape containerization. - -Libcontainer and Docker Engine 1.6.1 have been released to address this -vulnerability. Users running untrusted images are encouraged to upgrade Docker Engine. - -Discovered by Tõnis Tiigi. - - -#### **[CVE-2015-3627](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2015-3627) Insecure opening of file-descriptor 1 leading to privilege escalation** - -The file-descriptor passed by libcontainer to the pid-1 process of a container -has been found to be opened prior to performing the chroot, allowing insecure -open and symlink traversal. This allows malicious container images to trigger -a local privilege escalation. - -Libcontainer and Docker Engine 1.6.1 have been released to address this -vulnerability. Users running untrusted images are encouraged to upgrade -Docker Engine. - -Discovered by Tõnis Tiigi. - -#### **[CVE-2015-3630](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2015-3630) Read/write proc paths allow host modification & information disclosure** - -Several paths underneath /proc were writable from containers, allowing global -system manipulation and configuration. These paths included `/proc/asound`, -`/proc/timer_stats`, `/proc/latency_stats`, and `/proc/fs`. - -By allowing writes to `/proc/fs`, it has been noted that CIFS volumes could be -forced into a protocol downgrade attack by a root user operating inside of a -container. Machines having loaded the timer_stats module were vulnerable to -having this mechanism enabled and consumed by a container. - -We are releasing Docker Engine 1.6.1 to address this vulnerability. All -versions up to 1.6.1 are believed vulnerable. Users running untrusted -images are encouraged to upgrade. - -Discovered by Eric Windisch of the Docker Security Team. - -#### **[CVE-2015-3631](https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2015-3631) Volume mounts allow LSM profile escalation** - -By allowing volumes to override files of `/proc` within a mount namespace, a user -could specify arbitrary policies for Linux Security Modules, including setting -an unconfined policy underneath AppArmor, or a `docker_t` policy for processes -managed by SELinux. In all versions of Docker up until 1.6.1, it is possible for -malicious images to configure volume mounts such that files of proc may be overridden. - -We are releasing Docker Engine 1.6.1 to address this vulnerability. All versions -up to 1.6.1 are believed vulnerable. Users running untrusted images are encouraged -to upgrade. - -Discovered by Eric Windisch of the Docker Security Team. - -#### **AppArmor policy improvements** - -The 1.6.1 release also marks preventative additions to the AppArmor policy. -Recently, several CVEs against the kernel have been reported whereby mount -namespaces could be circumvented through the use of the sys_mount syscall from -inside of an unprivileged Docker container. In all reported cases, the -AppArmor policy included in libcontainer and shipped with Docker has been -sufficient to deflect these attacks. However, we have deemed it prudent to -proactively tighten the policy further by outright denying the use of the -`sys_mount` syscall. - -Because this addition is preventative, no CVE-ID is requested. - -### CS Docker Engine 1.6.0-cs2 -(23 Apr 2015) - -- First release, please see the [Docker Engine 1.6.0 Release notes](/release-notes/) - for more details. diff --git a/docs/touch-up.sh b/docs/touch-up.sh new file mode 100755 index 0000000000..1dd0b1dc52 --- /dev/null +++ b/docs/touch-up.sh @@ -0,0 +1,20 @@ +#!/bin/bash -e + + +# Sed to process GitHub Markdown +# 1-2 Remove comment code from metadata block +# +for i in ls -l /docs/content/* + do # Line breaks are important + if [ -d $i ] # Spaces are important + then + y=${i##*/} + find $i -type f -name "*.md" -exec sed -i.old \ + -e '/^/g' \ + -e '/^/g' {} \; + fi +done + + + + diff --git a/docs/userguide/dockerizing.md b/docs/userguide/dockerizing.md index bd96736ffa..515c601118 100644 --- a/docs/userguide/dockerizing.md +++ b/docs/userguide/dockerizing.md @@ -15,7 +15,9 @@ parent = "smn_applied" Docker allows you to run applications inside containers. Running an application inside a container takes a single command: `docker run`. -{{ include "no-remote-sudo.md" }} +> **Note:** if you are using a remote Docker daemon, such as Boot2Docker, +> then _do not_ type the `sudo` before the `docker` commands shown in the +> documentation's examples. ## Hello world diff --git a/docs/userguide/index.md b/docs/userguide/index.md index c5fcdd55cd..0e5819db7b 100644 --- a/docs/userguide/index.md +++ b/docs/userguide/index.md @@ -1,6 +1,5 @@ diff --git a/docs/userguide/level2.md b/docs/userguide/level2.md index fa8408cb62..5f640d4097 100644 --- a/docs/userguide/level2.md +++ b/docs/userguide/level2.md @@ -1,11 +1,8 @@