Awesome
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.
- Later list: Add bookmarks to the "later list" to access them later.
- 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.
- Two Factor Authentication available.
How to install
Docker
Servas is available as an official Docker image.
The preferred way to use Servas is in combination with a MariaDB container.
You can find the example files here:
The Docker image also supports SQLite. This variant does not need an additional database container.
You can find the example files here:
Initial steps:
- Create
.env
file in the directory where thedocker-compose.yaml
is located. - Copy the content of the example env file into the
.env
file. - Change the
APP_URL
. - Use a strong password for the
DB_PASSWORD
setting (only required if Servas is used with MariaDB). - Start the containers with
docker-compose up -d
. - Generate the application key:
docker exec -it servas php artisan key:generate --force
- Restart the containers with
docker-compose restart
. - Open your browser and create a user account at https://your-servas-instance/register.
Manual
Requirements:
- PHP 8.1
- MariaDB, MySQL or SQLite
- Git
- Node.js
- Composer
- Clone the repo.
- Install the Composer packages.
composer install --optimize-autoloader --no-dev
- Install the npm packages.
npm install
- Compile the assets.
npm run build
- Create
.env
file from the.env.example
file. - Change the settings in the
.env
file according to your needs. - If you are using SQLite, you must remove the MySQL section in the
.env
file and uncomment the SQLite section. - Run the database migrations.
php artisan migrate
- 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 |
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: https://github.com/beromir/servas-firefox-extension
Chrome: https://github.com/beromir/servas-chrome-extension
Screenshots
Links view:
Groups view:
New link modal:
Command palette: