add documentation

2024-09-21 02:52:59 +05:00 · 2024-09-21 02:52:59 +05:00 · 18120ada8b
commit 18120ada8b
parent 0c54b9cc22
1 changed files with 22 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -0,0 +1,22 @@
+## SMTP to Telegram
+
+## Deploy
+1. Create `compose.yml`
+```yml
+services:
+  smtp-to-telegram:
+    image: git.shihaam.dev/shihaam/smtp-to-telegram
+    restart: always
+    env_file: .env
+    ports:
+      - 2525:2525
+```
+2. Fill .env
+```
+TELEGRAM_API_KEY=
+TELEGRAM_CHAT_ID=
+```
+3. Start the container `docker compose up -d`
+
+
+