Skip to content

Latest commit

 

History

History
128 lines (87 loc) · 3.42 KB

README.md

File metadata and controls

128 lines (87 loc) · 3.42 KB

Servas

A self-hosted bookmark management tool.
Servas is based on Laravel and Inertia.js and uses Tailwind CSS and Svelte for the frontend.

Features

  • Tags: Organize your bookmarks with tags.
  • Groups: Group your bookmarks. Groups can be nested.
  • Smart Groups: Group your bookmarks based on their belonging tags.
  • Firefox and Chrome browser extension: Add sites to Servas right from your browser.
  • Multiple users: You can create multiple user accounts.
  • Responsive design: Servas looks good on all your devices.
  • Dark/light theme.
  • Two Factor Authentication available.

How to install

Docker

Servas is available as an official Docker image.

The preferred way to use Servas is with SQLite. This variant does not need an additional database container.
You can find the example files here:

The Docker image also supports MySQL and MariaDB.
You can find the example files here:

Initial steps:

  1. Create .env file in the directory where the compose.yaml is located.
  2. Copy the content of the example env file into the .env file.
  3. Change the APP_URL.
  4. Use a strong password for the DB_PASSWORD setting (only required if Servas is used with MariaDB).
  5. Start the containers with docker compose up -d.
  6. Generate the application key:
docker exec -it servas php artisan key:generate --force
  1. Restart the containers with docker compose restart.
  2. Open your browser and create a user account at https://your-servas-instance/register.

Manual

Requirements:

  • PHP 8.3
  • MariaDB, MySQL or SQLite
  • Git
  • Node.js
  • Composer
  1. Clone the repo.
  2. Install the Composer packages.
composer install --optimize-autoloader --no-dev
  1. Install the npm packages.
npm install
  1. Compile the assets.
npm run build
  1. Create .env file from the .env.example file.
  2. Change the settings in the .env file according to your needs.
  3. If you are using SQLite, you must remove the MySQL section in the .env file and uncomment the SQLite section.
  4. Run the database migrations.
php artisan migrate
  1. Generate the application key.
php artisan key:generate

Configuration

You can change some application settings in the .env file.

Description .env key Options
Enable/Disable user registration SERVAS_ENABLE_REGISTRATION true/false
Show/Hide version number in profile dropdown SERVAS_SHOW_APP_VERSION true/false

After making changes to the .env file, you must restart the application container.

User Guide

Register a new user at https://your-servas-instance/register.

Browser Extensions

Firefox and Chrome: https://github.com/beromir/servas-extension

Screenshots

Links view:

Groups view:

New link modal:

Command palette: