| site_name: Docker Documentation |
| #site_url: http://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'] |
| # Experimental |
| - ['experimental/experimental.md', 'About', 'Experimental Features'] |
| - ['experimental/plugin_api.md', '**HIDDEN**'] |
| - ['experimental/plugins_volume.md', '**HIDDEN**'] |
| - ['experimental/plugins.md', '**HIDDEN**'] |
| - ['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.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'] |
| |
