Self-host Shaarli with Levelrail

A minimalist personal bookmark manager, link sharer and microblog with no database. zlib licensed. On first open, the install page asks you to create the admin login.

  • Authorshaarli
  • LicenceZlib
  • Memory128 MiB
  • Archarm64
  • Services1

How to self-host Shaarli

  1. Pull the images

    One image is pulled on your server.

    Show images
    • ghcr.io/shaarli/shaarli:v0.16.10
  2. Create the app

    One service starts in a single Compose app, with 2 named volume mounts for your data, on port 80.

  3. Fill in the secrets

    1 setting is preset, you do not have to fill in anything.

  4. Open it

    Without a domain the app gets an sslip.io address; add --domain SERVICE=HOST to use your own.

Shaarli requirements

Memory
About 128 MiB
Architectures
amd64 image published, arm64 image published
Ports
80
Domain
Optional, an sslip.io address is used without one
Settings
none to fill in
License
Zlib, permissive license
  • Listed. It is in the catalog but not verified. Back up the data volume before changing an image tag.

Install Levelrail first

On a server with Levelrail running, run the command above, or open the dashboard: Apps, New app, Browse templates, then Shaarli. New to Levelrail? Install it on a fresh VPS first.

docker pull ghcr.io/glincker/levelrail:latest

Then levelrail-cli login --device. See Getting started and the Shaarli docs page.

Deploy Shaarli your way

Every format below deploys the same pinned images. Pick the one that fits how you work.

Deploy Shaarli from the CLI

Add --domain SERVICE=HOST to serve a service on your own domain, for example --domain shaarli=app.example.com.

levelrail-cli templates install shaarli --name my-shaarli

Deploy Shaarli with the API

Create a token in the dashboard first. Name, env and domains are the request fields.

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
  https://levelrail.example.com/api/v1/service-templates/shaarli/install \
  -d '{
    "name": "my-shaarli"
  }'

Shaarli configuration

Shaarli services

ServiceImagePortsVolumes
shaarli ghcr.io/shaarli/shaarli:v0.16.10 80 data -> /var/www/shaarli/datacache -> /var/www/shaarli/cache

Shaarli environment variables

VariableServiceValue
TZ shaarli Preset by the template

Ports and volumes

Ports
80
Volumes
2 named mounts: data -> /var/www/shaarli/data, cache -> /var/www/shaarli/cache

Shaarli FAQ

How much memory does Shaarli need?

The catalog lists about 128 MiB of memory for Shaarli.

Does Shaarli run on arm64?

For Shaarli, an arm64 image is published; amd64 is image published.

What licence is Shaarli under?

Shaarli is licensed under Zlib, which is permissive, with few conditions on reuse.

Does Shaarli need configuration before it starts?

No. The template fills in its own defaults.

Which ports does Shaarli use?

Shaarli listens on port 80 inside the stack.

Where does Shaarli keep its data?

In named volumes: data mounted at /var/www/shaarli/data and cache mounted at /var/www/shaarli/cache.

Can I deploy Shaarli on Dokploy or Dokku?

The services and pinned images on this page can be run on any Docker host. The public Dokploy templates list we compared does not have an entry with the same id for Shaarli, so on Dokploy you would use a Docker Compose application with the file from this page. Dokku deploys container images with its own commands, so the pinned image ghcr.io/shaarli/shaarli:v0.16.10 is what you deploy there.

levelrail-cli templates install shaarli --name my-shaarli