How to Use Docker Compose: Step-by-Step Tutorial

How to Use Docker Compose: Step-by-Step Tutorial

TL;DR: Docker Compose allows you to define and run multi-container applications using a simple YAML file. You create a docker-compose.yml configuration, then use the docker compose up command to build, start, and manage your entire stack.

Understanding the Basics

Before diving into the steps, it is crucial to understand that Docker Compose is an orchestration tool. It does not replace Docker but extends its capabilities. Instead of running individual containers with complex commands, you define services, networks, and volumes in a single declarative file. This ensures that your development environment is consistent across different machines and team members. The primary configuration file is named docker-compose.yml. This file uses YAML syntax, which is human-readable and easy to edit. Each service defined in this file corresponds to a Docker image and its specific configuration.

If you want to dig deeper, check out our guide on Silent Typing: Neural Tech Empowering Disabled Users.

Step 1: Create the Project Directory

Start by creating a new directory for your project. This directory will hold all your application code and the Docker Compose file. Navigate into this directory using your terminal. This keeps your project organized and ensures that relative paths within your configuration file work correctly. It is best practice to keep this directory free of unrelated files to avoid confusion during the build process.

Step 2: Write the Docker Compose File

Create a new file named docker-compose.yml in your project root. Define your services using the services key. For each service, specify the image or a build context. You can also define ports to expose services to the host machine and volumes to persist data. For example, if you are running a web application and a database, define two services: one for the app and one for the database. Ensure that the database service is named correctly, as other services will reference it by name to establish connections.

Step 3: Configure Networks and Volumes

If your services need to communicate with each other, define a network. While Docker Compose creates a default network, explicitly defining one gives you more control. Use the networks key at the root level and assign the network to your services. Similarly, define any persistent storage requirements under the volumes key. This is particularly important for databases to ensure data is not lost when containers are stopped or removed.

Step 4: Build and Start the Stack

Once your configuration is ready, open your terminal in the project directory. Run the command docker compose up --build. This command builds the images for your services (if you specified build contexts) and starts the containers. The --build flag ensures that any changes to your Dockerfiles are reflected in the running containers. You can add the -d flag to run the stack in detached mode, allowing the terminal to be free for other tasks.

Step 5: Monitor and Manage

Use docker compose ps to check the status of your running containers. If you need to see logs, use docker compose logs -f to follow the output in real-time. To stop the stack, simply run docker compose down. This stops and removes the containers, networks, and volumes defined in your file. Be cautious with the -v flag when using down, as it also removes anonymous volumes, potentially deleting your data.

Pro Tips for Success

Use environment variables to manage different configurations for development, testing, and production. Create a .env file in your project root and reference these variables in your docker-compose.yml using the ${