Merge pull request #136 from ho-nl/docker-composer-yml-example

Rename docker-compose.yml to docker-compose.example.yml
ho-nl · Jul 16, 2024 · ceeb556 · ceeb556
2 parents 03c3754 + a2ee62d
commit ceeb556
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -140,9 +140,10 @@ already has docker-devbox support added, please refer to the projects' own READM
 - Install this package in the project: `composer require reach-digital/docker-devbox ^4.0.0`  
 - Install `static-content-deploy` [patch](patch/static-content-deploy.md) and
   remove existing static symlinked content: `rm -rf pub/static/*/*`.
+- Copy the provided `docker-compose.example.yml` file to `docker-compose.yml`
 - Disable services you don't need in `docker-compose.yml` (required: `hitch`,
   `varnish`, `nginx`, `db` and `elasticsearch`).
-- Commit the `docker-compose.yml` file to prevent future accidental changes.
+- Commit the `docker-compose.yml` as part of your project.
 - Update or create an env.php file and with the following info
   ```
     'host' => '127.0.0.1',

diff --git a/docker-compose.yml → docker-compose.example.yml b/docker-compose.yml → docker-compose.example.yml