bookmarkly2/README.md

Bookmarkly 2.0

A clean, fast, and highly customizable self-hosted dashboard for your bookmarks.

Key Features

• Multi-Page Organization: Group your bookmarks into independent pages using Tabs. Each tab can have its own set of categories, bookmarks, and even its own custom theme.
• Advanced Customization:
  • Themes: Choose between Light, Dark, and Transparent modes.
  • Custom Backgrounds: Set a unique background for each tab. Upload your own, use a URL, or find one with the built-in Pexels integration.
  • Fine-Tune: Adjust background brightness and saturation. Add your own Custom CSS and footer HTML for a personalized touch.
• Flexible Bookmark Management:
  • Organize links into Categories within each tab.
  • Drag-and-drop sorting for both bookmarks and categories.
  • Favorites: Mark your most-used bookmarks for quick access.
  • Custom Icons: Upload your own icons or use the built-in favicon fetcher.
• Backup & Restore:
  • Full & Partial Backups: Create a full backup of the entire site or a partial backup of a single tab—including its icons, background, and settings.
  • Seamless Importing: Restore a full backup or import a tab backup into any existing tab.
• Multi-User Ready: Supports multiple users with different roles and permissions for viewing and editing tabs.
• Easy Deployment: Comes ready to deploy as a Docker container.

System Maintenance

The settings page includes a "System Maintenance" section for administrative tasks. These tools help ensure data integrity and smooth updates.

• Update Database Schema: Safely applies any necessary database changes required by new application features. It's safe to run this multiple times.
• Fix Orphaned Bookmarks: This tool solves a specific data problem where bookmarks can become "orphaned" (not linked to any tab). It finds these bookmarks and automatically assigns them to your first (default) tab, making them visible and usable again.

Getting Started (Docker)

1. Clone this repository.
2. Run docker compose up -d --build.
3. Access your new dashboard at http://localhost:8080.

Default Login:

• Username: admin
• Password: password

!! It is highly recommended to change the default password after your first login !!

Getting Started (Web Server)

You can also run Bookmarkly 2.0 on a traditional web server.

Requirements:

• Web server (e.g., Apache2 or Nginx)
• PHP 8.0 or newer
• SQLite PHP extension

Steps:

1. Clone this repository to your web server's document root.
2. Ensure the data/ directory is writable by the web server user. This is where the database and images are stored.
3. Access the site from your browser.

Default Login:

• Username: admin
• Password: password