docker
/
docs
mirror of https://github.com/docker/docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

move compose examples to the samples directory 

Unifying all "examples" in this directory; some of these should still be
reviewed and/or removed in favor of examples from "awesome compose"

Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
This commit is contained in:
Sebastiaan van Stijn 2021-04-14 12:52:47 +02:00
parent 06651b34b8
commit f4ed09424b
No known key found for this signature in database
GPG Key ID: 76698F39D527CE8C
16 changed files with 72 additions and 55 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
_data/toc.yaml
View File

@ -1142,17 +1142,17 @@ samples:
title: apt-cacher-ng title: apt-cacher-ng
- path: /samples/dotnetcore/ - path: /samples/dotnetcore/
title: ASP.NET Core application title: ASP.NET Core application
- path: /compose/aspnet-mssql-compose/ - path: /samples/aspnet-mssql-compose/
title: ASP.NET Core + SQL Server on Linux title: ASP.NET Core + SQL Server on Linux
- path: /samples/couchdb_data_volumes/ - path: /samples/couchdb_data_volumes/
title: CouchDB title: CouchDB
- path: /compose/django/ - path: /samples/django/
title: Django and PostgreSQL title: Django and PostgreSQL
- path: /compose/wordpress/ - path: /samples/wordpress/
title: WordPress title: WordPress
- path: /samples/postgresql_service/ - path: /samples/postgresql_service/
title: PostgreSQL title: PostgreSQL
- path: /compose/rails/ - path: /samples/rails/
title: Rails and PostgreSQL title: Rails and PostgreSQL
- path: /samples/running_riak_service/ - path: /samples/running_riak_service/
title: Riak title: Riak

BIN
compose/images/wordpress-files.png
View File

Binary file not shown.
Side by Side

Before

Width:  |  Height:  |  Size: 69 KiB

6
compose/index.md
View File

@ -64,9 +64,9 @@ Compose has commands for managing the whole lifecycle of your application:
- [Installing Compose](install.md) - [Installing Compose](install.md)
- [Getting started with Compose](gettingstarted.md) - [Getting started with Compose](gettingstarted.md)
- [Get started with Django](django.md) - [Get started with Django](../samples/django.md)
- [Get started with Rails](rails.md) - [Get started with Rails](../samples/rails.md)
- [Get started with WordPress](wordpress.md) - [Get started with WordPress](../samples/wordpress.md)
- [Frequently asked questions](faq.md) - [Frequently asked questions](faq.md)
- [Command line reference](reference/index.md) - [Command line reference](reference/index.md)
- [Compose file reference](compose-file/index.md) - [Compose file reference](compose-file/index.md)

2
compose/reference/overview.md
View File

