From 414313360586e444a221de39590455a2407f4f96 Mon Sep 17 00:00:00 2001 From: AKP Date: Wed, 6 Apr 2022 11:24:45 +0100 Subject: Add README.md content Signed-off-by: AKP --- .github/screenshots/sampleEmail.png | Bin 0 -> 83428 bytes .github/screenshots/webUI.png | Bin 0 -> 198689 bytes README.md | 51 ++++++++++++++++++++++++++++++++++++ 3 files changed, 51 insertions(+) create mode 100644 .github/screenshots/sampleEmail.png create mode 100644 .github/screenshots/webUI.png diff --git a/.github/screenshots/sampleEmail.png b/.github/screenshots/sampleEmail.png new file mode 100644 index 0000000..97bf3bb Binary files /dev/null and b/.github/screenshots/sampleEmail.png differ diff --git a/.github/screenshots/webUI.png b/.github/screenshots/webUI.png new file mode 100644 index 0000000..111cca5 Binary files /dev/null and b/.github/screenshots/webUI.png differ diff --git a/README.md b/README.md index 2c89cf8..ceed4b6 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,54 @@ # walrss *Email-based RSS digest generator* + +--- + +![Sample email](.github/screenshots/sampleEmail.png) + +![Web UI](.github/screenshots/webUI.png) + +## Quickstart: Docker + +```bash +docker pull ghcr.io/codemicro/walrss:latest +docker run -d -v $(pwd)/walrss-data:/run -p 8080:8080 ghcr.io/codemicro/walrss:latest +``` + +## Quickstart: Build from source + +You must have an up-to-date version of the Go toolchain installed. Check `go.mod` for the minimum required version. + +```bash +git clone https://github.com/codemicro/walrss.git; cd walrss +go build github.com/codemicro/walrss/walrss +``` + +```bash +mkdir walrss-data +WALRSS_DIR="./walrss-data" ./walrss +``` + +## Config + +Your `config.yaml` file lives in your data directory, which is specified by the `WALRSS_DIR` environment variable (default is `./`). + +```yaml +server: + host: 127.0.0.1 + port: 8080 + # externalURL is the URL that your instance of Walrss is accessible at + # This is a required field + externalURL: "http://127.0.0.1:8080" +email: + # Defaults are not provided for any email option + # All of the below are required fields + password: "yourapikey" + username: "apikey" + host: "smtp.sendgrid.net" + port: 587 + from: "Walrss " +platform: + disableRegistration: false + disableSecureCookies: false +``` -- cgit v1.2.3-70-g09d2