From 569b7d2f25da120473937ab5719eba5ab0e314e1 Mon Sep 17 00:00:00 2001 From: Matt Jankowski Date: Wed, 5 Jun 2024 19:54:59 -0400 Subject: [PATCH] Clarify the purpose of separate Docker resources (#30568) --- Dockerfile | 3 +++ README.md | 4 +++- docker-compose.yml | 3 +++ 3 files changed, 9 insertions(+), 1 deletion(-) diff --git a/Dockerfile b/Dockerfile index 6d342db43..09aa8f2dd 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,5 +1,8 @@ # syntax=docker/dockerfile:1.7 +# This file is designed for production server deployment, not local development work +# For a containerized local dev environment, see: https://github.com/mastodon/mastodon/blob/main/README.md#docker + # Please see https://docs.docker.com/engine/reference/builder for information about # the extended buildx capabilities used in this file. # Make sure multiarch TARGETPLATFORM is available for interpolation diff --git a/README.md b/README.md index b8ee3f5db..45291d637 100644 --- a/README.md +++ b/README.md @@ -101,7 +101,9 @@ To set up **MacOS** for native development, complete the following steps: ### Docker -For development with **Docker**, complete the following steps: +For production hosting and deployment with **Docker**, use the `Dockerfile` and +`docker-compose.yml` in the project root directory. To create a local +development environment with **Docker**, complete the following steps: - Install Docker Desktop - Run `docker compose -f .devcontainer/docker-compose.yml up -d` diff --git a/docker-compose.yml b/docker-compose.yml index e7ae95ea7..7089b0d14 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,3 +1,6 @@ +# This file is designed for production server deployment, not local development work +# For a containerized local dev environment, see: https://github.com/mastodon/mastodon/blob/main/README.md#docker + services: db: restart: always