changed app readeck: updated description.md
This commit is contained in:
parent
0292accfa5
commit
626043dca8
1 changed files with 126 additions and 69 deletions
|
|
@ -1,118 +1,175 @@
|
||||||
<h1 align="center">
|
# Readeck
|
||||||
<picture>
|
|
||||||
<source media="(prefers-color-scheme: dark)" srcset="https://www.linkace.org/images/linkace-social-dark-transparent.png">
|
|
||||||
<img src="https://www.linkace.org/images/linkace-social.jpg" alt="Linkace">
|
|
||||||
</picture>
|
|
||||||
</h1>
|
|
||||||
|
|
||||||
<p align="center"><b>Your self-hosted tool for effortlessly archiving, organizing, and sharing your favorite web links.</b></p>
|
[](https://www.gnu.org/licenses/agpl-3.0)
|
||||||
|
<a rel="me" href="https://mastodon.online/@readeck"><img src="https://img.shields.io/badge/%40readeck-blue?logo=mastodon&logoColor=%23fff&color=%236364ff" alt="Follow on Mastodon" /></a>
|
||||||
|
|
||||||
<p align="center">
|
Readeck is a simple web application that lets you save the
|
||||||
<a href="https://mastodon.social/@linkace"><img src="https://img.shields.io/badge/%40linkace%40mastodon.social-6364ff" alt="Follow LinkAce on Mastodon"></a>
|
precious readable content of web pages you like and want to keep
|
||||||
<a href="https://x.com/LinkAceApp"><img src="https://img.shields.io/badge/X.com%2FLinkAceApp-black" alt="Follow LinkAce on X.com"></a>
|
forever. \
|
||||||
<a href="https://github.com/Kovah/LinkAce/releases"><img src="https://img.shields.io/github/v/release/kovah/linkace?label=Latest%20Release" alt="Latest Release"></a>
|
See it as a bookmark manager and a read later tool.
|
||||||
<a href="https://opensource.org/licenses/GPL-3.0"><img src="https://img.shields.io/github/license/kovah/linkace.svg" alt="License"></a>
|
|
||||||
</p>
|
|
||||||
<p> </p>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Contents
|
## Contents
|
||||||
|
|
||||||
* [About LinkAce](#about-linkace)
|
- [Features](#features)
|
||||||
* [Setup](#gear-setup)
|
- [Installation](#how-to-test-or-install)
|
||||||
* [Support](#bulb-support-for-linkace)
|
- [FAQ](#faq)
|
||||||
* [Contribution](#construction-contribution)
|
- [Under the hood](#under-the-hood)
|
||||||
|
- [License](#license)
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
### 🔖 Bookmarks
|
||||||
|
|
||||||
|
Like a page you're reading? Paste the link in Readeck and you're done!
|
||||||
|
|
||||||
### About LinkAce
|
### 📸 Articles, pictures and videos
|
||||||
|
|
||||||
|
Readeck saves the readable content of web pages for you to read later. It also detects when a page is an image or a video and adapts its process accordingly.
|
||||||
|
|
||||||
LinkAce ia a powerful, self-hosted solution for managing your personal link archive. Save articles for later reading, bookmark useful tools, and preserve important web content long-term – all in one place. With a clean, user-friendly interface, you can easily categorize and retrieve your links, and even share collections with friends, family, or coworkers. LinkAce isn't meant to replace your browser bookmarks, but rather to provide you with a robust, personalized database for curating and managing your online discoveries. Whether you're a professional, a researcher or simply an avid internet user, you'll find this tool invaluable for organizing your web resources efficiently and effectively.
|
### ⭐ Labels, favorites, archives
|
||||||
|
|
||||||
👉 [**Try the Demo**](https://demo.linkace.org)
|
Move bookmarks to archives or favorites and add as many labels as you want.
|
||||||
|
|
||||||
|
### 🖍️ Highlights
|
||||||
|
|
||||||
#### Feature Highlights
|
Highlight the important content of your bookmarks to easily find it later.
|
||||||
|
|
||||||
* Organize bookmarks with the help of lists and tags.
|
### 🗃️ Collections
|
||||||
* Multi-user support with internal sharing of links, lists or tags.
|
|
||||||
* OAuth and OIDC are supported for SSO login to LinkAce.
|
|
||||||
* Automated link monitoring informs you when any links become unavailable or were moved.
|
|
||||||
* Automated archiving of saved sites via the [Internet Archive](https://web.archive.org/).
|
|
||||||
* A full REST API offers access to all features of LinkAce from other apps and services.
|
|
||||||
* LinkAce is also [available on Zapier](https://zapier.com/apps/linkace/integrations) and integrates with over 2500+ applications.
|
|
||||||
* An advanced search including different filters and ordering.
|
|
||||||
* A bookmarklet to quickly save links from any browser.
|
|
||||||
* Save links with automatic title and description generation.
|
|
||||||
* LinkAce ships with a light and dark theme, that can be toggled or changes automatically.
|
|
||||||
* Links can be private or public, so friends or internet strangers may see your collection.
|
|
||||||
* Both private and public lists of links are accessible via RSS feeds.
|
|
||||||
* Import and export of bookmarks from and to HTML.
|
|
||||||
* Support for complete database and application backups to any AWS S3-compatible storage.
|
|
||||||
|
|
||||||
More screenshots of the app and further details about the features can be found on the [LinkAce Website](https://www.linkace.org/).
|
If you need a dedicated section with all your bookmarks from the past 2 weeks labeled with "cat", Readeck lets you save this search query into a collection so you can access it later.
|
||||||
|
|
||||||
|
### 🧩 Browser Extension
|
||||||
|
|
||||||
|
Want to keep something for later while browsing? No need to copy and paste a link. Install the browser extension and save bookmarks in one click!
|
||||||
|
|
||||||
|
- [For Mozilla Firefox](https://addons.mozilla.org/en-US/firefox/addon/readeck/)
|
||||||
|
- [For Google Chrome](https://chromewebstore.google.com/detail/readeck/jnmcpmfimecibicbojhopfkcbmkafhee)
|
||||||
|
- [More Information and Source Code](https://codeberg.org/readeck/browser-extension)
|
||||||
|
|
||||||
### :gear: Setup
|
### 📖 E-Book export
|
||||||
|
|
||||||
LinkAce provides multiple ways of installing it on your server. The complete documentation for all installation methods can be found [**in the wiki**](https://www.linkace.org/docs/v2/setup/).
|
What's better than reading your collected articles on your e-reader? You can export any article to an e-book file (EPUB). You can even export a collection to a single book!
|
||||||
|
|
||||||
* [Setup with Docker](https://www.linkace.org/docs/v2/setup/setup-with-docker/)
|
On top of that, you can directly access Readeck's catalog and collections from your e-reader if it supports OPDS.
|
||||||
* [Setup without Docker](https://www.linkace.org/docs/v2/setup/setup-with-php/)
|
|
||||||
* [One-Click Deployment to the Cloud](https://www.linkace.org/docs/v2/setup/one-click-deploy/)
|
|
||||||
* [Setup with Kubernetes](https://www.linkace.org/docs/v2/setup/setup-to-k8s/) (Beta)
|
|
||||||
* [Official managed Hosting](https://hosting.linkace.org) (_Beta Waitlist_)
|
|
||||||
|
|
||||||
|
### 🔎 Full text search
|
||||||
|
|
||||||
> **LinkAce 2.0 was just released!** This is a big upgrade to the application. Please read the [upgrade guide](https://www.linkace.org/docs/v2/upgrade/from-v1/) if you are still using LinkAce 1 and want to use version 2.
|
Whether you need to find a vague piece of text from an article, or all the articles with a specific label or from a specific website, we've got you covered!
|
||||||
|
|
||||||
|
### 🚀 Fast!
|
||||||
|
|
||||||
|
Readeck is a modern take on so-called boring, but proven, technology pieces. It guarantees very quick response times and a smooth user experience.
|
||||||
|
|
||||||
### :bulb: Support for LinkAce
|
### 🔒 Built for your privacy and long term archival
|
||||||
|
|
||||||
I built LinkAce to solve my own problem, and I now offer my solution and code without charging any money. I spent a lot of my free time building this application, so I won't offer any *free* personal support, customization or installation help. If you need help please visit the [community discussions](https://github.com/Kovah/LinkAce/discussions) and post your issue there.
|
Will this article you like be online next year? In 10 year? Maybe not; maybe it's all gone, text and images. For this reason, and for your privacy, text and images are all stored in your Readeck instance the moment you save a link.
|
||||||
|
|
||||||
:star: You can get personal and dedicated support by **becoming a supporter on [Open Collective](https://opencollective.com/linkace), [Patreon](https://www.patreon.com/Kovah) or [Github](https://github.com/sponsors/Kovah)**.
|
With the exception of videos, not a single request is made from your browser to an external website.
|
||||||
|
|
||||||
#### Our Supporters on Open Collective
|
## How to test or install
|
||||||
|
|
||||||
<a href="https://opencollective.com/linkace"><img src="https://opencollective.com/linkace/individuals.svg?width=890"></a>
|
Done reading this promotional content? Good! Want to try Readeck on your laptop or a server? Even better!
|
||||||
|
|
||||||
|
### Container
|
||||||
|
|
||||||
### Documentation and Community
|
To install or test Readeck with Docker or Podman, simply run the image:
|
||||||
|
|
||||||
Details about all features and advanced configuration can be found in the [**project documentation**](https://www.linkace.org/docs/v2).
|
```shell
|
||||||
Additionally, you may visit the [community discussions](https://github.com/Kovah/LinkAce/discussions) to share your ideas, talk with other users or find help for specific problems.
|
docker run --rm -ti -p 8000:8000 -v readeck-data:/readeck codeberg.org/readeck/readeck:latest
|
||||||
|
```
|
||||||
|
|
||||||
|
You'll find all the container images there: \
|
||||||
|
[https://codeberg.org/readeck/-/packages/container/readeck/latest](https://codeberg.org/readeck/-/packages/container/readeck/latest)
|
||||||
|
|
||||||
|
### Binary file installation
|
||||||
|
|
||||||
|
Readeck is distributed as a single binary file. Using it is almost as easy as a container.
|
||||||
|
|
||||||
### :construction: Contribution
|
- Create a new directory
|
||||||
|
```shell
|
||||||
|
mkdir -p readeck-install
|
||||||
|
cd readeck-install
|
||||||
|
```
|
||||||
|
- Download the file matching your system from the [last release](https://codeberg.org/readeck/readeck/releases)
|
||||||
|
|
||||||
[](https://crowdin.com/project/linkace) [](https://app.codacy.com/gh/Kovah/LinkAce/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade) 
|
- Make this file executable
|
||||||
|
- Launch Readeck with the `serve` argument, for example:
|
||||||
|
```shell
|
||||||
|
./readeck-0.9.1-linux-amd64 serve
|
||||||
|
```
|
||||||
|
|
||||||
Please consult the [**contribution guidelines**](CONTRIBUTING.md) to start working on LinkAce.
|
### First time launch
|
||||||
|
|
||||||
|
Once Readeck has started, it is accessible at: \
|
||||||
|
**[http://localhost:8000/](http://localhost:8000/)**
|
||||||
|
|
||||||
|
### Installation from source code
|
||||||
|
|
||||||
|
Installing from source can be useful to try out unreleased Readeck versions, or to set up a development environment for contributing code. For more information, see the [development documentation](https://readeck.org/en/docs/dev).
|
||||||
|
|
||||||
Thanks go to these wonderful people for their contributions:
|
### Installation for production
|
||||||
|
|
||||||
[](https://github.com/Kovah/LinkAce/graphs/contributors)
|
If you already know how to deploy containers on a server, installing Readeck for production should be quite straightforward. As for deploying to Linux servers with systemd and NGINX reverse proxy, see the [deployment guide](https://readeck.org/en/docs/deploy).
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
|
||||||
|
Please refer to the [FAQ on readeck.org](https://readeck.org/en/docs/faq).
|
||||||
|
|
||||||
|
## Under the hood
|
||||||
|
|
||||||
LinkAce is a project by [Kevin Woblick](https://woblick.dev) and [Contributors](https://github.com/Kovah/LinkAce/graphs/contributors)
|
Readeck was born out of frustration (and COVID lock-downs) from the tools that don't save everything related to the saved content, primarily images.
|
||||||
|
This key principle guided every step of Readeck development.
|
||||||
|
|
||||||
|
### The ZIP file
|
||||||
|
|
||||||
|
Every bookmark is stored in a single, immutable, ZIP file. Parts of this file (HTML content, images, etc.) are directly served by the application or converted to a web page or an e-book when needed.
|
||||||
|
|
||||||
|
### A simple database
|
||||||
|
|
||||||
|
Readeck has a very simple database schema with a few tables (and a bit of clever JSON fields here and there). The recommended database engine is SQLite for most installations.
|
||||||
|
|
||||||
|
### A simple stack
|
||||||
|
|
||||||
|
Unlike many modern web applications, Readeck is not a single page application built on top of an API with impossible to install dependencies and a mess of background processes.
|
||||||
|
|
||||||
|
Readeck is written in [Go](https://go.dev/) and all its content is rendered server side with some interactivity brought by [Stimulus](https://stimulus.hotwired.dev/) and [Turbo](https://turbo.hotwired.dev/).
|
||||||
|
|
||||||
|
This has proven to be a great combination when performance really matters.
|
||||||
|
|
||||||
|
### Contributing
|
||||||
|
|
||||||
|
Readeck's simple stack means that the barrier to entry is relatively low when it comes to contributing to the Readeck project. Contributions are welcome by filing issues, participating in community discussions, submitting translations, and proposing changes to the source code. For more information, see the [documentation on contributing](https://readeck.org/en/contribute).
|
||||||
|
|
||||||
|
## License
|
||||||
|
|
||||||
|
Readeck is distributed under the terms of the [GNU Affero General Public License v3.0](https://www.gnu.org/licenses/agpl-3.0.html). Here's a short summary of the license conditions:
|
||||||
|
|
||||||
|
- Permissions
|
||||||
|
- **Commercial use** \
|
||||||
|
The licensed material and derivatives may be used for commercial purposes.
|
||||||
|
- **Distribution** \
|
||||||
|
The licensed material may be distributed.
|
||||||
|
- **Modification** \
|
||||||
|
The licensed material may be modified.
|
||||||
|
- **Patent use** \
|
||||||
|
This license provides an express grant of patent rights from contributors.
|
||||||
|
- **Private use** \
|
||||||
|
The licensed material may be used and modified in private.
|
||||||
|
- Conditions
|
||||||
|
- **Disclose source** \
|
||||||
|
Source code must be made available when the licensed material is distributed.
|
||||||
|
- **License and copyright notice** \
|
||||||
|
A copy of the license and copyright notice must be included with the licensed material.
|
||||||
|
- **Network use is distribution** \
|
||||||
|
Users who interact with the licensed material via network are given the right to receive a copy of the source code.
|
||||||
|
- **Same license** \
|
||||||
|
Modifications must be released under the same license when distributing the licensed material. In some cases a similar or related license may be used.
|
||||||
|
- **State changes** \
|
||||||
|
Changes made to the licensed material must be documented.
|
||||||
|
- Limitations
|
||||||
|
- **Liability** \
|
||||||
|
This license includes a limitation of liability.
|
||||||
|
- **Warranty** \
|
||||||
|
This license explicitly states that it does NOT provide any warranty.
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue