manugratx/newsrack

Generate a GitHub-hosted newsrack of magazines and newspapers for your Kindle/ereader

newsrack

Generate an online "newsrack" of periodicals for your ereader.

Features:

• Download anywhere using your device browser
• Subscribe via OPDS feeds

Uses calibre + recipes, GitHub Actions, and hosted on GitHub Pages.

Running Your Own Instance

General Steps

1. Fork this repository.
2. Create a new branch, for example custom. Using a new branch makes a few things, like contributing fixes for example, easier.
3. Add your own recipes to the recipes_custom/ folder and customise _recipes_custom.py. Optional.
4. Customise the cron schedule and job run time in .github/workflows/build.yml. Optional.
5. Set the new branch custom as default
   • from Settings > Branches > Default branch
6. Enable Pages in repository settings to deploy from GitHub Actions
   • from Settings > Pages > Build and deployment > Source
7. If needed, manually trigger the Build workflow from Actions to start your first build.

What Can Be Customised

newsrack supports extensive customisation such as:

• add/remove recipes
• the formats generated
• when recipes are executed
• cover colours and fonts

Review the wiki page to understand what can be customised and how to do so.

You can also refer to the example fork repo and see the actual customisations in action.

Available Recipes

newsrack has its own set of customised recipes. The full list of available recipes can be viewed on here.