This repository contains the instruction and commands for running Espial from the pre-built docker images on Docker Hub.
Espial is an open-source, web-based bookmarking server.
It allows mutiple accounts, but currently intended for self-host scenarios.
The bookmarks are stored in a sqlite3 database, for ease of deployment & maintenence.
The easist way for logged-in users to add bookmarks, is with the "bookmarklet", found on the Settings page.
https://github.com/jonschoning/espial
- These commands use
docker compose
with settings indocker-compose.yml
- see
Makefile
for additional commands
- Clone this repository
git clone https://github.com/jonschoning/espial-docker
cd espial-docker
- Pull the image from Docker Hub
make pull
- Start Espial
./espial-svc-start
- When the app starts, it should create the DB
espial.sqlite3
in the current directory (or according todocker-compose.yml
)
- Create a user
docker compose exec espial ./migration createuser --conn /app/data/espial.sqlite3 --userName myusername --userPassword myuserpassword
- see
docker compose exec espial ./migration
for all available cli commands - the
/app/data/
prefix is necessary as it is the internal volume inside the container, seedocker-compose.yml
to adjust
- Import a pinboard bookmark file for a user (optional)
docker compose exec espial ./migration importbookmarks --conn /app/data/espial.sqlite3 --userName myusername --bookmarkFile /app/data/sample-bookmarks.json
- Import a firefox bookmark file for a user (optional)
docker compose exec espial ./migration importfirefoxbookmarks --conn /app/data/espial.sqlite3 --userName myusername --bookmarkFile /app/data/firefox-bookmarks.json
- Stop Espial
./espial-svc-stop
copy this repo to /opt/espial/
a serivce unit is provided at etc/systemd/system/espial.service
which references:
espial-svc-start
espial-svc-stop
adjust espial-svc-start
to control where logs are stored.
jonschoning/espial:espial
is based on
jonschoning/espial:scratch
which can be found here:
https://github.com/jonschoning/espial-scratch
default app http port: 3000
ssl: use reverse proxy