dethos
/
worker-planet
mirror of https://github.com/dethos/worker-planet.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

improvements to the README file

This commit is contained in:
Gonçalo Valério 2024-04-19 19:46:14 +01:00
parent 5cfbf4df7d
commit 029ad0bc0f
Signed by: dethos
GPG Key ID: DF557F2BDCC2445E
1 changed files with 23 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@ -1,35 +1,41 @@
# Worker-planet
This project is meant to be an easy way to aggregate in a single page content from multiple sources.
This project is meant to be an easy way to aggregate, on a single page, content from multiple sources.
It takes a list of existing RSS feeds, aggregates their contents and displays them in chronological order.
It was inspired by other software packages such as [Planet](<https://en.wikipedia.org/wiki/Planet_(software)>) and [MoonMoon](https://moonmoon.org/) but runs on top of Cloudflare Workers instead of being deployed on your own server.
It was inspired by other software packages, such as [Planet](<https://en.wikipedia.org/wiki/Planet_(software)>) and [MoonMoon](https://moonmoon.org/), but runs on top of Cloudflare Workers instead of being deployed on your own server.
This ends up being specially useful for communities, in order to follow the work being done and published by its members. Some examples of existing "planets" (but using different software):
This ends up being especially useful for communities to follow the work being done and published by their members.
Below are some examples of existing "planets" that use different software:
- https://planet.debian.org/
- https://planet.kde.org/
- https://planet.gnome.org/
**Note:** This project is still in its early days, so expect some rough edges. Any contributions are welcome.
An example of a live planet using `worker-planet` software is:
- https://infosecplanet.ovalerio.net
_If you wish to add your deployment to this list, feel free to create a PR._
# How to deploy
1. Clone this repository
2. Install the project dependencies: `npm install`
3. Create a `wrangler.toml` file based on the existing `wrangler.toml.example`
4. Create KV namespaces and add their ids to the `kv_namespaces` setting on `wrangler.toml`
5. Add your `account_id` and customize all the `vars` in `wrangler.toml`. `FEEDS` should be
a string of coma separated urls, to each of the RSS/ATOM sources that will be part of your planet.
6. Build the worker bundle: `npm run build`
7. Deploy your new worker: `npm run deploy`
1. Clone this repository.
2. Install the project dependencies: `npm install`.
3. Create a `wrangler.toml` file based on the existing `wrangler.toml.example`.
4. Create KV namespaces and add their IDs to the `kv_namespaces` setting on `wrangler.toml`.
5. Add your `account_id` and customize all the `vars` in `wrangler.toml`. `FEEDS` should be a string of comma-separated URLs, one for each of the RSS/ATOM sources that will be part of your planet.
6. Build the worker bundle: `npm run build`.
7. Deploy your new worker: `npm run deploy`.
**Note:** For the last step you might need to set the `CLOUDFLARE_API_TOKEN` environment variable.
**Note:** For the last step, you might need to set the `CLOUDFLARE_API_TOKEN` environment variable.
## Configuration variables
- **FEEDS** - list of sources used to fetch the planet's content (separate each url with a comma)
- **TITLE** - Name of your planet (included in the generated html page and RSS feed)
- **FEEDS** - list of sources used to fetch the planet's content (separate each URL with a comma)
- **TITLE** - Name of your planet (included in the generated HTML page and RSS feed)
- **DESCRIPTION** - Free text to be included on the page (currently not used on the included template)
- **MAX_SIZE** - Number of posts/entries that will be included on the page/feed
- **CACHE_MAX_AGE** - To avoid hitting the KV store each time the content is fetched, the static content is cached. You should adjust this value to the frequency you pick for your cron. Defined in seconds (default: 3600)
@ -37,9 +43,9 @@ This ends up being specially useful for communities, in order to follow the work
## Customize the generated HTML
Each community has its own identity, so you should be able to easily customize the look and feel
of the generated page. To do so, before publishing you can edit one of the existing templates in the `templates` folder.
of the generated page. To do so, before publishing, you can edit one of the existing templates in the `templates` folder.
After, you should "precompile" that file using the following command:
After that, you should "precompile" that file using the following command:
> \$ npm run template -- templates/default.handlebars -f templates/default.precompiled.js