Skip to content

Commit 62d7d72

Browse files
orchard0crypt0rr
andauthored
Revise README for Karakeep features and description (#253)
* Revise README for Karakeep features and description Updated the README to reflect Karakeep's new features and focus on being a bookmark-everything app. * Fix formatting and improve README.md content * Fix formatting of automatic sync feature in README --------- Co-authored-by: Bart <57799908+crypt0rr@users.noreply.github.com>
1 parent 144d2e4 commit 62d7d72

1 file changed

Lines changed: 28 additions & 11 deletions

File tree

services/karakeep/README.md

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,37 @@
1-
# Karakeep with Tailscale Sidecar Configuration
1+
# Karakeep with Tailscale Sidecar Configuration
22

33
This Docker Compose configuration sets up **[Karakeep](https://github.com/karakeep-app/karakeep)** with Tailscale as a sidecar container to securely manage and access your self-hosted notes and collaboration app over a private Tailscale network. By integrating Tailscale, you can ensure that your Karakeep instance is only accessible to authorized devices within your Tailscale network, protecting your ideas and information from the public web.
44

5-
## Karakeep
5+
## Karakeep
66

7-
[Karakeep](https://github.com/karakeep-app/karakeep) is an **open-source, self-hosted alternative to Google Keep**, designed for simple note-taking and fast access. It supports collaborative editing, Markdown formatting, drag-and-drop organization, and tagging. Karakeep offers a clean, modern interface and is ideal for individuals or teams who want a privacy-focused, cloud-free way to manage notes and ideas.
7+
[Karakeep](https://github.com/karakeep-app/karakeep) is an open-source, self-hosted **bookmark-everything app (links, notes and images)** with AI-based automatic tagging and full text search.
88

9-
## Key Features
9+
## Key Features
1010

11-
- **Simple Note-Taking** – Create and organize notes with a beautiful, fast UI.
12-
- **Collaborative Editing** – Share and edit notes in real time with others.
13-
- **Markdown Support** – Use lightweight formatting for structured notes.
14-
- **Tagging and Organization** – Categorize and manage content with tags and drag-and-drop.
15-
- **Self-Hosted & Private** – Own your data, free from third-party cloud services.
16-
- **Secure Access with Tailscale** – Restrict access to your notes using your private Tailscale network.
11+
- 🔗 Bookmark links, take simple notes and store images and pdfs.
12+
- ⬇️ Automatic fetching for link titles, descriptions and images.
13+
- 📋 Sort your bookmarks into lists.
14+
- 👥 Collaborate with others on the same list.
15+
- 🔎 Full text search of all the content stored.
16+
- ✨ AI-based (aka chatgpt) automatic tagging and summarization. With supports for local models using ollama!
17+
- 🤖 Rule-based engine for customized management.
18+
- 🎆 OCR for extracting text from images.
19+
- 🔖 Chrome plugin and Firefox addon for quick bookmarking.
20+
- 📱 An iOS app, and an Android app.
21+
- 📰 Auto hoarding from RSS feeds.
22+
- 🔌 REST API and multiple clients.
23+
- 🌐 Multi-language support.
24+
- 🖍️ Mark and store highlights from your hoarded content.
25+
- 🗄️ Full page archival (using monolith) to protect against link rot.
26+
- ▶️ Auto video archiving using yt-dlp.
27+
- ☑️ Bulk actions support.
28+
- 🔐 SSO support.
29+
- 🌙 Dark mode support.
30+
- 💾 Self-hosting first. Own your data, free from third-party cloud services.
31+
- ⬇️ Bookmark importers from Chrome, Pocket, Linkwarden, Omnivore, Tab Session Manager.
32+
- 🔄 Automatic sync with browser bookmarks via floccus.
33+
- **Secure Access with Tailscale** – Restrict access to your data using your private Tailscale network.
1734

18-
## Configuration Overview
35+
## Configuration Overview
1936

2037
In this setup, the `tailscale-karakeep` service runs Tailscale, which manages secure networking for the Karakeep service. The `karakeep` service uses the Tailscale network stack via Docker's `network_mode: service:` configuration. This ensures that Karakeep’s web interface is only accessible through the Tailscale network (or locally, if preferred), enhancing the privacy and security of your notes and collaborative workspace.

0 commit comments

Comments
 (0)