Frequently Asked Questions

Is there an Android or iOS application?

Development of mobile applications is underway. You can already try and test the following:

• Readeck iOS, for iOS
• Eckard, for Android

If you'd like to have a sharing target you can use the following:

• On Android: HTTP Shortcuts, check the related discussion and comment for a configuration sample.
• On iOS: you can use this shortcut

I can't save a link or it's incomplete

Readeck usually can save the vast majority of news or blog articles but it sometimes fails to do so. The most common reasons are:

• The page is behind a paywall,
• The page needs JavaScript to render its content,
• Your server is blocked,
• The content extractor fails.

The most common solution to these problems is to install and use the Browser Extension. The extension sends the page's full content to Readeck, so anything can be saved. Moreover, it lets you select the exact content you want to save.

If a page really doesn't work at all, please open an issue.

Can I share a saved bookmark with a public link?

Yes you can, for a limited time. On each article you can generate a link that'll be valid for 24 hours. You can generate a new link as many times as you want but it will always expire. You can also export or print an article to a PDF file.

Is there a system to store my (paywall) website credentials?

There isn't, for several reasons:

• To safely store credentials without giving access to anyone but the user is next to impossible,
• Such a system relies on web scrapping and is prone to break too often,
• It might go against websites TOS.

Again, the Browser Extension will let you save any content you can access from your web browser.

Does Readeck provides an API?

Yes, Readeck provides an HTTP API. You'll find its documentation in Readeck itself.

Can I use SingleFile with Readeck?

Yes! You can setup SingleFile to send its extraction result to Readeck. To do so:

• Set File Format > format to "HTML".
• Check Destination > upload to a REST Form API.
• Add your Readeck URL as in: https://{host}/api/bookmarks and a generated API Token.
• Set archive data field name to "html" and archive URL field name to "url".

Does it run behind Cloudflare tunnel or CDN?

Please refer to the deployment documentation.

Is there a roadmap?

There are milestones, where you can see what's planned for the future releases.

Is there a Readeck twitter account?

There isn't but you can follow @readeck@mastodon.online on Mastodon.

Is the a Readeck Discord server?

There isn't but you can join #readeck:matrix.org on Matrix.

How can I contribute to Readeck?

You can help in many ways, even without coding experience. Please read the Contribute to Readeck page for more details.

How can I report a security issue?

If you think you found a security issue in Readeck, please DO NOT create an issue; they're public and it could potentially put all users at risk.

Send an email to security@readeck.com and you'll receive a follow-up as soon as possible.