Frequently Asked Questions

Everything you need to know about Karakeep - the self-hostable bookmark-everything app with AI

Got Questions? We've Got Answers

Explore our comprehensive FAQ to learn everything about Karakeep. From installation to advanced features, we've got you covered. Can't find what you're looking for? Join our Discord community for help!

What is Karakeep?

â–¼

Karakeep is a self-hostable bookmark-everything app that allows you to save links, take notes, and store images and PDFs all in one place. It features AI-based automatic tagging and full-text search capabilities. Originally named Hoarder, it's designed for data hoarders who want to keep their digital organized and accessible.

Built with modern web technologies, Karakeep offers a clean interface, powerful search, and seamless integration with your browser and mobile devices.

How does it work?

â–¼

Karakeep works by allowing you to save various types of content through multiple channels:

  • Browser Extensions: Save links with one click from Chrome, Firefox, or Safari
  • Mobile Apps: Save content on the go with iOS and Android apps
  • Web Interface: Use the web dashboard to add bookmarks, notes, and files
  • API: Integrate with other applications using the REST API
  • CLI: Use the command-line interface for power users

Once saved, content is automatically processed: links are fetched for metadata, images are processed with OCR, and AI models tag and summarize the content. Everything is indexed for full-text search.

How do I install it?

â–¼

Karakeep supports multiple installation methods to suit different technical levels:

  • Docker (Recommended): The easiest way to get started
  • Docker Compose: For more complex setups with custom configurations
  • Manual Installation: For advanced users who want full control

The Docker installation is as simple as running:

docker run -d -p 3000:3000 karakeep-app/karakeep

For detailed instructions, please refer to our Installation Guide.

What are the requirements?

â–¼

Karakeep has minimal requirements:

  • Hardware: Any modern server or desktop with at least 1GB RAM
  • Operating System: Linux, macOS, or Windows
  • Docker: If using Docker installation
  • Browser: Modern browsers for the web interface
  • Database: PostgreSQL (automatically managed with Docker)
  • Search Engine: Meilisearch (automatically managed with Docker)

For optimal performance with AI features, we recommend:

  • 2GB+ RAM
  • 4+ CPU cores
  • SSD storage
  • Local AI model support (optional)

Can I try it before installing?

â–¼

Absolutely! We provide a live demo so you can experience Karakeep before installing:

Demo URL: https://try.karakeep.app

Login Credentials:

  • Email: demo@karakeep.app
  • Password: demodemo

Please note that the demo is in read-only mode to prevent abuse and is reset periodically. It's a great way to explore the interface and features before committing to self-hosting.

How does AI tagging work?

â–¼

Karakeep uses Large Language Models (LLMs) to automatically tag and summarize your saved content:

  • Automatic Tagging: AI analyzes the content and suggests relevant tags
  • Summarization: Generates concise summaries for long articles and documents
  • Content Analysis: Identifies key themes and topics in your bookmarks
  • Smart Categorization: Helps organize content automatically

The AI features can be configured to use:

  • OpenAI API: For state-of-the-art results
  • Local Models: Using Ollama for privacy and offline use
  • Custom Models: Support for various LLM providers

You can enable/disable AI features in the settings and configure the frequency of processing.

Can I use local AI models?

â–¼

Yes! Karakeep supports local AI models through Ollama, giving you:

  • Privacy: Your data stays on your server
  • Offline Use: No internet connection required
  • Cost-Effective: No API costs for AI processing
  • Custom Models: Use models fine-tuned for your needs

To use local models:

  1. Install Ollama on your server
  2. Pull desired models (e.g., ollama pull llama2)
  3. Configure Karakeep to use the local model endpoint
  4. Enable AI features in the settings

Popular models supported include Llama, Mistral, and various open-source alternatives.

What search features are available?

â–¼

Karakeep provides powerful search capabilities powered by Meilisearch:

  • Full-Text Search: Search across all content including text within images
  • Instant Results: Fast search with real-time indexing
  • Advanced Filters: Filter by tags, dates, content type, and more
  • Boolean Search: Use AND, OR, NOT for complex queries
  • Fuzzy Search: Find content even with typos
  • Phrase Search: Search for exact phrases
  • Relevance Ranking: Results ranked by relevance

The search index is updated automatically as you add new content, ensuring your searches are always current.

How does OCR work?

â–¼

Optical Character Recognition (OCR) allows Karakeep to extract text from images:

  • Automatic Processing: Text is extracted when images are uploaded
  • Searchable Text: Extracted text is indexed for search
  • Multiple Languages: Supports various languages
  • High Accuracy: Uses advanced OCR algorithms
  • Background Processing: OCR runs in the background

This feature is particularly useful for:

  • Screenshots with text
  • Document photos
  • Whiteboard images
  • Infographics with text

The extracted text can be searched alongside your other content, making your image library fully searchable.

Can I collaborate with others?

â–¼

Yes! Karakeep supports collaborative features:

  • Shared Lists: Create lists that multiple users can access
  • Permissions: Control who can view, edit, or delete content
  • Real-time Updates: Changes sync instantly across users
  • Comments: Add comments to shared bookmarks
  • Activity Feed: See what others are adding to shared lists

Collaboration is perfect for:

  • Team research projects
  • Shared learning resources
  • Family collections
  • Study groups

You can invite users via email and manage their permissions through the admin interface.

What browser extensions are available?

â–¼

Karakeep offers browser extensions for all major platforms:

  • Chrome Extension: Available on the Chrome Web Store
  • Firefox Add-on: Available on Mozilla Add-ons
  • Safari Extension: Available on the App Store

Extension features include:

  • One-Click Saving: Save any webpage instantly
  • Quick Preview: See the saved content before confirming
  • Auto-Fetch: Automatically fetch page metadata
  • Keyboard Shortcuts: Quick access to save functionality
  • Context Menu: Right-click to save links

