mirror of
https://github.com/linkwarden/linkwarden.git
synced 2026-03-03 02:27:00 +00:00
150 lines
8.6 KiB
Markdown
150 lines
8.6 KiB
Markdown
<div align="center">
|
||
<img src="./assets/logo.png" width="100px" />
|
||
<h1>Linkwarden</h1>
|
||
<h3>Bookmarks, Evolved</h3>
|
||
|
||
<a href="https://discord.com/invite/CtuYV47nuJ"><img src="https://img.shields.io/discord/1117993124669702164?logo=discord&style=flat" alt="Discord"></a>
|
||
<a href="https://twitter.com/LinkwardenHQ"><img src="https://img.shields.io/twitter/follow/linkwarden" alt="Twitter"></a> <a href="https://news.ycombinator.com/item?id=36942308"><img src="https://img.shields.io/badge/Hacker%20News-280-%23FF6600"></img></a>
|
||
|
||
<a href="https://github.com/linkwarden/linkwarden/releases"><img alt="GitHub release" src="https://img.shields.io/github/v/release/linkwarden/linkwarden"></a>
|
||
<a href="https://crowdin.com/project/linkwarden">
|
||
<img src="https://badges.crowdin.net/linkwarden/localized.svg" alt="Crowdin" /></a>
|
||
<a href="https://opencollective.com/linkwarden"><img src="https://img.shields.io/opencollective/all/linkwarden" alt="Open Collective"></a>
|
||
|
||
</div>
|
||
|
||
<div align='center'>
|
||
|
||
[« LAUNCH DEMO »](https://demo.linkwarden.app)
|
||
|
||
[Cloud](https://cloud.linkwarden.app) · [Website](https://linkwarden.app) · [Features](https://github.com/linkwarden/linkwarden#features) · [Docs](https://docs.linkwarden.app)
|
||
|
||
<img src="./assets/home.png" />
|
||
|
||
</div>
|
||
|
||
## Intro & motivation
|
||
|
||
**Linkwarden is a self-hosted, open-source collaborative bookmark manager to collect, read, annotate, and fully preserve what matters, all in one place.**
|
||
|
||
The objective is to organize useful webpages and articles you find across the web in one place, and since useful webpages can go away (see the inevitability of [Link Rot](https://en.wikipedia.org/wiki/Link_rot)), Linkwarden also saves a copy of each webpage as a Screenshot and PDF, ensuring accessibility even if the original content is no longer available.
|
||
|
||
In addition to preservation, Linkwarden provides a user-friendly reading and annotation experience that blends the simplicity of a “read-it-later” tool with the reliability of a web archive. Whether you’re highlighting key ideas, jotting down thoughts, or revisiting content long after it’s disappeared from the web, Linkwarden keeps your knowledge accessible and organized.
|
||
|
||
Linkwarden is also designed with collaboration in mind, enabling you to share links with the public and/or collaborate seamlessly with multiple users.
|
||
|
||
> [!TIP]
|
||
> Our official [Cloud](https://linkwarden.app/#pricing) offering provides the simplest way to begin using Linkwarden and it's the preferred choice for many due to its time-saving benefits. <br> Your subscription supports our hosting infrastructure and ongoing development. <br> Alternatively, if you prefer self-hosting Linkwarden, you can do so by following our [Installation documentation](https://docs.linkwarden.app/self-hosting/installation).
|
||
|
||
## Features
|
||
|
||
- 📸 Auto capture a screenshot, PDF, and single html file of each webpage
|
||
- 📖 Reader view of the webpage, with the ability to highlight and annotate text
|
||
- 🏛️ Send your webpage to Wayback Machine ([archive.org](https://archive.org)) for a snapshot (optional)
|
||
- ✨ Local AI Tagging to automatically tag your links based on their content (optional)
|
||
- 📂 Organize links by collection, sub-collection, name, description and multiple tags
|
||
- 👥 Collaborate on gathering links in a collection
|
||
- 🎛️ Customize the permissions of each member
|
||
- 🌐 Share your collected links and preserved formats with the world
|
||
- 📱 Native iOS and android mobile apps
|
||
- 🔍 Full text search, filter and sort for easy retrieval
|
||
- 🌓 Dark/Light mode support
|
||
- 🧩 Browser extension (star it [here](https://github.com/linkwarden/browser-extension)!)
|
||
- 🔄 Browser Synchronization (using [Floccus](https://floccus.org)!)
|
||
- ⬆️ Upload from SingleFile (check out the [guide](https://docs.linkwarden.app/Usage/upload-from-singlefile))
|
||
- 🔐 SSO integration (Enterprise and Self-hosted users only)
|
||
- 🍎 iOS Shortcut to save links to Linkwarden
|
||
- 🔑 API keys
|
||
- ✅ Bulk actions
|
||
- 👥 User administration
|
||
- 🌐 Support for other languages (i18n)
|
||
- 📁 Image and PDF uploads
|
||
- 🎨 Custom icons for links and collections
|
||
- 🔔 RSS feed subscription
|
||
- ✨ And many more features (literally!)
|
||
|
||
## Get Our Official Mobile App
|
||
|
||
<img src="./assets/mobile_apps.png" alt="Different screens (iPad, Pixel, and iPhone)" width="400" />
|
||
|
||
> [!IMPORTANT]
|
||
> To use the app you’ll first need a Linkwarden account.
|
||
|
||
To create an account, you can choose between:
|
||
|
||
- [**Linkwarden Cloud**](https://linkwarden.app/#pricing) – instant setup, and your subscription directly supports ongoing development.
|
||
- [**Self-hosted Linkwarden**](https://docs.linkwarden.app/self-hosting/installation) – free, but you’ll need to deploy and maintain a Linkwarden instance on a server.
|
||
|
||
After creating an account, download the app from your preferred store:
|
||
|
||
[](https://apps.apple.com/app/linkwarden/id6752550960)
|
||
[](https://play.google.com/store/apps/details?id=app.linkwarden)
|
||
|
||
(To get the app as an APK outside Google Play, check out our [builds](https://github.com/linkwarden/builds) repository.)
|
||
|
||
## Like what we're doing? Give us a Star ⭐
|
||
|
||
|
||
|
||
## We're building our Community 🌐
|
||
|
||
Join and follow us in the following platforms to stay up to date about the most recent features and for support:
|
||
|
||
<a href="https://discord.com/invite/CtuYV47nuJ"><img src="https://img.shields.io/discord/1117993124669702164?logo=discord&style=flat" alt="Discord"></a>
|
||
|
||
<a href="https://twitter.com/LinkwardenHQ"><img src="https://img.shields.io/twitter/follow/linkwarden" alt="Twitter"></a>
|
||
|
||
<a href="https://fosstodon.org/@linkwarden"><img src="https://img.shields.io/mastodon/follow/110748840237143200?domain=https%3A%2F%2Ffosstodon.org" alt="Mastodon"></a>
|
||
|
||
## Suggestions
|
||
|
||
We _usually_ go after the [popular suggestions](https://github.com/linkwarden/linkwarden/issues?q=is%3Aissue%20is%3Aopen%20sort%3Areactions-%2B1-desc). Feel free to open a [new issue](https://github.com/linkwarden/linkwarden/issues/new?assignees=&labels=enhancement&projects=&template=feature_request.md&title=) to suggest one - others might be interested too! :)
|
||
|
||
## Roadmap
|
||
|
||
Make sure to check out our [public roadmap](https://github.com/orgs/linkwarden/projects/1).
|
||
|
||
## Community Projects
|
||
|
||
Here are some community-maintained projects that are built around Linkwarden:
|
||
|
||
- [My Links](https://apps.apple.com/ca/app/my-links-for-linkwarden/id6504573402) - iOS and MacOS Apps, maintained by [JGeek00](https://github.com/JGeek00).
|
||
- [LinkDroid](https://fossdroid.com/a/linkdroid-for-linkwarden.html) - Android App with share sheet integration, [source code](https://github.com/Dacid99/LinkDroid-for-Linkwarden).
|
||
- [LinkGuardian](https://github.com/Elbullazul/LinkGuardian) - An Android client for Linkwarden. Built with Kotlin and Jetpack compose.
|
||
- [StarWarden](https://github.com/rtuszik/starwarden) - A browser extension to save your starred GitHub repositories to Linkwarden.
|
||
|
||
## Development
|
||
|
||
If you want to contribute, Thanks! Start by choosing one of our [popular suggestions](https://github.com/linkwarden/linkwarden/issues?q=is%3Aissue%20is%3Aopen%20sort%3Areactions-%2B1-desc), just please stay in touch with [@daniel31x13](https://github.com/daniel31x13) before starting.
|
||
|
||
# Translations
|
||
|
||
If you want to help us translate Linkwarden to your language, please check out our [Crowdin page](https://crowdin.com/project/linkwarden) and start translating. We would love to have your help!
|
||
|
||
To start translating a new language, please create an issue so we can set it up for you. New languages will be added once they reach at least 50% translation completion.
|
||
|
||
<a href="https://crowdin.com/project/linkwarden">
|
||
<img src="https://badges.crowdin.net/linkwarden/localized.svg" alt="Crowdin" /></a>
|
||
|
||
## Security
|
||
|
||
If you found a security vulnerability, please do **not** create a public issue, instead send an email to [security@linkwarden.app](mailto:security@linkwarden.app) stating the vulnerability. Thanks!
|
||
|
||
## Support <3
|
||
|
||
Other than using our official [Cloud](https://linkwarden.app/#pricing) offering, any [donations](https://opencollective.com/linkwarden) are highly appreciated as well!
|
||
|
||
Here are the other ways to support/cheer this project:
|
||
|
||
- Starring this repository.
|
||
- Joining us on [Discord](https://discord.com/invite/CtuYV47nuJ).
|
||
- Referring Linkwarden to a friend.
|
||
|
||
If you did any of the above, Thanksss! Otherwise thanks.
|
||
|
||
## Thanks to All the Contributors 💪
|
||
|
||
Huge thanks to these guys for spending their time helping Linkwarden grow. They rock! ⚡️
|
||
|
||
<img src="https://contributors-img.web.app/image?repo=linkwarden/linkwarden" alt="Contributors"/>
|