@ -140,7 +140,7 @@ a [COMPOSE_FILE environment variable](envvars.md#compose_file) in your shell or
in an environment file. in an environment file.
For an example of using the `-f` option at the command line, suppose you are For an example of using the `-f` option at the command line, suppose you are
running the [Compose Rails sample](../rails.md), and running the [Compose Rails sample](../../samples/rails.md), and
have a `docker-compose.yml` file in a directory called `sandbox/rails`. You can have a `docker-compose.yml` file in a directory called `sandbox/rails`. You can
use a command like [docker-compose pull](pull.md) to get the use a command like [docker-compose pull](pull.md) to get the
postgres image for the `db` service from anywhere by using the `-f` flag as postgres image for the `db` service from anywhere by using the `-f` flag as

2
compose/reference/pull.md
View File

@ -18,7 +18,7 @@ Options:
Pulls an image associated with a service defined in a `docker-compose.yml` or `docker-stack.yml` file, but does not start containers based on those images. Pulls an image associated with a service defined in a `docker-compose.yml` or `docker-stack.yml` file, but does not start containers based on those images.
For example, suppose you have this `docker-compose.yml` file from the [Quickstart: Compose and Rails](../rails.md) sample. For example, suppose you have this `docker-compose.yml` file from the [Quickstart: Compose and Rails](../../samples/rails.md) sample.
```yaml ```yaml
version: '2' version: '2'

6
compose/samples-for-compose.md
View File

@ -24,12 +24,12 @@ The samples should help you to:
These samples focus specifically on Docker Compose: These samples focus specifically on Docker Compose:
- [Quickstart: Compose and Django](django.md) - Shows how to use Docker Compose to set up and run a simple Django/PostgreSQL app. - [Quickstart: Compose and Django](../samples/django.md) - Shows how to use Docker Compose to set up and run a simple Django/PostgreSQL app.
- [Quickstart: Compose and Rails](rails.md) - Shows how to use - [Quickstart: Compose and Rails](../samples/rails.md) - Shows how to use
Docker Compose to set up and run a Rails/PostgreSQL app. Docker Compose to set up and run a Rails/PostgreSQL app.
- [Quickstart: Compose and WordPress](wordpress.md) - Shows how to - [Quickstart: Compose and WordPress](../samples/wordpress.md) - Shows how to
use Docker Compose to set up and run WordPress in an isolated environment use Docker Compose to set up and run WordPress in an isolated environment
with Docker containers. with Docker containers.

2
develop/index.md
View File

@ -28,7 +28,7 @@ most benefits from Docker.
- [Port a node.js app to Docker lab](https://github.com/docker/labs/tree/master/developer-tools/nodejs/porting){: target="_blank" rel="noopener" class="_"} - [Port a node.js app to Docker lab](https://github.com/docker/labs/tree/master/developer-tools/nodejs/porting){: target="_blank" rel="noopener" class="_"}
- [Ruby on Rails app on Docker lab](https://github.com/docker/labs/tree/master/developer-tools/ruby){: target="_blank" rel="noopener" class="_"} - [Ruby on Rails app on Docker lab](https://github.com/docker/labs/tree/master/developer-tools/ruby){: target="_blank" rel="noopener" class="_"}
- [Dockerize a .Net Core application](../samples/dotnetcore.md){: target="_blank" rel="noopener" class="_"} - [Dockerize a .Net Core application](../samples/dotnetcore.md){: target="_blank" rel="noopener" class="_"}
- [Dockerize an ASP.NET Core application with SQL Server on Linux](../compose/aspnet-mssql-compose.md){: target="_blank" rel="noopener" class="_"} using Docker Compose - [Dockerize an ASP.NET Core application with SQL Server on Linux](../samples/aspnet-mssql-compose.md){: target="_blank" rel="noopener" class="_"} using Docker Compose
## Advanced development with the SDK or API ## Advanced development with the SDK or API

13
compose/aspnet-mssql-compose.md → samples/aspnet-mssql-compose.md
View File

@ -2,6 +2,8 @@
description: Create a Docker Compose application using ASP.NET Core and SQL Server on Linux in Docker. description: Create a Docker Compose application using ASP.NET Core and SQL Server on Linux in Docker.
keywords: dotnet, .NET, Core, example, ASP.NET Core, SQL Server, mssql keywords: dotnet, .NET, Core, example, ASP.NET Core, SQL Server, mssql
title: "Quickstart: Compose and ASP.NET Core with SQL Server" title: "Quickstart: Compose and ASP.NET Core with SQL Server"
redirect_from:
- /compose/aspnet-mssql-compose/
--- ---
This quick-start guide demonstrates how to use Docker Engine on Linux and Docker This quick-start guide demonstrates how to use Docker Engine on Linux and Docker
@ -10,7 +12,7 @@ Compose to set up and run the sample ASP.NET Core application using the
with the with the
[SQL Server on Linux image](https://hub.docker.com/_/microsoft-mssql-server). [SQL Server on Linux image](https://hub.docker.com/_/microsoft-mssql-server).
You just need to have [Docker Engine](../get-docker.md) You just need to have [Docker Engine](../get-docker.md)
and [Docker Compose](install.md) installed on your and [Docker Compose](../compose/install.md) installed on your
platform of choice: Linux, Mac or Windows. platform of choice: Linux, Mac or Windows.
For this sample, we create a sample .NET Core Web Application using the For this sample, we create a sample .NET Core Web Application using the
@ -201,3 +203,12 @@ to try out .NET Framework and more SQL Server tutorials.
- [SQL Server on Docker Hub](https://hub.docker.com/r/microsoft/mssql-server/) - [SQL Server on Docker Hub](https://hub.docker.com/r/microsoft/mssql-server/)
- [ASP.NET Core](https://www.asp.net/core) - [ASP.NET Core](https://www.asp.net/core)
- [ASP.NET Core Docker image](https://hub.docker.com/r/microsoft/aspnetcore/) on DockerHub - [ASP.NET Core Docker image](https://hub.docker.com/r/microsoft/aspnetcore/) on DockerHub
## More Compose documentation
- [Docker Compose overview](../compose/index.md)
- [Install Docker Compose](../compose/install.md)
- [Getting Started with Docker Compose](../compose/gettingstarted.md)
- [Docker Compose Command line reference](../compose/reference/index.md)
- [Compose file reference](../compose/compose-file/index.md)
- [Awesome Compose samples](https://github.com/docker/awesome-compose/){:target="_blank" rel="noopener" class="_"}

24
compose/django.md → samples/django.md
View File

@ -2,10 +2,12 @@
description: Getting started with Docker Compose and Django description: Getting started with Docker Compose and Django
keywords: documentation, docs, docker, compose, orchestration, containers keywords: documentation, docs, docker, compose, orchestration, containers
title: "Quickstart: Compose and Django" title: "Quickstart: Compose and Django"
redirect_from:
- /compose/django/
--- ---
This quick-start guide demonstrates how to use Docker Compose to set up and run a simple Django/PostgreSQL app. Before starting, This quick-start guide demonstrates how to use Docker Compose to set up and run a simple Django/PostgreSQL app. Before starting,
[install Compose](install.md). [install Compose](../compose/install.md).
### Define the project components ### Define the project components
@ -58,7 +60,7 @@ and a `docker-compose.yml` file. (You can use either a `.yml` or `.yaml` extensi
also describes which Docker images these services use, how they link also describes which Docker images these services use, how they link
together, any volumes they might need to be mounted inside the containers. together, any volumes they might need to be mounted inside the containers.
Finally, the `docker-compose.yml` file describes which ports these services Finally, the `docker-compose.yml` file describes which ports these services
expose. See the [`docker-compose.yml` reference](compose-file/index.md) for more expose. See the [`docker-compose.yml` reference](../compose/compose-file/index.md) for more
information on how this file works. information on how this file works.
9. Add the following configuration to the file. 9. Add the following configuration to the file.
@ -102,7 +104,7 @@ In this step, you create a Django starter project by building the image from the
1. Change to the root of your project directory. 1. Change to the root of your project directory.
2. Create the Django project by running the [docker-compose run](reference/run.md) 2. Create the Django project by running the [docker-compose run](../compose/reference/run.md)
command as follows. command as follows.
```console ```console
@ -184,7 +186,7 @@ In this section, you set up the database connection for Django.
3. Save and close the file. 3. Save and close the file.
4. Run the [docker-compose up](reference/up.md) command from the top level directory for your project. 4. Run the [docker-compose up](../compose/reference/up.md) command from the top level directory for your project.
```console ```console
$ docker-compose up $ docker-compose up
@ -252,7 +254,7 @@ In this section, you set up the database connection for Django.
``` ```
* Or, for a more elegant shutdown, switch to a different shell, and run * Or, for a more elegant shutdown, switch to a different shell, and run
[docker-compose down](reference/down.md) from the top level of your [docker-compose down](../compose/reference/down.md) from the top level of your
Django sample project directory. Django sample project directory.
```console ```console
@ -270,9 +272,9 @@ In this section, you set up the database connection for Django.
## More Compose documentation ## More Compose documentation
- [User guide](index.md) - [Docker Compose overview](../compose/index.md)
- [Installing Compose](install.md) - [Install Docker Compose](../compose/install.md)
- [Getting Started](gettingstarted.md) - [Getting Started with Docker Compose](../compose/gettingstarted.md)
- [Command line reference](reference/index.md) - [Docker Compose Command line reference](../compose/reference/index.md)
- [Compose file reference](compose-file/index.md) - [Compose file reference](../compose/compose-file/index.md)
- [Sample apps with Compose](samples-for-compose.md) - [Awesome Compose samples](https://github.com/docker/awesome-compose/){:target="_blank" rel="noopener" class="_"}

0
compose/images/django-it-worked.png → samples/images/django-it-worked.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 18 KiB

After

Width:  |  Height:  |  Size: 18 KiB

0
compose/images/rails-welcome.png → samples/images/rails-welcome.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 334 KiB

After

Width:  |  Height:  |  Size: 334 KiB

0
compose/images/wordpress-lang.png → samples/images/wordpress-lang.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 29 KiB

0
compose/images/wordpress-welcome.png → samples/images/wordpress-welcome.png
View File

Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 60 KiB

After

Width:  |  Height:  |  Size: 60 KiB

24
samples/index.md
View File

@ -32,18 +32,18 @@ repository]({{ labsbase }}).
Run popular software using Docker. Run popular software using Docker.
| Sample | Description | | Sample | Description |
| ------------------------------------------------------------------------- | --------------------------------------------------------- | | --------------------------------------------------------------| --------------------------------------------------------- |
| [apt-cacher-ng](apt-cacher-ng.md) | Run a Dockerized apt-cacher-ng instance. | | [apt-cacher-ng](apt-cacher-ng.md) | Run a Dockerized apt-cacher-ng instance. |
| [.Net Core application](dotnetcore.md) | Run a Dockerized ASP.NET Core application. | | [.Net Core application](dotnetcore.md) | Run a Dockerized ASP.NET Core application. |
| [ASP.NET Core + SQL Server on Linux](../compose/aspnet-mssql-compose.md) | Run a Dockerized ASP.NET Core + SQL Server environment. | | [ASP.NET Core + SQL Server on Linux](aspnet-mssql-compose.md) | Run a Dockerized ASP.NET Core + SQL Server environment. |
| [CouchDB](couchdb_data_volumes.md) | Run a Dockerized CouchDB instance. | | [CouchDB](couchdb_data_volumes.md) | Run a Dockerized CouchDB instance. |
| [Django + PostgreSQL](../compose/django.md) | Run a Dockerized Django + PostgreSQL environment. | | [Django + PostgreSQL](django.md) | Run a Dockerized Django + PostgreSQL environment. |
| [PostgreSQL](postgresql_service.md) | Run a Dockerized PostgreSQL instance. | | [PostgreSQL](postgresql_service.md) | Run a Dockerized PostgreSQL instance. |
| [Rails + PostgreSQL](../compose/rails.md) | Run a Dockerized Rails + PostgreSQL environment. | | [Rails + PostgreSQL](rails.md) | Run a Dockerized Rails + PostgreSQL environment. |
| [Riak](running_riak_service.md) | Run a Dockerized Riak instance. | | [Riak](running_riak_service.md) | Run a Dockerized Riak instance. |
| [SSHd](running_ssh_service.md) | Run a Dockerized SSHd instance. | | [SSHd](running_ssh_service.md) | Run a Dockerized SSHd instance. |
| [WordPress](../compose/wordpress.md) | Quickstart: Compose and WordPress. | | [WordPress](wordpress.md) | Quickstart: Compose and WordPress. |
## Library references ## Library references

20
compose/rails.md → samples/rails.md
View File

@ -2,10 +2,12 @@
description: Getting started with Docker Compose and Rails description: Getting started with Docker Compose and Rails
keywords: documentation, docs, docker, compose, orchestration, containers keywords: documentation, docs, docker, compose, orchestration, containers
title: "Quickstart: Compose and Rails" title: "Quickstart: Compose and Rails"
redirect_from:
- /compose/rails/
--- ---
This Quickstart guide shows you how to use Docker Compose to set up and run This Quickstart guide shows you how to use Docker Compose to set up and run
a Rails/PostgreSQL app. Before starting, [install Compose](install.md). a Rails/PostgreSQL app. Before starting, [install Compose](../compose/install.md).
### Define the project ### Define the project
@ -21,7 +23,7 @@ WORKDIR /myapp
COPY Gemfile /myapp/Gemfile COPY Gemfile /myapp/Gemfile
COPY Gemfile.lock /myapp/Gemfile.lock COPY Gemfile.lock /myapp/Gemfile.lock
RUN bundle install RUN bundle install
COPY . /myapp COPY ../compose /myapp
# Add a script to be executed every time the container starts. # Add a script to be executed every time the container starts.
COPY entrypoint.sh /usr/bin/ COPY entrypoint.sh /usr/bin/
@ -229,7 +231,7 @@ browser to see the Rails Welcome.
### Stop the application ### Stop the application
To stop the application, run [docker-compose down](reference/down.md) in To stop the application, run [docker-compose down](../compose/reference/down.md) in
your project directory. You can use the same terminal window in which you your project directory. You can use the same terminal window in which you
started the database, or another one where you have access to a command prompt. started the database, or another one where you have access to a command prompt.
This is a clean way to stop the application. This is a clean way to stop the application.
@ -277,9 +279,9 @@ host.
## More Compose documentation ## More Compose documentation
- [User guide](index.md) - [Docker Compose overview](../compose/index.md)
- [Installing Compose](install.md) - [Install Docker Compose](../compose/install.md)
- [Getting Started](gettingstarted.md) - [Getting Started with Docker Compose](../compose/gettingstarted.md)
- [Command line reference](reference/index.md) - [Docker Compose Command line reference](../compose/reference/index.md)
- [Compose file reference](compose-file/index.md) - [Compose file reference](../compose/compose-file/index.md)
- [Sample apps with Compose](samples-for-compose.md) - [Awesome Compose samples](https://github.com/docker/awesome-compose/){:target="_blank" rel="noopener" class="_"}

20
compose/wordpress.md → samples/wordpress.md
View File

@ -2,12 +2,14 @@
description: Getting started with Compose and WordPress description: Getting started with Compose and WordPress
keywords: documentation, docs, docker, compose, orchestration, containers keywords: documentation, docs, docker, compose, orchestration, containers
title: "Quickstart: Compose and WordPress" title: "Quickstart: Compose and WordPress"
redirect_from:
- /compose/wordpress/
--- ---
You can use Docker Compose to easily run WordPress in an isolated environment You can use Docker Compose to easily run WordPress in an isolated environment
built with Docker containers. This quick-start guide demonstrates how to use built with Docker containers. This quick-start guide demonstrates how to use
Compose to set up and run WordPress. Before starting, make sure you have Compose to set up and run WordPress. Before starting, make sure you have
[Compose installed](install.md). [Compose installed](../compose/install.md).
### Define the project ### Define the project
@ -78,7 +80,7 @@ Compose to set up and run WordPress. Before starting, make sure you have
Now, run `docker-compose up -d` from your project directory. Now, run `docker-compose up -d` from your project directory.
This runs [`docker-compose up`](reference/up.md) in detached mode, pulls This runs [`docker-compose up`](../compose/reference/up.md) in detached mode, pulls
the needed Docker images, and starts the wordpress and database containers, as shown in the needed Docker images, and starts the wordpress and database containers, as shown in
the example below. the example below.
@ -134,7 +136,7 @@ browser.
### Shutdown and cleanup ### Shutdown and cleanup
The command [`docker-compose down`](reference/down.md) removes the The command [`docker-compose down`](../compose/reference/down.md) removes the
containers and default network, but preserves your WordPress database. containers and default network, but preserves your WordPress database.
The command `docker-compose down --volumes` removes the containers, default The command `docker-compose down --volumes` removes the containers, default
@ -142,9 +144,9 @@ network, and the WordPress database.
## More Compose documentation ## More Compose documentation
- [User guide](index.md) - [Docker Compose overview](../compose/index.md)
- [Installing Compose](install.md) - [Install Docker Compose](../compose/install.md)
- [Getting Started](gettingstarted.md) - [Getting Started with Docker Compose](../compose/gettingstarted.md)
- [Command line reference](reference/index.md) - [Docker Compose Command line reference](../compose/reference/index.md)
- [Compose file reference](compose-file/index.md) - [Compose file reference](../compose/compose-file/index.md)
- [Sample apps with Compose](samples-for-compose.md) - [Awesome Compose samples](https://github.com/docker/awesome-compose/){:target="_blank" rel="noopener" class="_"}