The extensions are fully compatible with the self-hosted version and work seamlessly with your Karakeep instance.

Are there mobile apps?

â–¼

Yes! Karakeep has dedicated mobile apps for both iOS and Android:

  • iOS App: Available on the App Store
  • Android App: Available on Google Play

Mobile app features include:

  • Full Functionality: Access all features on mobile
  • Offline Access: View saved content without internet
  • Camera Integration: Save photos and screenshots directly
  • Push Notifications: Get notified of new content
  • Sync Across Devices: Seamless sync with desktop
  • QR Code Scanner: Quickly save links from QR codes

The mobile apps connect directly to your self-hosted Karakeep instance, ensuring your data stays private and under your control.

Is there an API?

â–¼

Yes! Karakeep provides a comprehensive REST API for integration:

  • Full CRUD Operations: Create, read, update, and delete all content types
  • Authentication: Secure API with JWT tokens
  • Webhooks: Get notified when content changes
  • Batch Operations: Efficient bulk operations
  • Search API: Access search functionality programmatically
  • File Uploads: Upload images and documents

API features enable:

  • Third-party integrations
  • Automated content ingestion
  • Custom workflows
  • Mobile app development
  • Automated backups

Full API documentation is available in our API Documentation.

Can I import existing bookmarks?

â–¼

Absolutely! Karakeep supports importing from multiple sources:

  • Chrome Bookmarks: Import your Chrome bookmark files
  • Pocket: Import your Pocket collection
  • Linkwarden: Import from Linkwarden exports
  • Omnivore: Import from Omnivore exports
  • Tab Session Manager: Import from browser session managers
  • JSON/CSV: Import from custom formats

Import features include:

  • Batch Processing: Import thousands of bookmarks at once
  • Deduplication: Automatically remove duplicates
  • Metadata Preservation: Keep titles, descriptions, and tags
  • Progress Tracking: Monitor import progress
  • Error Handling: Graceful handling of import errors

You can also set up automatic sync with browser bookmarks using Floccus for ongoing synchronization.

How does RSS integration work?

â–¼

Karakeep can automatically monitor RSS feeds and save new content:

  • Feed Monitoring: Automatically check feeds for new items
  • Auto-Saving: Save new articles automatically
  • Filtering: Only save items matching your criteria
  • Scheduling: Configure check frequency
  • Deduplication: Avoid saving duplicate articles

RSS features are perfect for:

  • News aggregation
  • Blog monitoring
  • Research tracking
  • Competitor analysis

You can add multiple feeds and organize them into collections. Each feed can have its own settings for filtering and processing.

Why self-hosting?

â–¼

Self-hosting offers several key advantages:

  • Privacy: Your data stays on your own server
  • Control: Full control over your data and settings
  • Cost Savings: No recurring subscription fees
  • Customization: Modify and extend as needed
  • Offline Access: Access without internet connection
  • Security: You control security measures

Self-hosting is ideal for:

  • Privacy-conscious users
  • Teams with specific requirements
  • Organizations with compliance needs
  • Power users who want customization
  • Anyone who wants to avoid vendor lock-in

Plus, with Docker installation, self-hosting is easier than ever - no complex server setup required!

How secure is it?

â–¼

Security is a top priority for Karakeep:

  • Authentication: Secure login with NextAuth
  • Encryption: Data encryption at rest and in transit
  • Regular Updates: Security patches and updates
  • Input Validation: Protection against injection attacks
  • CORS Protection: Secure API access
  • Rate Limiting: Protection against abuse

Additional security measures:

  • SSO Support: Enterprise Single Sign-On integration
  • Two-Factor Authentication: Optional 2FA for extra security
  • Access Control: Granular permission management
  • Audit Logging: Track all access and changes

For detailed security information, see our Security Considerations document.

What about the cloud version?

â–¼

If self-hosting isn't for you, we offer a managed cloud service:

  • Karakeep Cloud: Hosted at cloud.karakeep.app
  • No Setup: Ready to use in minutes
  • Updates Included: Automatic updates and maintenance
  • Backup Included: Automatic backups included
  • Support Included: Priority customer support

Cloud benefits:

  • No technical knowledge required
  • Scalable infrastructure
  • 99.9% uptime guarantee
  • Global CDN for fast access
  • Enterprise-grade security

Cloud subscriptions help support the ongoing development of Karakeep. Visit cloud.karakeep.app for pricing and features.

How do I backup my data?

â–¼

Karakeep provides multiple backup options:

  • Database Backup: Export PostgreSQL database
  • File Backup: Backup all uploaded files and images
  • Export Function: Export all data in various formats
  • API Backup: Use the API for automated backups

Recommended backup strategy:

  1. Regular database dumps (daily/weekly)
  2. File system backups of upload directory
  3. Test restore process periodically
  4. Store backups in multiple locations
  5. Consider automated backup scripts

For cloud users, automatic backups are included with your subscription.

Does it support SSO?

â–¼

Yes! Karakeep supports Single Sign-On (SSO) for enterprise use:

  • SAML 2.0: Compatible with most identity providers
  • OAuth 2.0: Support for various OAuth providers
  • LDAP/AD: Integration with Active Directory
  • Custom Providers: Support for custom SSO implementations

SSO features enable:

  • Centralized authentication
  • Single password for multiple services
  • Improved security with MFA
  • Easier user management
  • Compliance with organizational policies

SSO is particularly valuable for teams and organizations that need to manage user access centrally.

27,195
GitHub Stars
1,336
Forks
659
Open Issues
TypeScript
Language

Ready to Take Control of Your Digital Life?

Join thousands of users who've already discovered the power of Karakeep