{"id":24334560,"url":"https://github.com/codemicro/walrss","last_synced_at":"2026-03-16T07:32:18.351Z","repository":{"id":57662538,"uuid":"476866093","full_name":"codemicro/walrss","owner":"codemicro","description":"[mirror] Email-based RSS digest generator","archived":false,"fork":false,"pushed_at":"2025-02-11T16:26:16.000Z","size":771,"stargazers_count":21,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-21T04:02:34.762Z","etag":null,"topics":["email-digest","rss"],"latest_commit_sha":null,"homepage":"https://git.tdpain.net/codemicro/walrss","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/codemicro.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-01T20:55:01.000Z","updated_at":"2025-03-26T07:19:47.000Z","dependencies_parsed_at":"2024-06-20T17:27:10.255Z","dependency_job_id":"3c607b2c-c11e-4edb-a8e1-b478610ec808","html_url":"https://github.com/codemicro/walrss","commit_stats":null,"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/codemicro/walrss","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codemicro%2Fwalrss","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codemicro%2Fwalrss/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codemicro%2Fwalrss/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codemicro%2Fwalrss/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codemicro","download_url":"https://codeload.github.com/codemicro/walrss/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codemicro%2Fwalrss/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261892077,"owners_count":23225852,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["email-digest","rss"],"created_at":"2025-01-18T04:17:13.208Z","updated_at":"2026-03-16T07:32:18.304Z","avatar_url":"https://github.com/codemicro.png","language":"Go","readme":"# walrss\n\n*Email-based RSS digest generator*\n\n[![RSS is cool](https://img.shields.io/badge/rss-is%20cool-orange?logo=rss)](https://github.com/codemicro/walrss/releases.atom) ![GitHub go.mod Go version](https://img.shields.io/github/go-mod/go-version/codemicro/walrss) [![Go Report Card](https://goreportcard.com/badge/github.com/codemicro/walrss)](https://goreportcard.com/report/github.com/codemicro/walrss) ![Lines of code](https://img.shields.io/tokei/lines/github/codemicro/walrss)\n\n---\n\n| Email                                                | Web UI                                   |\n|------------------------------------------------------|------------------------------------------|\n| ![Sample email](.github/screenshots/sampleEmail.png) | ![Web UI](.github/screenshots/webUI.png) |\n\n## Features\n\n* Multi-user support\n* Option to choose between daily or weekly digests that are sent at specific times of day\n* OPML import/export\n* [OIDC](https://en.wikipedia.org/wiki/OpenID#OpenID_Connect_(OIDC)) integration\n\n## Quickstart\n\n### Docker\n\n```bash\ndocker pull ghcr.io/codemicro/walrss:latest\nmkdir walrss-data\nnano walrss-data/config.yaml  # You'll have to fill in the required fields detailed below\ndocker run -d -v $(pwd)/walrss-data:/run -p 8080:8080 ghcr.io/codemicro/walrss:latest\n```\n\n### Build from source\n\nYou must have an up-to-date version of the Go toolchain installed. Check `go.mod` for the minimum required version.\n\n```bash\ngit clone https://github.com/codemicro/walrss.git; cd walrss\ngo build -o walrssServer github.com/codemicro/walrss/walrss\n```\n\n```bash\nmkdir walrss-data\nnano walrss-data/config.yaml  # You'll have to fill in the required fields detailed below\nWALRSS_DIR=\"./walrss-data\" ./walrssServer\n# now go to http://127.0.0.1:8080\n```\n\n## Config\n\nYour `config.yaml` file lives in your data directory, which is specified by the `WALRSS_DIR` environment variable (default is `./` or `/run` if you're using Docker). Below is a list of the possible options you can set within it.\n\n```yaml\nserver:\n  host: 127.0.0.1\n  port: 8080\n  # externalURL is the URL that your instance of Walrss is accessible at\n  # This is a required field\n  externalURL: \"http://127.0.0.1:8080\"\nemail:\n  # These are required fields\n  host: \"smtp.sendgrid.net\"\n  port: 587\n  from: \"Walrss \u003cwalrss@yourdomain.com\u003e\"\n  # These fields are not required\n  tls: \"\" # valid values are: starttls, tls, no - default: starttls\n  password: \"yourapikey\"\n  username: \"apikey\"\nplatform:\n  disableRegistration: false\n  disableSecureCookies: false\n  contactInformation: \"https://example.com\"  # optional. will be included in the user agent if set.\noidc:\n  enable: false\n  clientID: \"yourclientid\"\n  clientSecret: \"yourclientsecret\"\n  issuer: \"https://sso.example.com/\"\n```\n\n## Future features\n\n* Feed categories\n* Administrator users\n* Account controls (eg password reset, change password, etc)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodemicro%2Fwalrss","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodemicro%2Fwalrss","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodemicro%2Fwalrss/lists"}