kotovalexarian-likes-github/moby--moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
Code Releases Activity
moby--moby/docs/mkdocs.yml

231 lines
13 KiB
YAML
Raw Normal View History

move the documentation to markdown Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit) Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
2014-04-15 02:01:25 -04:00
site_name: Docker Documentation
Updates to Compose docs and ENV vars - Compose teamhad forgotten some documentation - Updated ENV for Distribution also - Forgot one of the readability sections Signed-off-by: Mary Anthony <mary@docker.com>
2015-04-17 15:53:30 -04:00
#site_url: http://docs.docker.com/
move the documentation to markdown Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit) Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
2014-04-15 02:01:25 -04:00
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'
update go import path and libcontainer Docker-DCO-1.1-Signed-off-by: Victor Vieux <vieux@docker.com> (github: vieux)
2014-07-24 18:19:50 -04:00
repo_url: https://github.com/docker/docker/
move the documentation to markdown Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit) Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
2014-04-15 02:01:25 -04:00
docs_dir: sources
include_search: true
use_absolute_urls: true
# theme: docker
theme_dir: ./theme/mkdocs/
theme_center_lead: false
update copyrights to 2015 Signed-off-by: Victor Vieux <vieux@docker.com>
2015-01-12 17:47:36 -05:00
copyright: Copyright &copy; 2014-2015, Docker, Inc.
move the documentation to markdown Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit) Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
2014-04-15 02:01:25 -04:00
google_analytics: ['UA-6096819-11', 'docker.io']
pages:
# Introduction:
- ['index.md', 'About', 'Docker']
- ['introduction/understanding-docker.md', 'About', 'Understanding Docker']
Adding back in Glossary Signed-off-by: Mary Anthony <mary@docker.com>
2015-05-25 10:39:27 -04:00
- ['release-notes.md', 'About', 'Release notes']
- ['reference/glossary.md', 'About', 'Glossary']
- ['introduction/index.md', '**HIDDEN**']
Experimental features placeholder Signed-off-by: Mary Anthony <mary@docker.com> Adding experimental features into the mix Signed-off-by: Mary Anthony <mary@docker.com> renaming file Signed-off-by: Mary Anthony <mary@docker.com>
2015-05-18 09:17:07 -04:00
move the documentation to markdown Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit) Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
2014-04-15 02:01:25 -04:00
# Installation:
- ['installation/index.md', '**HIDDEN**']
- ['installation/ubuntulinux.md', 'Installation', 'Ubuntu']
# This is a combination of 2 commits. # The first commit's message is: Updating Ubuntu installation to use wget; eliminating elo Signed-off-by: Mary Anthony <mary.anthony@docker.com> # This is the 2nd commit message: Adding in James comments Signed-off-by: Mary Anthony <mary@docker.com>
2015-03-12 18:23:56 -04:00
- ['installation/mac.md', 'Installation', 'Mac OS X']
Add Kitematic documentation to docs.master.docker.com Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-05-19 01:10:06 -04:00
- ['kitematic/index.md', 'Installation', 'Kitematic on OS X']
# This is a combination of 2 commits. # The first commit's message is: Updating Ubuntu installation to use wget; eliminating elo Signed-off-by: Mary Anthony <mary.anthony@docker.com> # This is the 2nd commit message: Adding in James comments Signed-off-by: Mary Anthony <mary@docker.com>
2015-03-12 18:23:56 -04:00
- ['installation/windows.md', 'Installation', 'Microsoft Windows']
add initial docs for windows client testing Docker-DCO-1.1-Signed-off-by: Jessie Frazelle <princess@docker.com> (github: jfrazelle) Docker-DCO-1.1-Signed-off-by: Jessie Frazelle <jess@docker.com> (github: jfrazelle) docs: crop and optimize images Cropped and optimized images. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> Docker-DCO-1.1-Signed-off-by: Jessie Frazelle <princess@docker.com> (github: jfrazelle) Testing and updating the Windows material Signed-off-by: Mary Anthony <mary@docker.com> checkpoint Signed-off-by: Mary Anthony <mary@docker.com> Fitting the Windows specific material into the contributor guide Signed-off-by: Mary Anthony <mary@docker.com> Entering James comments Signed-off-by: Mary Anthony <mary@docker.com>
2015-03-10 14:21:09 -04:00
- ['installation/testing-windows-docker-client.md', 'Installation', 'Building and testing the Windows Docker client']
# This is a combination of 2 commits. # The first commit's message is: Updating Ubuntu installation to use wget; eliminating elo Signed-off-by: Mary Anthony <mary.anthony@docker.com> # This is the 2nd commit message: Adding in James comments Signed-off-by: Mary Anthony <mary@docker.com>
2015-03-12 18:23:56 -04:00
- ['installation/amazon.md', 'Installation', 'Amazon EC2']
- ['installation/archlinux.md', 'Installation', 'Arch Linux']
- ['installation/binaries.md', 'Installation', 'Binaries']
Squashed for pull request Updated documentation to include CentOS installation instructions. Extraneous line removal, description change Docker-DCO-1.1-Signed-off-by: Jim Perrin <jperrin@centos.org> (github: jimperrin)
2014-05-23 09:53:11 -04:00
- ['installation/centos.md', 'Installation', 'CentOS']
# This is a combination of 2 commits. # The first commit's message is: Updating Ubuntu installation to use wget; eliminating elo Signed-off-by: Mary Anthony <mary.anthony@docker.com> # This is the 2nd commit message: Adding in James comments Signed-off-by: Mary Anthony <mary@docker.com>
2015-03-12 18:23:56 -04:00
- ['installation/cruxlinux.md', 'Installation', 'CRUX Linux']
Added basic Debian installation page Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-05-17 16:28:39 -04:00
- ['installation/debian.md', 'Installation', 'Debian']
# This is a combination of 2 commits. # The first commit's message is: Updating Ubuntu installation to use wget; eliminating elo Signed-off-by: Mary Anthony <mary.anthony@docker.com> # This is the 2nd commit message: Adding in James comments Signed-off-by: Mary Anthony <mary@docker.com>
2015-03-12 18:23:56 -04:00
- ['installation/fedora.md', 'Installation', 'Fedora']
- ['installation/frugalware.md', 'Installation', 'FrugalWare']
move the documentation to markdown Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit) Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
2014-04-15 02:01:25 -04:00
- ['installation/google.md', 'Installation', 'Google Cloud Platform']
# This is a combination of 2 commits. # The first commit's message is: Updating Ubuntu installation to use wget; eliminating elo Signed-off-by: Mary Anthony <mary.anthony@docker.com> # This is the 2nd commit message: Adding in James comments Signed-off-by: Mary Anthony <mary@docker.com>
2015-03-12 18:23:56 -04:00
- ['installation/gentoolinux.md', 'Installation', 'Gentoo']
move the documentation to markdown Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit) Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
2014-04-15 02:01:25 -04:00
- ['installation/softlayer.md', 'Installation', 'IBM Softlayer']
updated text per recommendations in https://github.com/docker/docker/pull/11062#issuecomment-82435939 Signed-off-by: Casey Bisson <casey.bisson@joyent.com>
2015-03-20 17:44:24 -04:00
- ['installation/joyent.md', 'Installation', 'Joyent Compute Service']
docs: Add Azure installation instructions Adding instructions that refers to the Microsoft Azure documentation on creating Docker-ready Linux VMs on Azure platform. Signed-off-by: Ahmet Alp Balkan <ahmetalpbalkan@gmail.com>
2015-03-16 03:41:27 -04:00
- ['installation/azure.md', 'Installation', 'Microsoft Azure']
# This is a combination of 2 commits. # The first commit's message is: Updating Ubuntu installation to use wget; eliminating elo Signed-off-by: Mary Anthony <mary.anthony@docker.com> # This is the 2nd commit message: Adding in James comments Signed-off-by: Mary Anthony <mary@docker.com>
2015-03-12 18:23:56 -04:00
- ['installation/rackspace.md', 'Installation', 'Rackspace Cloud']
- ['installation/rhel.md', 'Installation', 'Red Hat Enterprise Linux']
- ['installation/oracle.md', 'Installation', 'Oracle Linux']
redirect openSUSE docs to SUSE doc Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
2014-12-17 18:05:27 -05:00
- ['installation/SUSE.md', 'Installation', 'SUSE']
Manually place the orchestration docs into the menu Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-25 07:35:08 -05:00
- ['compose/install.md', 'Installation', 'Docker Compose']
move the documentation to markdown Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit) Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
2014-04-15 02:01:25 -04:00
Adding User Guide * Added User Guide section outlines. * Added User Guide to menu. * Moved HTTPS example to articles. * Replaced Hello World example with User Guide. * Moved use cases out of examples. * Updated Introduction to add User Guide. * Redirected migrated /use and /articles links. * Added Docker.io section * Added Dockerized section * Added Using Docker section * Added Docker Images section * Added Docker Links section * Added Docker Volumes section Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-05-21 17:05:19 -04:00
# User Guide:
Makes headings in documentation consistent Fixes #10673. Signed-off-by: Rick Wieman <git@rickw.nl>
2015-04-21 11:50:09 -04:00
- ['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' ]
Adding User Guide * Added User Guide section outlines. * Added User Guide to menu. * Moved HTTPS example to articles. * Replaced Hello World example with User Guide. * Moved use cases out of examples. * Updated Introduction to add User Guide. * Redirected migrated /use and /articles links. * Added Docker.io section * Added Dockerized section * Added Using Docker section * Added Docker Images section * Added Docker Links section * Added Docker Volumes section Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-05-21 17:05:19 -04:00
- ['userguide/dockerlinks.md', 'User Guide', 'Linking containers together' ]
- ['userguide/dockervolumes.md', 'User Guide', 'Managing data in containers' ]
Updating with Sven's comments and other tweaks Signed-off-by: Mary Anthony <mary@docker.com>
2015-03-17 00:49:33 -04:00
- ['userguide/labels-custom-metadata.md', 'User Guide', 'Apply custom metadata' ]
Initial links Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-06-01 16:48:04 -04:00
- ['userguide/dockerrepos.md', 'User Guide', 'Working with Docker Hub' ]
Squashed commit of the following: commit 3f9e9185fe7ee51f2fe55f0fc0d4fffdc4f289dc Author: Nathan Hsieh <hsieh.nathan@gmail.com> Date: Mon Oct 6 10:57:35 2014 -0700 changed the title of back buttons commit f86934424e85931ec293e711ceaa93ee920828fb Author: Nathan Hsieh <hsieh.nathan@gmail.com> Date: Mon Oct 6 10:53:15 2014 -0700 Finished level 2, refactored tests commit 8f502bce05293cccaf200b69ce5f5826eee72484 Author: Nathan Hsieh <hsieh.nathan@gmail.com> Date: Mon Oct 6 08:52:37 2014 -0700 stylized better and added level 2 commit 07b2276b346c34c0cc0faa57500c40e120e77888 Author: Nathan Hsieh <hsieh.nathan@gmail.com> Date: Fri Oct 3 18:17:29 2014 -0700 broke tutorial tests styles commit 35d84147dc2f65b0ffeea5faf304add903219b1e Author: Nathan Hsieh <hsieh.nathan@gmail.com> Date: Fri Oct 3 17:23:48 2014 -0700 structured test level1 md file commit 808d01b0d55d67eb1017f290a29da6c7d38565f2 Author: Nathan Hsieh <hsieh.nathan@gmail.com> Date: Fri Oct 3 17:15:46 2014 -0700 Modified files and integrated tutorial through new page commit 0f0093f2882489c3eeb6f8870f2b8aa64dc939a3 Author: Nathan Hsieh <hsieh.nathan@gmail.com> Date: Thu Oct 2 14:34:44 2014 -0700 more refactoring commit 5a9b98e55ebd455ccf2c0ced20f984545a0b6d71 Author: Nathan Hsieh <hsieh.nathan@gmail.com> Date: Thu Oct 2 11:46:58 2014 -0700 clean js code commit af3bbd8d5e1dffdaa1780f83b909ff566906e513 Author: Nathan Hsieh <hsieh.nathan@gmail.com> Date: Thu Oct 2 11:26:39 2014 -0700 level 1 cleanup commit c4852a7766ab4fbd978d65c8352ace05eb427ef5 Author: Nathan Hsieh <hsieh.nathan@gmail.com> Date: Thu Oct 2 11:20:17 2014 -0700 fixed up fill-in level1 commit 7f02d80942549dec9c05f784b777fcb32d5bb81b Author: Nathan Hsieh <hsieh.nathan@gmail.com> Date: Wed Oct 1 17:45:42 2014 -0700 added dockerfile tut, stylized lesson1 Questions Signed-off-by: Nathan Hsieh <hsieh.nathan@gmail.com>
2014-10-06 14:57:09 -04:00
- ['userguide/level1.md', '**HIDDEN**' ]
- ['userguide/level2.md', '**HIDDEN**' ]
Manually place the orchestration docs into the menu Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-25 07:35:08 -05:00
- ['compose/index.md', 'User Guide', 'Docker Compose' ]
Updates to Compose docs and ENV vars - Compose teamhad forgotten some documentation - Updated ENV for Distribution also - Forgot one of the readability sections Signed-off-by: Mary Anthony <mary@docker.com>
2015-04-17 15:53:30 -04:00
- ['compose/production.md', 'User Guide', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp; Use Compose in production' ]
- ['compose/extends.md', 'User Guide', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp; Extend Compose services' ]
Manually place the orchestration docs into the menu Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-25 07:35:08 -05:00
- ['machine/index.md', 'User Guide', 'Docker Machine' ]
- ['swarm/index.md', 'User Guide', 'Docker Swarm' ]
Add Kitematic documentation to docs.master.docker.com Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-05-19 01:10:06 -04:00
- ['kitematic/userguide.md', 'User Guide', 'Kitematic']
move the documentation to markdown Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit) Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
2014-04-15 02:01:25 -04:00
Initial links Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-06-01 16:48:04 -04:00
# Docker Hub docs:
- ['docker-hub/index.md', 'Docker Hub', 'Docker Hub' ]
- ['docker-hub/accounts.md', 'Docker Hub', 'Accounts']
Add a userguide to cover the uses of Hub before creating new repositories Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-05-04 01:25:47 -04:00
- ['docker-hub/userguide.md', 'Docker Hub', 'User Guide']
- ['docker-hub/repos.md', 'Docker Hub', 'Your Repositories']
Initial links Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-06-01 16:48:04 -04:00
- ['docker-hub/builds.md', 'Docker Hub', 'Automated Builds']
Rewrite Official Repositories page. The existing page is focused on listing a set of requirements for proposing a new repository. This information has become outdated and is duplicated in the `docker-library/official-images` and `docker-library/docs` GitHub repositories. This PR rewrites the Official Repositories page to describe what they actually are, and defers to GitHub/IRC for the subset of users that are interested in contributing. I also removed the requirement to contact partners@docker.com and made it optional to reduce the barrier to entry. Signed-off-by: Peter Salvatore <peter@psftw.com>
2015-04-21 23:36:27 -04:00
- ['docker-hub/official_repos.md', 'Docker Hub', 'Official Repositories']
Adding User Guide * Added User Guide section outlines. * Added User Guide to menu. * Moved HTTPS example to articles. * Replaced Hello World example with User Guide. * Moved use cases out of examples. * Updated Introduction to add User Guide. * Redirected migrated /use and /articles links. * Added Docker.io section * Added Dockerized section * Added Using Docker section * Added Docker Images section * Added Docker Links section * Added Docker Volumes section Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-05-21 17:05:19 -04:00
Copy over the DHE documentation for release to docs.docker.com Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-04-16 01:04:47 -04:00
# 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', '&nbsp;&nbsp;Installation' ]
- ['docker-hub-enterprise/configuration.md', 'Docker Hub Enterprise', '&nbsp;&nbsp;Configuration options' ]
- ['docker-hub-enterprise/support.md', 'Docker Hub Enterprise', 'Support' ]
DHE 1.0.1 release Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-05-11 17:23:56 -04:00
- ['docker-hub-enterprise/release-notes.md', 'Docker Hub Enterprise', 'Release notes' ]
DHE documentation placeholder and Navbar changes Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-01-29 05:35:37 -05:00
Adding User Guide * Added User Guide section outlines. * Added User Guide to menu. * Moved HTTPS example to articles. * Replaced Hello World example with User Guide. * Moved use cases out of examples. * Updated Introduction to add User Guide. * Redirected migrated /use and /articles links. * Added Docker.io section * Added Dockerized section * Added Using Docker section * Added Docker Images section * Added Docker Links section * Added Docker Volumes section Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-05-21 17:05:19 -04:00
# 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']
update the mkdocs.yml to add new docs Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-25 18:46:55 -05:00
- ['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']
Add Kitematic documentation to docs.master.docker.com Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-05-19 01:10:06 -04:00
- ['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']
Adding User Guide * Added User Guide section outlines. * Added User Guide to menu. * Moved HTTPS example to articles. * Replaced Hello World example with User Guide. * Moved use cases out of examples. * Updated Introduction to add User Guide. * Redirected migrated /use and /articles links. * Added Docker.io section * Added Dockerized section * Added Using Docker section * Added Docker Images section * Added Docker Links section * Added Docker Volumes section Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-05-21 17:05:19 -04:00
# 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']
Add the registry mirror document to the menu Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@docker.com> (github: SvenDowideit)
2015-01-27 19:47:11 -05:00
- ['articles/registry_mirror.md', 'Articles', 'Run a local registry mirror']
Adding new Dockerfile Best Practices doc, and links thereto. Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)
2014-09-23 17:21:00 -04:00
- ['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']
Add support for client certificates for registries This lets you specify custom client TLS certificates and CA root for a specific registry hostname. Docker will then verify the registry against the CA and present the client cert when talking to that registry. This allows the registry to verify that the client has a proper key, indicating that the client is allowed to access the images. A custom cert is configured by creating a directory in /etc/docker/certs.d with the same name as the registry hostname. Inside this directory all *.crt files are added as CA Roots (if none exists, the system default is used) and pair of files <filename>.key and <filename>.cert indicate a custom certificate to present to the registry. If there are multiple certificates each one will be tried in alphabetical order, proceeding to the next if we get a 403 of 5xx response. So, an example setup would be: /etc/docker/certs.d/ └── localhost ├── client.cert ├── client.key └── localhost.crt A simple way to test this setup is to use an apache server to host a registry. Just copy a registry tree into the apache root, here is an example one containing the busybox image: http://people.gnome.org/~alexl/v1.tar.gz Then add this conf file as /etc/httpd/conf.d/registry.conf: # This must be in the root context, otherwise it causes a re-negotiation # which is not supported by the tls implementation in go SSLVerifyClient optional_no_ca <Location /v1> Action cert-protected /cgi-bin/cert.cgi SetHandler cert-protected Header set x-docker-registry-version "0.6.2" SetEnvIf Host (.*) custom_host=$1 Header set X-Docker-Endpoints "%{custom_host}e" </Location> And this as /var/www/cgi-bin/cert.cgi #!/bin/bash if [ "$HTTPS" != "on" ]; then echo "Status: 403 Not using SSL" echo "x-docker-registry-version: 0.6.2" echo exit 0 fi if [ "$SSL_CLIENT_VERIFY" == "NONE" ]; then echo "Status: 403 Client certificate invalid" echo "x-docker-registry-version: 0.6.2" echo exit 0 fi echo "Content-length: $(stat --printf='%s' $PATH_TRANSLATED)" echo "x-docker-registry-version: 0.6.2" echo "X-Docker-Endpoints: $SERVER_NAME" echo "X-Docker-Size: 0" echo cat $PATH_TRANSLATED This will return 403 for all accessed to /v1 unless *any* client cert is presented. Obviously a real implementation would verify more details about the certificate. Example client certs can be generated with: openssl genrsa -out client.key 1024 openssl req -new -x509 -text -key client.key -out client.cert Docker-DCO-1.1-Signed-off-by: Alexander Larsson <alexl@redhat.com> (github: alexlarsson)
2013-12-04 09:03:51 -05:00
- ['articles/certificates.md', 'Articles', 'Using certificates for repository client verification']
Adding User Guide * Added User Guide section outlines. * Added User Guide to menu. * Moved HTTPS example to articles. * Replaced Hello World example with User Guide. * Moved use cases out of examples. * Updated Introduction to add User Guide. * Redirected migrated /use and /articles links. * Added Docker.io section * Added Dockerized section * Added Using Docker section * Added Docker Images section * Added Docker Links section * Added Docker Volumes section Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-05-21 17:05:19 -04:00
- ['articles/using_supervisord.md', 'Articles', 'Using Supervisor']
Add Configuring Docker article [WIP] Fixes #12088 Signed-off-by: Ankush Agarwal <ankushagarwal11@gmail.com>
2015-04-21 20:46:43 -04:00
- ['articles/configuring.md', 'Articles', 'Configuring Docker']
Adding User Guide * Added User Guide section outlines. * Added User Guide to menu. * Moved HTTPS example to articles. * Replaced Hello World example with User Guide. * Moved use cases out of examples. * Updated Introduction to add User Guide. * Redirected migrated /use and /articles links. * Added Docker.io section * Added Dockerized section * Added Using Docker section * Added Docker Images section * Added Docker Links section * Added Docker Volumes section Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-05-21 17:05:19 -04:00
- ['articles/cfengine_process_management.md', 'Articles', 'Process management with CFEngine']
- ['articles/puppet.md', 'Articles', 'Using Puppet']
- ['articles/chef.md', 'Articles', 'Using Chef']
add DSC article Docker-DCO-1.1-Signed-off-by: Andrew Weiss <andrew.weiss@outlook.com> (github: anweiss)
2014-06-30 15:35:30 -04:00
- ['articles/dsc.md', 'Articles', 'Using PowerShell DSC']
Adding new Dockerfile Best Practices doc, and links thereto. Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)
2014-09-23 17:21:00 -04:00
- ['articles/ambassador_pattern_linking.md', 'Articles', 'Cross-Host linking using ambassador containers']
Adding User Guide * Added User Guide section outlines. * Added User Guide to menu. * Moved HTTPS example to articles. * Replaced Hello World example with User Guide. * Moved use cases out of examples. * Updated Introduction to add User Guide. * Redirected migrated /use and /articles links. * Added Docker.io section * Added Dockerized section * Added Using Docker section * Added Docker Images section * Added Docker Links section * Added Docker Volumes section Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-05-21 17:05:19 -04:00
- ['articles/runmetrics.md', 'Articles', 'Runtime metrics']
Adding new Dockerfile Best Practices doc, and links thereto. Docker-DCO-1.1-Signed-off-by: Fred Lifton <fred.lifton@docker.com> (github: fredlf)
2014-09-23 17:21:00 -04:00
- ['articles/b2d_volume_resize.md', 'Articles', 'Increasing a Boot2Docker volume']
Extract the systemd docs from various places and add a little more Signed-off-by: Sven Dowideit <SvenDowideit@docker.com>
2014-11-25 23:09:52 -05:00
- ['articles/systemd.md', 'Articles', 'Controlling and configuring Docker using Systemd']
Improve (&restructure) Docker Index docs on the Docker docs. Docker-DCO-1.1-Signed-off-by: O.S. Tezer <ostezer@gmail.com> (github: ostezer)
2014-04-17 16:13:59 -04:00
move the documentation to markdown Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit) Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
2014-04-15 02:01:25 -04:00
# Reference
- ['reference/index.md', '**HIDDEN**']
make sure the intermediate index.html files are generated consistently Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2014-05-01 02:03:45 -04:00
- ['reference/commandline/index.md', '**HIDDEN**']
Add "Docker" to Reference pull-down for Command Line A minor thing, but I noticed that the "Reference" drop-down menu just says "Command line". This was fine when we just had one command line, but now there's also 'Compose command line' and I suspect we may add others later. We should qualify the Docker one with the word "Docker" in front Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-03-11 10:40:46 -04:00
- ['reference/commandline/cli.md', 'Reference', 'Docker command line']
move the documentation to markdown Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit) Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
2014-04-15 02:01:25 -04:00
- ['reference/builder.md', 'Reference', 'Dockerfile']
Adding the FAQ back Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-05-19 10:07:57 -04:00
- ['faq.md', 'Reference', 'FAQ']
Makes headings in documentation consistent Fixes #10673. Signed-off-by: Rick Wieman <git@rickw.nl>
2015-04-21 11:50:09 -04:00
- ['reference/run.md', 'Reference', 'Run reference']
journald log driver: use CONTAINER_ID field for container id This patch modifies the journald log driver to store the container ID in a field named CONTAINER_ID, rather than (ab)using the MESSAGE_ID field. Additionally, this adds the CONTAINER_ID_FULL field containing the complete container ID and CONTAINER_NAME, containing the container name. When using the journald log driver, this permits you to see log messages from a particular container like this: # journalctl CONTAINER_ID=a9238443e193 Example output from "journalctl -o verbose" includes the following: CONTAINER_ID=27aae7361e67 CONTAINER_ID_FULL=27aae7361e67e2b4d3864280acd2b80e78daf8ec73786d8b68f3afeeaabbd4c4 CONTAINER_NAME=web Closes: #12864 Signed-off-by: Lars Kellogg-Stedman <lars@redhat.com>
2015-04-28 21:23:27 -04:00
- ['reference/logging/journald.md', '**HIDDEN**']
Manually place the orchestration docs into the menu Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-25 07:35:08 -05:00
- ['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']
make sure the intermediate index.html files are generated consistently Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2014-05-01 02:03:45 -04:00
- ['reference/api/index.md', '**HIDDEN**']
Docker Registry Server > Docker Registry Fixing registry index Tested on beta and this redirect works Signed-off-by: Mary Anthony <mary@docker.com>
2015-04-18 20:42:24 -04:00
- ['registry/index.md', 'Reference', 'Docker Registry 2.0']
In with the old menu layout Signed-off-by: Mary Anthony <mary@docker.com>
2015-04-15 22:02:01 -04:00
- ['registry/deploying.md', 'Reference', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp; Deploy a registry' ]
- ['registry/configuration.md', 'Reference', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp; Configure a registry' ]
- ['registry/storagedrivers.md', 'Reference', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp; Storage driver model' ]
- ['registry/notifications.md', 'Reference', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp; Work with notifications' ]
- ['registry/spec/api.md', 'Reference', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp; Registry Service API v2' ]
- ['registry/spec/json.md', 'Reference', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp; JSON format' ]
- ['registry/spec/auth/token.md', 'Reference', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp; Authenticate via central service' ]
- ['reference/api/hub_registry_spec.md', 'Reference', 'Docker Hub and Registry 1.0']
- ['reference/api/registry_api.md', 'Reference', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp;Docker Registry API v1']
Makes headings in documentation consistent Fixes #10673. Signed-off-by: Rick Wieman <git@rickw.nl>
2015-04-21 11:50:09 -04:00
- ['reference/api/registry_api_client_libraries.md', 'Reference', '&nbsp;&nbsp;&nbsp;&nbsp;&blacksquare;&nbsp;Docker Registry 1.0 API client libraries']
In with the old menu layout Signed-off-by: Mary Anthony <mary@docker.com>
2015-04-15 22:02:01 -04:00
#- ['reference/image-spec-v1.md', 'Reference', 'Docker Image Specification v1.0.0']
Initial links Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-06-01 16:48:04 -04:00
- ['reference/api/docker-io_api.md', 'Reference', 'Docker Hub API']
Don't require Docker 1.5.0 for docker build -f docs/Dockerfile Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-24 19:37:36 -05:00
#- ['reference/image-spec-v1.md', 'Reference', 'Docker Image Specification v1.0.0']
move the documentation to markdown Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit) Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
2014-04-15 02:01:25 -04:00
- ['reference/api/docker_remote_api.md', 'Reference', 'Docker Remote API']
bump api version to 1.20 Signed-off-by: Jessica Frazelle <princess@docker.com>
2015-05-27 22:24:59 -04:00
- ['reference/api/docker_remote_api_v1.20.md', 'Reference', 'Docker Remote API v1.20']
Bring /info API doc in line with the actual response. The fix handles versions 1.18 and 1.19. Closes #13139. Signed-off-by: Raghuram Devarakonda <draghuram@gmail.com>
2015-05-18 13:43:02 -04:00
- ['reference/api/docker_remote_api_v1.19.md', 'Reference', 'Docker Remote API v1.19']
Bump api version to 1.18 Signed-off-by: Alexander Morozov <lk4d4@docker.com>
2015-02-10 13:48:54 -05:00
- ['reference/api/docker_remote_api_v1.18.md', 'Reference', 'Docker Remote API v1.18']
Make API docs v1.17 visible w/o this one-liner the v1.17 docs didn't appear in the Reference dropdown and I would get a 404 when I tried to access .../reference/api/docker_remote_api_v1.17/ Not sure if there are other spots that need to be fixed but this seemed to fix it for me. Signed-off-by: Doug Davis <dug@us.ibm.com>
2015-01-07 23:14:45 -05:00
- ['reference/api/docker_remote_api_v1.17.md', 'Reference', 'Docker Remote API v1.17']
Updates to Compose docs and ENV vars - Compose teamhad forgotten some documentation - Updated ENV for Distribution also - Forgot one of the readability sections Signed-off-by: Mary Anthony <mary@docker.com>
2015-04-17 15:53:30 -04:00
- ['reference/api/docker_remote_api_v1.16.md', 'Reference', 'Docker Remote API v1.16']
The reference menu is too big to list more than the latest API docs, so the others can be hidden - they're still linked from the API summary Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-02-02 23:03:03 -05:00
- ['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**']
Fixed API 1.12 links and misc other fixes Docker-DCO-1.1-Signed-off-by: James Turnbull <james@lovedthanlost.net> (github: jamtur01)
2014-06-08 20:59:22 -04:00
- ['reference/api/docker_remote_api_v1.10.md', '**HIDDEN**']
Force the older API docs to be generated. Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2014-05-01 20:46:41 -04:00
- ['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**']
Makes headings in documentation consistent Fixes #10673. Signed-off-by: Rick Wieman <git@rickw.nl>
2015-04-21 11:50:09 -04:00
- ['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']
Add Kitematic documentation to docs.master.docker.com Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au>
2015-05-19 01:10:06 -04:00
- ['kitematic/faq.md', 'Reference', 'Kitematic: FAQ']
- ['kitematic/known-issues.md', 'Reference', 'Kitematic: Known issues']
move the documentation to markdown Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit) Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
2014-04-15 02:01:25 -04:00
Fixing a few links in registry Signed-off-by: Mary Anthony <mary@docker.com>
2015-04-21 21:36:37 -04:00
# 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**' ]
move the documentation to markdown Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: SvenDowideit) Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@home.org.au> (github: )
2014-04-15 02:01:25 -04:00
- ['jsearch.md', '**HIDDEN**']
# - ['static_files/README.md', 'static_files', 'README']
Looking into some broken links, I noticed that we don't need to use relative paths, and also fixed some broken images. There are still more todo - next PR I think :) Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2014-04-24 08:12:21 -04:00
- ['terms/index.md', '**HIDDEN**']
remove rst/sphinx documentation Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2014-05-01 01:31:58 -04:00
- ['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**']
make sure the intermediate index.html files are generated consistently Docker-DCO-1.1-Signed-off-by: Sven Dowideit <SvenDowideit@fosiki.com> (github: SvenDowideit)
2014-05-01 02:03:45 -04:00
Fixing two bad files that got borked in the last rebase Signed-off-by: Mary Anthony <mary.anthony@docker.com>
2015-03-06 17:21:17 -05:00
Rewrite the Contributing tree as Project in preparation for the Docker birthday. Signed-off-by: Mary Anthony <mary.anthony@docker.com> Optimize images, remove old file, add metadata tagging Signed-off-by: Mary Anthony <mary.anthony@docker.com>
2015-03-06 13:01:31 -05:00
# Project:
- ['project/index.md', '**HIDDEN**']
add initial docs for windows client testing Docker-DCO-1.1-Signed-off-by: Jessie Frazelle <princess@docker.com> (github: jfrazelle) Docker-DCO-1.1-Signed-off-by: Jessie Frazelle <jess@docker.com> (github: jfrazelle) docs: crop and optimize images Cropped and optimized images. Signed-off-by: Sebastiaan van Stijn <github@gone.nl> Docker-DCO-1.1-Signed-off-by: Jessie Frazelle <princess@docker.com> (github: jfrazelle) Testing and updating the Windows material Signed-off-by: Mary Anthony <mary@docker.com> checkpoint Signed-off-by: Mary Anthony <mary@docker.com> Fitting the Windows specific material into the contributor guide Signed-off-by: Mary Anthony <mary@docker.com> Entering James comments Signed-off-by: Mary Anthony <mary@docker.com>
2015-03-10 14:21:09 -04:00
- ['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']
Copy permalink