mirror of
https://github.com/docker/docs.git
synced 2026-04-04 02:08:57 +07:00
980 lines
35 KiB
HTML
980 lines
35 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=no">
|
|
|
|
<meta name="docker_version" content="1.5.0">
|
|
<meta name="docker_git_branch" content="docs">
|
|
<meta name="docker_git_commit" content="35ea4de">
|
|
<meta name="docker_build_date" content="Fri Apr 10 23:25:55 UTC 2015">
|
|
|
|
<meta name="description" content="Compose CLI reference">
|
|
<meta name="keywords" content="fig, composition, compose, docker, orchestration, cli, reference">
|
|
|
|
<link rel="canonical" href="/compose/cli/">
|
|
<link href="/css/bootstrap-custom.css" rel="stylesheet">
|
|
<link href="/css/main.css" rel="stylesheet">
|
|
<link href="/css/prettify-1.0.css" rel="stylesheet">
|
|
<link rel="stylesheet" type="text/css" href="/css/dockerfile_tutorial.css">
|
|
<link href="/tipuesearch/tipuesearch.css" rel="stylesheet">
|
|
<link href="/css/docs.css" rel="stylesheet">
|
|
<link rel="shortcut icon" href="/img/favicon.png">
|
|
<title>Compose command line - Docker Documentation</title>
|
|
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
|
|
<!--[if lt IE 9]>
|
|
<script src="https://oss.maxcdn.com/libs/html5shiv/3.7.0/html5shiv.js"></script>
|
|
<script src="https://oss.maxcdn.com/libs/respond.js/1.3.0/respond.min.js"></script>
|
|
<![endif]-->
|
|
|
|
<script type="text/javascript">
|
|
(function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
|
|
(i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
|
|
m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
|
|
})(window,document,'script','//www.google-analytics.com/analytics.js','ga');
|
|
ga('create', 'UA-6096819-11', 'docker.com');
|
|
ga('require', 'linkid', 'linkid.js');
|
|
ga('send', 'pageview', {
|
|
'page': location.pathname + location.search + location.hash,
|
|
});
|
|
</script>
|
|
|
|
</head>
|
|
<body>
|
|
|
|
<div id="topmostnav" class="topmostnav_loggedout navbar navbar-static-top">
|
|
<div class="container">
|
|
<a href="/" title="Docker Docs Home"><div class="brand logo"><img src="/img/nav/docker-logo-loggedin.png"> </div></a>
|
|
<form id="nav_search" class="navbar-index-search pull-right" action="/jsearch/">
|
|
<span role="status" aria-live="polite" class="ui-helper-hidden-accessible"></span>
|
|
<input name="q" id="tipue_search_input" type="text" class="search_input search-query ui-autocomplete-input" placeholder="Search the Docs" autocomplete="off">
|
|
</form>
|
|
<ul class="nav">
|
|
<li class=""><a href="http://www.docker.com/whatisdocker/" title="What is Docker">What is Docker?</a></li>
|
|
<li class=""><a href="http://www.docker.com/resources/usecases/" title="Use Cases">Use Cases</a></li>
|
|
<li class=""><a href="http://www.docker.com/tryit/" title="Try It!">Try It!</a></li>
|
|
<li><a href="https://registry.hub.docker.com" title="Browse">Browse</a></li>
|
|
</ul>
|
|
<div id="usernav" class="pull-right">
|
|
<a href="https://hub.docker.com/account/login" class="btn nav-button2" title="Lg In">Log In</a>
|
|
<a href="https://hub.docker.com/account/signup" class="btn nav-button1" title="Sign Up">Sign Up</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id="topmostnav" class="topmostnav_loggedin navbar navbar-static-top">
|
|
<div class="container">
|
|
<a href="/" title="Docker Docs Home"><div class="brand logo"><img src="/img/nav/docker-logo-loggedin.png"> </div></a>
|
|
<form id="nav_search" class="navbar-index-search pull-right" action="/jsearch/">
|
|
<span role="status" aria-live="polite" class="ui-helper-hidden-accessible"></span>
|
|
<input name="q" id="tipue_search_input" type="text" class="search_input search-query ui-autocomplete-input" placeholder="Search the Docs" autocomplete="off">
|
|
</form>
|
|
<ul class="nav">
|
|
<li><a href="https://registry.hub.docker.com" title="Browse Repos">Browse Repos</a></li>
|
|
<li class="active"><a href="http://docs.docker.com" title="Documentation">Documentation</a></li>
|
|
<li><a href="http://www.docker.com/community/participate/" title="Community">Community</a></li>
|
|
<li><a href="http://www.docker.com/resources/help/" title="Help">Help</a></li>
|
|
</ul>
|
|
<div id="usernav" class="pull-right">
|
|
<ul class="nav user">
|
|
<li class="dropdown">
|
|
<a id="logged-in-header-username" class="dropdown-toggle" data-toggle="dropdown" href="#">
|
|
<img class="profile" src="" alt="profile picture">
|
|
</a>
|
|
<ul class="dropdown-menu pull-right">
|
|
<li><a href="https://hub.docker.com/">View Profile</a></li>
|
|
<li><a href="https://hub.docker.com/account/settings/">Settings</a></li>
|
|
<li><a href="https://hub.docker.com/repos/">My Repositories</a></li>
|
|
<li><a href="https://hub.docker.com/plans/billing-info">Billing</a></li>
|
|
<li><a href="https://hub.docker.com/account/logout/?next=/">Log out</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="wrap">
|
|
<nav id="nav_menu" class="clearfix navbar navbar-default navbar-static-top affix" role="navigation">
|
|
<div id="docsnav">
|
|
<ul id="main-nav" class="pull-left">
|
|
|
|
|
|
<li class="dd_menu pull-left">
|
|
|
|
<a href="/">About</a>
|
|
|
|
<ul class="dd_submenu" style="max-height: 75px;">
|
|
|
|
<li >
|
|
<a href="/">Docker</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/release-notes/">Release Notes</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/introduction/understanding-docker/">Understanding Docker</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li class="dd_menu pull-left">
|
|
|
|
<a href="/installation/ubuntulinux/">Installation</a>
|
|
|
|
<ul class="dd_submenu" style="max-height: 75px;">
|
|
|
|
<li >
|
|
<a href="/installation/ubuntulinux/">Ubuntu</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/mac/">Mac OS X</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/windows/">Microsoft Windows</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/amazon/">Amazon EC2</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/archlinux/">Arch Linux</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/binaries/">Binaries</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/centos/">CentOS</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/cruxlinux/">CRUX Linux</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/debian/">Debian</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/fedora/">Fedora</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/frugalware/">FrugalWare</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/google/">Google Cloud Platform</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/gentoolinux/">Gentoo</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/softlayer/">IBM Softlayer</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/rackspace/">Rackspace Cloud</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/rhel/">Red Hat Enterprise Linux</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/oracle/">Oracle Linux</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/installation/SUSE/">SUSE</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/compose/install/">Docker Compose</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li class="dd_menu pull-left">
|
|
|
|
<a href="/userguide/">User Guide</a>
|
|
|
|
<ul class="dd_submenu" style="max-height: 75px;">
|
|
|
|
<li >
|
|
<a href="/userguide/">The Docker User Guide</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/userguide/dockerhub/">Getting Started with Docker Hub</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/userguide/dockerizing/">Dockerizing Applications</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/userguide/usingdocker/">Working with Containers</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/userguide/dockerimages/">Working with Docker Images</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/userguide/dockerlinks/">Linking containers together</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/userguide/dockervolumes/">Managing data in containers</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/userguide/dockerrepos/">Working with Docker Hub</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/compose/">Docker Compose</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/machine/">Docker Machine</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/swarm/">Docker Swarm</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li class="dd_menu pull-left">
|
|
|
|
<a href="/docker-hub/">Docker Hub</a>
|
|
|
|
<ul class="dd_submenu" style="max-height: 75px;">
|
|
|
|
<li >
|
|
<a href="/docker-hub/">Docker Hub</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/docker-hub/accounts/">Accounts</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/docker-hub/repos/">Repositories</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/docker-hub/builds/">Automated Builds</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/docker-hub/official_repos/">Official Repo Guidelines</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li class="dd_menu pull-left">
|
|
|
|
<a href="/examples/nodejs_web_app/">Examples</a>
|
|
|
|
<ul class="dd_submenu" style="max-height: 75px;">
|
|
|
|
<li >
|
|
<a href="/examples/nodejs_web_app/">Dockerizing a Node.js web application</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/examples/mongodb/">Dockerizing MongoDB</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/examples/running_redis_service/">Dockerizing a Redis service</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/examples/postgresql_service/">Dockerizing a PostgreSQL service</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/examples/running_riak_service/">Dockerizing a Riak service</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/examples/running_ssh_service/">Dockerizing an SSH service</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/examples/couchdb_data_volumes/">Dockerizing a CouchDB service</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/examples/apt-cacher-ng/">Dockerizing an Apt-Cacher-ng service</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/compose/django/">Getting started with Compose and Django</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/compose/rails/">Getting started with Compose and Rails</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/compose/wordpress/">Getting started with Compose and Wordpress</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li class="dd_menu pull-left">
|
|
|
|
<a href="/articles/basics/">Articles</a>
|
|
|
|
<ul class="dd_submenu" style="max-height: 75px;">
|
|
|
|
<li >
|
|
<a href="/articles/basics/">Docker basics</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/networking/">Advanced networking</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/security/">Security</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/https/">Running Docker with HTTPS</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/registry_mirror/">Run a local registry mirror</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/host_integration/">Automatically starting containers</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/baseimages/">Creating a base image</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/dockerfile_best-practices/">Best practices for writing Dockerfiles</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/certificates/">Using certificates for repository client verification</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/using_supervisord/">Using Supervisor</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/cfengine_process_management/">Process management with CFEngine</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/puppet/">Using Puppet</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/chef/">Using Chef</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/dsc/">Using PowerShell DSC</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/ambassador_pattern_linking/">Cross-Host linking using ambassador containers</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/runmetrics/">Runtime metrics</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/b2d_volume_resize/">Increasing a Boot2Docker volume</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/articles/systemd/">Controlling and configuring Docker using Systemd</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li class="dd_menu pull-left active">
|
|
|
|
<a href="/reference/commandline/cli/">Reference</a>
|
|
|
|
<ul class="dd_submenu" style="max-height: 75px;">
|
|
|
|
<li >
|
|
<a href="/reference/commandline/cli/">Command line</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/reference/builder/">Dockerfile</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/faq/">FAQ</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/reference/run/">Run Reference</a>
|
|
</li>
|
|
|
|
<li class="active">
|
|
<a href="/compose/cli/">Compose command line</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/compose/yml/">Compose yml</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/compose/env/">Compose ENV variables</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/compose/completion/">Compose commandline completion</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/swarm/discovery/">Swarm discovery</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/swarm/scheduler/strategy/">Swarm strategies</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/swarm/scheduler/filter/">Swarm filters</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/swarm/API/">Swarm API</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/reference/api/docker-io_api/">Docker Hub API</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/reference/api/registry_api/">Docker Registry API</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/reference/api/registry_api_client_libraries/">Docker Registry API Client Libraries</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/reference/api/hub_registry_spec/">Docker Hub and Registry Spec</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/reference/api/docker_remote_api/">Docker Remote API</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/reference/api/docker_remote_api_v1.17/">Docker Remote API v1.17</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/reference/api/docker_remote_api_v1.16/">Docker Remote API v1.16</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/reference/api/remote_api_client_libraries/">Docker Remote API Client Libraries</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/reference/api/docker_io_accounts_api/">Docker Hub Accounts API</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
|
|
<li class="dd_menu pull-left">
|
|
|
|
<a href="/project/who-written-for/">Contributor Guide</a>
|
|
|
|
<ul class="dd_submenu" style="max-height: 75px;">
|
|
|
|
<li >
|
|
<a href="/project/who-written-for/">README first</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/project/software-required/">Get required software</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/project/set-up-git/">Configure Git for contributing</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/project/set-up-dev-env/">Work with a development container</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/project/test-and-docs/">Run tests and test documentation</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/project/make-a-contribution/">Understand contribution workflow</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/project/find-an-issue/">Find an issue</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/project/work-issue/">Work on an issue</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/project/create-pr/">Create a pull request</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/project/review-pr/">Participate in the PR review</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/project/advanced-contributing/">Advanced contributing</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/project/get-help/">Where to get help</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/project/coding-style/">Coding style guide</a>
|
|
</li>
|
|
|
|
<li >
|
|
<a href="/project/doc-style/">Documentation style guide</a>
|
|
</li>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</div>
|
|
</nav>
|
|
<div id="content" class="container">
|
|
<div class="row">
|
|
|
|
<div class="span3" id="leftnav">
|
|
<div id="toc_table">
|
|
<ul class="nav nav-tabs nav-stacked">
|
|
|
|
|
|
<li class=""><a href="#commands">Commands</a>
|
|
<ul>
|
|
|
|
<li><a href="#build">build</a></li>
|
|
|
|
<li><a href="#help">help</a></li>
|
|
|
|
<li><a href="#kill">kill</a></li>
|
|
|
|
<li><a href="#logs">logs</a></li>
|
|
|
|
<li><a href="#port">port</a></li>
|
|
|
|
<li><a href="#ps">ps</a></li>
|
|
|
|
<li><a href="#pull">pull</a></li>
|
|
|
|
<li><a href="#rm">rm</a></li>
|
|
|
|
<li><a href="#run">run</a></li>
|
|
|
|
<li><a href="#scale">scale</a></li>
|
|
|
|
<li><a href="#start">start</a></li>
|
|
|
|
<li><a href="#stop">stop</a></li>
|
|
|
|
<li><a href="#up">up</a></li>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class=""><a href="#options">Options</a>
|
|
<ul>
|
|
|
|
<li><a href="#-verbose">--verbose</a></li>
|
|
|
|
<li><a href="#-version">--version</a></li>
|
|
|
|
<li><a href="#-f-file-file">-f, --file FILE</a></li>
|
|
|
|
<li><a href="#-p-project-name-name">-p, --project-name NAME</a></li>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class=""><a href="#environment-variables">Environment Variables</a>
|
|
<ul>
|
|
|
|
<li><a href="#compose95project95name">COMPOSE_PROJECT_NAME</a></li>
|
|
|
|
<li><a href="#compose95file">COMPOSE_FILE</a></li>
|
|
|
|
<li><a href="#docker95host">DOCKER_HOST</a></li>
|
|
|
|
<li><a href="#docker95tls95verify">DOCKER_TLS_VERIFY</a></li>
|
|
|
|
<li><a href="#docker95cert95path">DOCKER_CERT_PATH</a></li>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
<li class=""><a href="#compose-documentation">Compose documentation</a>
|
|
<ul>
|
|
|
|
</ul>
|
|
</li>
|
|
|
|
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="span9 content-body">
|
|
|
|
|
|
|
|
<h1 id="cli-reference">CLI reference</h1>
|
|
<p>Most Docker Compose commands are run against one or more services. If
|
|
the service is not specified, the command will apply to all services.</p>
|
|
<p>For full usage information, run <code>docker-compose [COMMAND] --help</code>.</p>
|
|
<h2 id="commands">Commands</h2>
|
|
<h3 id="build">build</h3>
|
|
<p>Builds or rebuilds services.</p>
|
|
<p>Services are built once and then tagged as <code>project_service</code>, e.g.,
|
|
<code>composetest_db</code>. If you change a service's Dockerfile or the contents of its
|
|
build directory, run <code>docker-compose build</code> to rebuild it.</p>
|
|
<h3 id="help">help</h3>
|
|
<p>Displays help and usage instructions for a command.</p>
|
|
<h3 id="kill">kill</h3>
|
|
<p>Forces running containers to stop by sending a <code>SIGKILL</code> signal. Optionally the
|
|
signal can be passed, for example:</p>
|
|
<pre class="prettyprint well"><code>$ docker-compose kill -s SIGINT
|
|
</code></pre>
|
|
<h3 id="logs">logs</h3>
|
|
<p>Displays log output from services.</p>
|
|
<h3 id="port">port</h3>
|
|
<p>Prints the public port for a port binding</p>
|
|
<h3 id="ps">ps</h3>
|
|
<p>Lists containers.</p>
|
|
<h3 id="pull">pull</h3>
|
|
<p>Pulls service images.</p>
|
|
<h3 id="rm">rm</h3>
|
|
<p>Removes stopped service containers.</p>
|
|
<h3 id="run">run</h3>
|
|
<p>Runs a one-off command on a service.</p>
|
|
<p>For example,</p>
|
|
<pre class="prettyprint well"><code>$ docker-compose run web python manage.py shell
|
|
</code></pre>
|
|
<p>will start the <code>web</code> service and then run <code>manage.py shell</code> in python.
|
|
Note that by default, linked services will also be started, unless they are
|
|
already running.</p>
|
|
<p>One-off commands are started in new containers with the same configuration as a
|
|
normal container for that service, so volumes, links, etc will all be created as
|
|
expected. When using <code>run</code>, there are two differences from bringing up a
|
|
container normally:</p>
|
|
<ol>
|
|
<li>
|
|
<p>the command will be overridden with the one specified. So, if you run
|
|
<code>docker-compose run web bash</code>, the container's web command (which could default
|
|
to, e.g., <code>python app.py</code>) will be overridden to <code>bash</code></p>
|
|
</li>
|
|
<li>
|
|
<p>by default no ports will be created in case they collide with already opened
|
|
ports.</p>
|
|
</li>
|
|
</ol>
|
|
<p>Links are also created between one-off commands and the other containers which
|
|
are part of that service. So, for example, you could run:</p>
|
|
<pre class="prettyprint well"><code>$ docker-compose run db psql -h db -U docker
|
|
</code></pre>
|
|
<p>This would open up an interactive PostgreSQL shell for the linked <code>db</code> container
|
|
(which would get created or started as needed).</p>
|
|
<p>If you do not want linked containers to start when running the one-off command,
|
|
specify the <code>--no-deps</code> flag:</p>
|
|
<pre class="prettyprint well"><code>$ docker-compose run --no-deps web python manage.py shell
|
|
</code></pre>
|
|
<p>Similarly, if you do want the service's ports to be created and mapped to the
|
|
host, specify the <code>--service-ports</code> flag:
|
|
$ docker-compose run --service-ports web python manage.py shell</p>
|
|
<h3 id="scale">scale</h3>
|
|
<p>Sets the number of containers to run for a service.</p>
|
|
<p>Numbers are specified as arguments in the form <code>service=num</code>. For example:</p>
|
|
<pre class="prettyprint well"><code>$ docker-compose scale web=2 worker=3
|
|
</code></pre>
|
|
<h3 id="start">start</h3>
|
|
<p>Starts existing containers for a service.</p>
|
|
<h3 id="stop">stop</h3>
|
|
<p>Stops running containers without removing them. They can be started again with
|
|
<code>docker-compose start</code>.</p>
|
|
<h3 id="up">up</h3>
|
|
<p>Builds, (re)creates, starts, and attaches to containers for a service.</p>
|
|
<p>Linked services will be started, unless they are already running.</p>
|
|
<p>By default, <code>docker-compose up</code> will aggregate the output of each container and,
|
|
when it exits, all containers will be stopped. Running <code>docker-compose up -d</code>,
|
|
will start the containers in the background and leave them running.</p>
|
|
<p>By default, if there are existing containers for a service, <code>docker-compose up</code> will stop and recreate them (preserving mounted volumes with <a href="http://docs.docker.io/en/latest/use/working_with_volumes/">volumes-from</a>), so that changes in <code>docker-compose.yml</code> are picked up. If you do not want containers stopped and recreated, use <code>docker-compose up --no-recreate</code>. This will still start any stopped containers, if needed.</p>
|
|
<h2 id="options">Options</h2>
|
|
<h3 id="-verbose">--verbose</h3>
|
|
<p>Shows more output</p>
|
|
<h3 id="-version">--version</h3>
|
|
<p>Prints version and exits</p>
|
|
<h3 id="-f-file-file">-f, --file FILE</h3>
|
|
<p>Specifies an alternate Compose yaml file (default: <code>docker-compose.yml</code>)</p>
|
|
<h3 id="-p-project-name-name">-p, --project-name NAME</h3>
|
|
<p>Specifies an alternate project name (default: current directory name)</p>
|
|
<h2 id="environment-variables">Environment Variables</h2>
|
|
<p>Several environment variables are available for you to configure Compose's behaviour.</p>
|
|
<p>Variables starting with <code>DOCKER_</code> are the same as those used to configure the
|
|
Docker command-line client. If you're using boot2docker, <code>$(boot2docker shellinit)</code>
|
|
will set them to their correct values.</p>
|
|
<h3 id="compose95project95name">COMPOSE_PROJECT_NAME</h3>
|
|
<p>Sets the project name, which is prepended to the name of every container started by Compose. Defaults to the <code>basename</code> of the current working directory.</p>
|
|
<h3 id="compose95file">COMPOSE_FILE</h3>
|
|
<p>Sets the path to the <code>docker-compose.yml</code> to use. Defaults to <code>docker-compose.yml</code> in the current working directory.</p>
|
|
<h3 id="docker95host">DOCKER_HOST</h3>
|
|
<p>Sets the URL of the docker daemon. As with the Docker client, defaults to <code>unix:///var/run/docker.sock</code>.</p>
|
|
<h3 id="docker95tls95verify">DOCKER_TLS_VERIFY</h3>
|
|
<p>When set to anything other than an empty string, enables TLS communication with
|
|
the daemon.</p>
|
|
<h3 id="docker95cert95path">DOCKER_CERT_PATH</h3>
|
|
<p>Configures the path to the <code>ca.pem</code>, <code>cert.pem</code>, and <code>key.pem</code> files used for TLS verification. Defaults to <code>~/.docker</code>.</p>
|
|
<h2 id="compose-documentation">Compose documentation</h2>
|
|
<ul>
|
|
<li><a href="/compose/install/">Installing Compose</a></li>
|
|
<li><a href="/compose/">User guide</a></li>
|
|
<li><a href="/compose/yml/">Yaml file reference</a></li>
|
|
<li><a href="/compose/env/">Compose environment variables</a></li>
|
|
<li><a href="/compose/completion/">Compose command line completion</a></li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<div id="push-footer"></div>
|
|
|
|
</div>
|
|
|
|
|
|
|
|
<div id="footer-container" class="container">
|
|
<div id="footer" class="grey-body">
|
|
<div class="row">
|
|
<div class="span2">
|
|
<span class="footer-title">Community</span>
|
|
<ul class="unstyled">
|
|
<li><a class="primary-button" href="https://www.docker.com/community/events/">Events</a></li>
|
|
<li><a class="primary-button" href="http://posts.docker.com">Friends' Posts</a></li>
|
|
<li><a class="primary-button" href="https://www.docker.com/community/meetups/">Meetups</a></li>
|
|
<li><a class="primary-button" href="https://www.docker.com/community/governance/">Governance</a></li>
|
|
<li><a class="primary-button" href="http://forums.docker.com">Forums</a></li>
|
|
<li><a class="primary-button" href="http://botbot.me/freenode/docker">IRC</a></li>
|
|
<li><a class="primary-button" href="https://github.com/docker/docker">GitHub</a></li>
|
|
<li><a class="primary-button" href="http://stackoverflow.com/search?q=docker">Stackoverflow</a></li>
|
|
<li><a class="primary-button" href="http://www.cafepress.com/docker">Swag</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="span2">
|
|
<span class="footer-title">Enterprise</span>
|
|
<ul class="unstyled">
|
|
<li><a class="primary-button" href="https://www.docker.com/enterprise/support/">Support</a></li>
|
|
<li><a class="primary-button" href="https://www.docker.com/enterprise/education/">Education</a></li>
|
|
<li><a class="primary-button" href="https://www.docker.com/enterprise/services/">Services</a></li>
|
|
</ul>
|
|
<span class="footer-title">Partner Solutions</span>
|
|
<ul class="unstyled">
|
|
<li><a class="primary-button" href="https://www.docker.com/partners/find/">Find a Partner</a></li>
|
|
<li><a class="primary-button" href="https://www.docker.com/partners/program/">Partner Program</a></li>
|
|
<li><a class="primary-button" href="https://www.docker.com/partners/learn/">Learn More</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="span2">
|
|
<span class="footer-title">Resources</span>
|
|
<ul class="unstyled">
|
|
<li><a class="primary-button" href="https://docs.docker.com">Documentation</a></li>
|
|
<li><a class="primary-button" href="https://www.docker.com/resources/help/">Help</a></li>
|
|
<li><a class="primary-button" href="https://www.docker.com/resources/usecases/">Use Cases</a></li>
|
|
<li><a class="primary-button" href="http://www.docker.com/tryit/">Online Tutorial</a></li>
|
|
<li><a class="primary-button" href="https://www.docker.com/resources/howtobuy/">How To Buy</a></li>
|
|
<li><a class="primary-button" href="http://status.docker.com">Status</a></li>
|
|
<li><a class="primary-button" href="https://www.docker.com/resources/security/">Security</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="span2">
|
|
<span class="footer-title">Company</span>
|
|
<ul class="unstyled">
|
|
<li><a class="primary-button" href="https://www.docker.com/company/aboutus/">About Us</a></li>
|
|
<li><a class="primary-button" href="https://www.docker.com/company/team/">Team</a></li>
|
|
<li><a class="primary-button" href="https://www.docker.com/company/news/">News</a></li>
|
|
<li><a class="primary-button" href="https://www.docker.com/company/press/">Press</a></li>
|
|
<li><a class="primary-button" href="https://www.docker.com/company/careers/">Careers</a></li>
|
|
<li><a class="primary-button" href="https://www.docker.com/company/contact/">Contact</a></li>
|
|
</ul>
|
|
</div>
|
|
<div class="span3">
|
|
<span class="footer-title">Connect</span>
|
|
<div class="search">
|
|
<span>Subscribe to our newsletter</span>
|
|
<form action="https://www.docker.com/subscribe_newsletter/" method="post">
|
|
<input type='hidden' name='csrfmiddlewaretoken' value='aWL78QXQkY8DSKNYh6cl08p5eTLl7sOa' />
|
|
<tr><th><label for="id_email">Email:</label></th><td><input class="form-control" id="id_email" name="email" placeholder="Enter your email" type="text" /></td></tr>
|
|
|
|
<button type="submit"><i class="icon-arrow-right"></i> </button>
|
|
</form>
|
|
</div>
|
|
<ul class="unstyled social">
|
|
<li><a title="Docker on Twitter" class="primary-button blog" href="http://blog.docker.com">Blog</a></li>
|
|
<li><a title="Docker on Twitter" class="primary-button twitter" href="http://twitter.com/docker">Twitter</a></li>
|
|
<li><a title="Docker on Google+" class="primary-button googleplus" href="https://plus.google.com/u/0/communities/108146856671494713993">Google+</a></li>
|
|
<li><a title="Docker on Facebook" class="primary-button facebook" href="https://www.facebook.com/docker.run">Facebook</a></li>
|
|
<li><a title="Docker on Youtube" class="primary-button youtube" href="http://www.youtube.com/user/dockerrun">YouTube</a></li>
|
|
</ul>
|
|
<ul class="unstyled social">
|
|
<li><a title="Docker on SlideShare" class="primary-button slideshare" href="http://www.slideshare.net/Docker">Slideshare</a></li>
|
|
<li>
|
|
<a title="Docker on LinkedIn" class="primary-button" href="https://www.linkedin.com/company/docker">
|
|
<span class="linkedin"></span>
|
|
LinkedIn
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a title="Docker on GitHub" class="primary-button" href="https://github.com/docker/">
|
|
<span class="github"></span>
|
|
GitHub
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a title="Docker on Reddit" class="primary-button" href="http://www.reddit.com/r/docker">
|
|
<span class="reddit"></span>
|
|
Reddit
|
|
</a>
|
|
</li>
|
|
<li>
|
|
<a title="Docker on AngelList" class="primary-button" href="https://angel.co/docker-inc-1">
|
|
<span class="angellist"></span>
|
|
AngelList
|
|
</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class="row clearfix">
|
|
<div class="span6 pagination-right copyright">
|
|
<span>© 2014-2015 Docker, Inc.</span>
|
|
</div>
|
|
<div class="span6 pagination-left copyright">
|
|
<a href="http://www.docker.com/legal/terms_of_service">Terms</a> ·
|
|
<a href="http://www.docker.com/legal/privacy_policy">Privacy</a> ·
|
|
<a href="http://www.docker.com/legal/trademark_guidelines">Trademarks</a>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
|
|
<script src="/js/jquery-1.10.2.min.js"></script>
|
|
<script src="/js/jquery.cookie.js" ></script>
|
|
<script src="/js/jquery-scrolltofixed-min.js"></script>
|
|
<script src="/js/bootstrap-3.0.3.min.js"></script>
|
|
<script src="/js/prettify-1.0.min.js"></script>
|
|
<script src="/js/dockerfile_tutorial.js"></script>
|
|
<script src="/js/dockerfile_tutorial_level.js"></script>
|
|
<script src="/js/base.js"></script>
|
|
<script src="/tipuesearch/tipuesearch_set.js"></script>
|
|
<script src="/tipuesearch/tipuesearch.min.js"></script>
|
|
<script type="text/javascript">
|
|
piAId = '45082';
|
|
piCId = '1482';
|
|
|
|
(function() {
|
|
function async_load(){
|
|
var s = document.createElement('script'); s.type = 'text/javascript';
|
|
s.src = ('https:' == document.location.protocol ? 'https://pi' : 'http://cdn') + '.pardot.com/pd.js';
|
|
var c = document.getElementsByTagName('script')[0]; c.parentNode.insertBefore(s, c);
|
|
}
|
|
if(window.attachEvent) { window.attachEvent('onload', async_load); }
|
|
else { window.addEventListener('load', async_load, false); }
|
|
})();
|
|
</script>
|
|
<script type="text/javascript">
|
|
$(document).ready(function() {
|
|
$('#content').css("min-height", $(window).height() - 553 );
|
|
// if the URL contains a version string, update the version picker to reflect that
|
|
version = document.location.pathname.match(/^\/(v\d\.\d)\/.*/)
|
|
if (version && version[1]) {
|
|
$('#document-version-number')[0].text = 'Version '+version[1];
|
|
} else {
|
|
$('#document-version-number')[0].text = $('#document-version-number')[0].text + " (Latest)"
|
|
}
|
|
// load the complete versions list
|
|
$.get("/versions.html_fragment", function( data ) {
|
|
$('#documentation-version-list').prepend(data);
|
|
//remove any "/v1.1/" bits from front, so we can add the path to the version selection dropdown.
|
|
path = document.location.pathname.replace(/^\/v\d\.\d/, "");
|
|
$('#documentation-version-list a.version').each(function(i, e) {
|
|
e.href = e.href+path;
|
|
$(e).removeClass()
|
|
});
|
|
});
|
|
|
|
})
|
|
var userName = getCookie('docker_sso_username');
|
|
if (userName) {
|
|
$('.topmostnav_loggedout').hide();
|
|
$('.topmostnav_loggedin').show();
|
|
$('#logged-in-header-username').text(userName);
|
|
} else {
|
|
$('.topmostnav_loggedout').show();
|
|
$('.topmostnav_loggedin').hide();
|
|
}
|
|
</script>
|
|
</body>
|
|
</html> |