Update docker-compose procedure

InvoiceShelf · Feb 8, 2024 · f2bc8fb · f2bc8fb
1 parent f15a806
commit f2bc8fb
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 1 deletion.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,3 @@
 .idea/
+docker-compose.yml
+invoiceshelf
diff --git a/README.md b/README.md
@@ -80,7 +80,10 @@ alter user 'invoiceshelf' identified with mysql_native_password by '<your passwo
 
 ### Run with Docker Compose
 
-Change the environment variables in the [provided example](./docker-compose.yml) to reflect your database credentials.
+To run with `docker-compose` follow the steps:
+
+1. Copy the `docker-compose.yml.example` to `docker-compose.yml`
+2. Change the environment variables in the [provided example](./docker-compose.yml.example) to reflect your database credentials.
 
 Note that in order to avoid writing credentials directly into the file, you can create a `db_secrets.env` and use the `env_file` directive (see the [docs](https://docs.docker.com/compose/environment-variables/#the-env_file-configuration-option)).
 

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