egor3f/rssalchemy
1
0
Fork 0
Code Actions Packages Releases Wiki Activity

readme

Browse Source
This commit is contained in:
Egor Aristov 2025-02-07 13:03:22 +03:00
parent 45312e5e3c
commit bf40565a75
Signed by: egor3f
GPG Key ID: 40482A264AAEC85F
2 changed files with 23 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
README.md
View File

@ -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, Program is still under development. The code architecture is not final, tests are missing, no CI, no demo page, no docs,
etc... 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)

2
deploy/.env
View File

@ -1,3 +1,3 @@
WEBSERVER_ADDRESS=0.0.0.0:8080 WEBSERVER_ADDRESS=0.0.0.0:8080
NATS_URL=nats://nats:4222 NATS_URL=nats://nats:4222
DEBUG=true DEBUG=false