From bf40565a7501df4b85aa5b5f2e8331d36a59b3f1 Mon Sep 17 00:00:00 2001
From: Egor Aristov <ef@efprojects.com>
Date: Fri, 7 Feb 2025 13:03:22 +0300
Subject: [PATCH] readme

---
 README.md   | 22 ++++++++++++++++++++++
 deploy/.env |  2 +-
 2 files changed, 23 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index f4d3baa..e42764c 100644
--- a/README.md
+++ b/README.md
@@ -30,3 +30,25 @@ youtube
 
 Program is still under development. The code architecture is not final, tests are missing, no CI, no demo page, no docs,
 etc...
+
+## Deployment
+
+```bash
+git clone https://github.com/egor3f/rssalchemy
+cd rssalchemy/deploy
+docker-compose up -d
+```
+
+Then open your browser targeting to port 8080.
+
+For SSL, authentication, domains, etc. - use Caddy or Nginx (no specific configuration required). Personally I recommend Caddy, if you haven't used it before - give it a try :)
+
+### Configuration
+
+Configuration is done using [config.yml](config.yml) file or env vars 
+
+Env vars always has precedence over config.yml
+
+Docker-compose deployment uses [deploy/.env file](deploy/.env)
+
+You can see all available options in [config.go file](internal/config/config.go) (struct Config)
diff --git a/deploy/.env b/deploy/.env
index 01c302e..1395bf6 100644
--- a/deploy/.env
+++ b/deploy/.env
@@ -1,3 +1,3 @@
 WEBSERVER_ADDRESS=0.0.0.0:8080
 NATS_URL=nats://nats:4222
-DEBUG=true
+DEBUG=false