KaraKeep HomeDash

A more compact home page dashboard style view for browsing your KaraKeep bookmarks. All Karakeep bookmarks are shown on one single page, organized by lists. This is meant to be a very simple and uncluttered dashboard to your bookmarks, all bookmark management capabilities are done through the full (and awesome) KaraKeep app.

Features

• 📚 Masonry Layout - Efficient use of screen space with Pinterest-style columns
• 🔍 Real-time Search - Instantly filter bookmarks as you type
• 🖱️ Drag & Drop - Reorder lists to your preference
• 📱 Responsive - Works beautifully on desktop, tablet, and mobile
• 🚀 Fast - SQLite WASM runs entirely in your browser
• 🔒 Privacy-First - Your data never leaves your device

Quick Start with Docker

Prerequisites

• Docker and Docker Compose installed
• Access to your KaraKeep db.db file through a docker volume

Using Pre-built Image

1. Create a docker-compose.yml file:

version: '3.8'

services:
  karakeep-homedash:
    image: ghcr.io/codejawn/karakeep-homedash:latest
    container_name: karakeep-homedash
    ports:
      - "8595:8595"
    volumes:
      # Update path to your KaraKeep database
      - /path/to/karakeep/db.db:/app/db.db:ro
      # Config directory for persistence
      - ./config:/app/config
    restart: unless-stopped

1. Start the container:

docker-compose up -d

1. Open http://localhost:8595 in your browser

Manual Installation

Prerequisites

• Python 3.7+ (for the server)
• Your KaraKeep db.db file

Setup

1. Clone the repository:

git clone https://github.com/codejawn/karakeep-homedash.git
cd karakeep-homedash

1. Copy your KaraKeep database:

cp /path/to/karakeep/db.db .

1. Start the server:

python server.py

1. Open http://localhost:8595 in your browser

Configuration

The application uses a config/config.json file for settings. If it doesn't exist, it will be created automatically with defaults.

Configuration Options

{
  "karakeepUrl": "http://localhost:3000",
  "bookmarkTarget": "_self",
  "preferences": {
    "columnOrder": []
  }
}

Option	Description	Default
karakeepUrl	URL to your KaraKeep instance	http://localhost:3000
bookmarkTarget	Where to open bookmarks: _self (same tab) or _blank (new tab)	_self
preferences.columnOrder	Saved order of bookmark lists (managed automatically)	[]

Development

Running Locally

For development without Docker:

# Install dependencies (none required!)

# Start the development server
python server.py

# Or use any static file server if you don't need preference persistence
python -m http.server 8595

Making Changes

1. Edit the HTML, CSS, or JavaScript files
2. Refresh your browser to see changes
3. Submit a pull request with your improvements!

Generating Screenshots

To create a screenshot for documentation:

1. Open mockup.html in your browser
2. Resize window to 1440px width
3. Take a screenshot
4. Save as screenshot.png

The mockup includes sample bookmarks tailored for self-hosting enthusiasts!

Troubleshooting

"Could not find db.db"

Make sure your KaraKeep database is in the correct location: - For Docker: Check your volume mount path in docker-compose.yml - For manual installation: Copy db.db to the project directory

Bookmarks not showing

• Verify your db.db file is from KaraKeep
• Check browser console for errors
• Ensure the database contains bookmarks

Drag and drop not saving

• The config directory must be writable
• For Docker: Ensure the ./config volume is properly mounted

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the GNU V3 license - see the LICENSE file for details.

Acknowledgments

• Built to complement the amazing KaraKeep
• Uses SQLite WASM for browser-based database access