Skip to content

veverkap/xExtension-karakeep-button

Repository files navigation

FreshRSS Karakeep Button

A FreshRSS extension which adds a Karakeep sharing integration.

With this extension you can simply press the Karakeep Button next to an article or a custom keyboard shortcut to share it with Karakeep. Everything else happens in the background while you can continue reading articles without any further interruptions.

Download and setup

  1. Download the latest release
  2. Extract and upload it to the ./extensions folder of your FreshRSS installation
  3. Go to your Karakeep instance User Settings -> API Keys
  4. Create a new API key
  5. Enter your Karakeep instance url in the Karakeep Button extension settings
  6. Enter your API key in the Karakeep Button extension settings
  7. Press "Connect to Karakeep"
  8. Optional Set a custom keyboard shortcut

Karakeep API Error codes

If you get errors while trying to connect to Karakeep, please check the Karakeep API Documentation.

Contributing

Translations

If you'd like to translate the extension to another language please file a pull request. I'd be happy to merge it!

Development

For local development pull the repository. The prerequisite is Docker installed.

Go to the repository root folder and run docker compose up that will start a local FreshRSS instance running http://localhost:8080/.

Complete it's installation and navigate to Extensions, where you have to enable Karakeep Button.

All changes in the PHP files are loaded with each page refresh.

Credits

This extension is based on freshrss-readeck-button and re-branded for Karakeep.

Thank you very much Joedmin for creating the Readeck extension.

About

Add FreshRSS articles to Karakeep with one simple button click or a keyboard shortcut.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •