worker-planet/README.md

# Worker-planet

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.

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/

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 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.

## 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)
- **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)

## 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.

After that, you should "precompile" that file using the following command:

> \$ npm run template -- templates/default.handlebars -f templates/default.precompiled.js

If the template name you are using is different from `default`, you should change the following 2 lines in `index.js`:

```javascript
import template from './templates/default.precompiled'
```

```javascript
let template = Handlebars.templates['default']
```