Archives/Athou_commafeed
1
0
Fork 1
mirror of https://github.com/Athou/commafeed.git synced 2026-03-21 21:37:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

add a section in the readme about the public instance

Browse Source
This commit is contained in:
Athou
2025-12-12 14:20:25 +01:00
parent 853fc600dd
commit dfcff5029b
1 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
README.md
View File

@@ -26,11 +26,18 @@ Google Reader inspired self-hosted RSS reader, based on Quarkus and React/TypeSc
- MySQL - MySQL
- MariaDB - MariaDB
## Deployment ## Usage
### Public instance
A free public instance is available at https://www.commafeed.com.
It has no ads, no tracking, and your data is never exploited or sold to third parties. The service is funded entirely through donations.
However, this public instance does have a few limitations compared to self-hosted setups, outlined [here](https://github.com/Athou/commafeed/discussions/1567).
### Docker ### Docker
Docker is the easiest way to get started with CommaFeed. Docker is the easiest way to get started with self-hosted CommaFeed.
Docker images are built automatically and are available at https://hub.docker.com/r/athou/commafeed Docker images are built automatically and are available at https://hub.docker.com/r/athou/commafeed
@@ -103,7 +110,7 @@ There are multiple ways to configure CommaFeed:
- Environment variables (keys in UPPER_CASE) - Environment variables (keys in UPPER_CASE)
- a `.env` file in the working directory (keys in UPPER_CASE) - a `.env` file in the working directory (keys in UPPER_CASE)
The properties file is recommended because CommaFeed will be able to warn about invalid properties and typos. When in doubt, the properties file is recommended because CommaFeed will be able to warn about invalid properties and typos.
All [CommaFeed settings](https://athou.github.io/commafeed/documentation) are optional and have sensible default values. All [CommaFeed settings](https://athou.github.io/commafeed/documentation) are optional and have sensible default values.