144 lines
6.6 KiB
YAML
Executable File
144 lines
6.6 KiB
YAML
Executable File
site_name: Docker Documentation
|
|
#site_url: http://docs.docker.io/
|
|
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/dotcloud/docker/
|
|
|
|
docs_dir: sources
|
|
|
|
include_search: true
|
|
|
|
use_absolute_urls: true
|
|
|
|
# theme: docker
|
|
theme_dir: ./theme/mkdocs/
|
|
theme_center_lead: false
|
|
include_search: true
|
|
|
|
copyright: Copyright © 2014, Docker, Inc.
|
|
google_analytics: ['UA-6096819-11', 'docker.io']
|
|
|
|
pages:
|
|
|
|
# Introduction:
|
|
- ['index.md', 'About', 'Docker']
|
|
- ['introduction/index.md', '**HIDDEN**']
|
|
- ['introduction/understanding-docker.md', 'About', 'Understanding Docker']
|
|
- ['introduction/working-with-docker.md', 'About', 'Working with Docker']
|
|
|
|
# Installation:
|
|
- ['installation/index.md', '**HIDDEN**']
|
|
- ['installation/mac.md', 'Installation', 'Mac OS X']
|
|
- ['installation/ubuntulinux.md', 'Installation', 'Ubuntu']
|
|
- ['installation/rhel.md', 'Installation', 'Red Hat Enterprise Linux']
|
|
- ['installation/centos.md', 'Installation', 'CentOS']
|
|
- ['installation/debian.md', 'Installation', 'Debian']
|
|
- ['installation/gentoolinux.md', 'Installation', 'Gentoo']
|
|
- ['installation/google.md', 'Installation', 'Google Cloud Platform']
|
|
- ['installation/rackspace.md', 'Installation', 'Rackspace Cloud']
|
|
- ['installation/amazon.md', 'Installation', 'Amazon EC2']
|
|
- ['installation/softlayer.md', 'Installation', 'IBM Softlayer']
|
|
- ['installation/archlinux.md', 'Installation', 'Arch Linux']
|
|
- ['installation/frugalware.md', 'Installation', 'FrugalWare']
|
|
- ['installation/fedora.md', 'Installation', 'Fedora']
|
|
- ['installation/openSUSE.md', 'Installation', 'openSUSE']
|
|
- ['installation/cruxlinux.md', 'Installation', 'CRUX Linux']
|
|
- ['installation/windows.md', 'Installation', 'Microsoft Windows']
|
|
- ['installation/binaries.md', 'Installation', 'Binaries']
|
|
|
|
# Examples:
|
|
- ['use/index.md', '**HIDDEN**']
|
|
- ['use/basics.md', 'Examples', 'First steps with Docker']
|
|
- ['examples/index.md', '**HIDDEN**']
|
|
- ['examples/hello_world.md', 'Examples', 'Hello World']
|
|
- ['examples/nodejs_web_app.md', 'Examples', 'Node.js web application']
|
|
- ['examples/python_web_app.md', 'Examples', 'Python web application']
|
|
- ['examples/mongodb.md', 'Examples', 'Dockerizing MongoDB']
|
|
- ['examples/running_redis_service.md', 'Examples', 'Redis service']
|
|
- ['examples/postgresql_service.md', 'Examples', 'PostgreSQL service']
|
|
- ['examples/running_riak_service.md', 'Examples', 'Running a Riak service']
|
|
- ['examples/running_ssh_service.md', 'Examples', 'Running an SSH service']
|
|
- ['examples/couchdb_data_volumes.md', 'Examples', 'CouchDB service']
|
|
- ['examples/apt-cacher-ng.md', 'Examples', 'Apt-Cacher-ng service']
|
|
- ['examples/https.md', 'Examples', 'Running Docker with HTTPS']
|
|
- ['examples/using_supervisord.md', 'Examples', 'Using Supervisor']
|
|
- ['examples/cfengine_process_management.md', 'Examples', 'Process management with CFEngine']
|
|
- ['use/working_with_links_names.md', 'Examples', 'Linking containers together']
|
|
- ['use/working_with_volumes.md', 'Examples', 'Sharing Directories using volumes']
|
|
- ['use/puppet.md', 'Examples', 'Using Puppet']
|
|
- ['use/chef.md', 'Examples', 'Using Chef']
|
|
- ['use/workingwithrepository.md', 'Examples', 'Working with a Docker Repository']
|
|
- ['use/port_redirection.md', 'Examples', 'Redirect ports']
|
|
- ['use/ambassador_pattern_linking.md', 'Examples', 'Cross-Host linking using Ambassador Containers']
|
|
- ['use/host_integration.md', 'Examples', 'Automatically starting Containers']
|
|
|
|
#- ['user-guide/index.md', '**HIDDEN**']
|
|
# - ['user-guide/writing-your-docs.md', 'User Guide', 'Writing your docs']
|
|
# - ['user-guide/styling-your-docs.md', 'User Guide', 'Styling your docs']
|
|
# - ['user-guide/configuration.md', 'User Guide', 'Configuration']
|
|
# ./faq.md
|
|
|
|
# Docker.io docs:
|
|
- ['docker-io/index.md', '**HIDDEN**']
|
|
# - ['index/home.md', 'Docker Index', 'Help']
|
|
- ['docker-io/accounts.md', 'Docker.io', 'Accounts']
|
|
- ['docker-io/repos.md', 'Docker.io', 'Repositories']
|
|
- ['docker-io/builds.md', 'Docker.io', 'Trusted Builds']
|
|
|
|
# Reference
|
|
- ['reference/index.md', '**HIDDEN**']
|
|
- ['reference/commandline/index.md', '**HIDDEN**']
|
|
- ['reference/commandline/cli.md', 'Reference', 'Command line']
|
|
- ['reference/builder.md', 'Reference', 'Dockerfile']
|
|
- ['faq.md', 'Reference', 'FAQ']
|
|
- ['reference/run.md', 'Reference', 'Run Reference']
|
|
- ['articles/index.md', '**HIDDEN**']
|
|
- ['articles/runmetrics.md', 'Reference', 'Runtime metrics']
|
|
- ['articles/security.md', 'Reference', 'Security']
|
|
- ['articles/baseimages.md', 'Reference', 'Creating a Base Image']
|
|
- ['use/networking.md', 'Reference', 'Advanced networking']
|
|
- ['reference/api/index.md', '**HIDDEN**']
|
|
- ['reference/api/docker-io_api.md', 'Reference', 'Docker.io API']
|
|
- ['reference/api/registry_api.md', 'Reference', 'Docker Registry API']
|
|
- ['reference/api/registry_index_spec.md', 'Reference', 'Registry & Index Spec']
|
|
- ['reference/api/docker_remote_api.md', 'Reference', 'Docker Remote API']
|
|
- ['reference/api/docker_remote_api_v1.11.md', 'Reference', 'Docker Remote API v1.11']
|
|
- ['reference/api/docker_remote_api_v1.10.md', 'Reference', 'Docker Remote API v1.10']
|
|
- ['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_oauth_api.md', 'Reference', 'Docker IO OAuth API']
|
|
- ['reference/api/docker_io_accounts_api.md', 'Reference', 'Docker IO Accounts API']
|
|
|
|
- ['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**']
|
|
|
|
# TODO: our theme adds a dropdown even for sections that have no subsections.
|
|
#- ['faq.md', 'FAQ']
|
|
|
|
# Contribute:
|
|
- ['contributing/index.md', '**HIDDEN**']
|
|
- ['contributing/contributing.md', 'Contribute', 'Contributing']
|
|
- ['contributing/devenvironment.md', 'Contribute', 'Development environment']
|