From 122d3c36f79ddade21c2f298e7bf745e169c3070 Mon Sep 17 00:00:00 2001
From: Aidan <aidan@p0ntus.com>
Date: Thu, 17 Apr 2025 17:46:51 -0400
Subject: [PATCH] docker/docs: use .example files instead for cleaner git

---
 .gitignore                                       |  3 +++
 README.md                                        |  7 ++++---
 docker-compose.yml => docker-compose.yml.example |  0
 ratelimit.json                                   | 10 ----------
 4 files changed, 7 insertions(+), 13 deletions(-)
 rename docker-compose.yml => docker-compose.yml.example (100%)
 delete mode 100644 ratelimit.json

diff --git a/.gitignore b/.gitignore
index fddc3f2..249f09c 100644
--- a/.gitignore
+++ b/.gitignore
@@ -137,4 +137,7 @@ drizzle/
 bun.lockb
 migrate.txt
 db.sqlite3
+ratelimit.json.example
 
+# Docker
+docker-compose.yml
\ No newline at end of file
diff --git a/README.md b/README.md
index 746e521..3760272 100644
--- a/README.md
+++ b/README.md
@@ -35,12 +35,13 @@ All features marked with an **E** are extended features, and are not a part of t
    bunx drizzle-kit migrate
    ```
 
-3. **Copy/modify necessary files**
+3. **Copy, move, and modify necessary files**
 
    ```bash
+   mv docker-compose.yml.example docker-compose.yml # depending on your use case, you might have to change some things here
    touch migrate.txt # put emails (one per line) which already exist on the server which users can claim
-   cp .env.example .env # you don't need to change anything here
-   vim ratelimit.json # optional, customize to your liking...
+   mv .env.example .env # you don't need to change anything here
+   mv ratelimit.json.example ratelimit.json # customize to your liking
    ```
 
    **Note:** If you are running mail-connect outside a Docker container (or changing the binds), please change the `MAILCONNECT_ROOT_DIR` to match your environment.
diff --git a/docker-compose.yml b/docker-compose.yml.example
similarity index 100%
rename from docker-compose.yml
rename to docker-compose.yml.example
diff --git a/ratelimit.json b/ratelimit.json
deleted file mode 100644
index 87128d4..0000000
--- a/ratelimit.json
+++ /dev/null
@@ -1,10 +0,0 @@
-{
-  "/list": {
-    "windowMs": 60000,
-    "limit": 20
-  },
-  "/add": {
-    "windowMs": 60000,
-    "limit": 10
-  }
-}
\ No newline at end of file