Portainer Templates logo

Portainer Templates

Shaarli Shaarli

Stack

Link Sharing

The personal, minimalist, super fast, database-free, bookmarking service.

Image details

Architecture: amd64, arm64, arm/v7
Image size: 48 MB
User: shaarli

Source details

Repo: shaarli/shaarli
Stars: 4k
Forks: 313
Language: PHP
Latest: v0.16.5 · 15 days ago
Updated: 4 days ago
Website: shaarli.readthedocs.io/

Configuration

Type
Compose
Platform
linux
Image
ghcr.io/shaarli/shaarli:latest
Ports
7755:80
Volumes
/var/www/shaarli/cache : /portainer/Files/AppData/Config/shaarli/cache/var/www/shaarli/data : /portainer/Files/AppData/Config/shaarli/data
Env vars
PUID=1026PGID=100TZ=Europe/Athens
Restart
on-failure
Source
Repo

Template by xneo1·Source

Standalone Install

Select an install method, to see config/commands for deploying Shaarli

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Shaarli, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  shaarli:
    container_name: Shaarli
    image: ghcr.io/shaarli/shaarli:latest
    restart: on-failure
    ports:
      - 7755:80
    volumes:
      - /portainer/Files/AppData/Config/shaarli/cache:/var/www/shaarli/cache:rw
      - /portainer/Files/AppData/Config/shaarli/data:/var/www/shaarli/data:rw
    environment:
      PUID: 1026
      PGID: 100
      TZ: Europe/Athens

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/shaarli.yml up -d

More install options in our documentation, or see shaarli/shaarli for app-specific guidance.

Shaarli logo
The personal, minimalist, super fast, database-free, bookmarking service.
Do you want to share the links you discover? Shaarli is a minimalist link sharing service that you can install on your own server. It is designed to be personal (single-user), fast and handy.
Join the chat at https://gitter.im/shaarli/Shaarli Docker repository

Quickstart

Demo

You can use this public demo instance of Shaarli. It runs the latest development version of Shaarli and is updated/reset daily.
Login: demo; Password: demo

License

Shaarli is Free Software. See COPYING for a detail of the contributors and licenses for each individual component.

Serve Shaarli on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying shaarli.example.com to http://shaarli:80

Add this to your Caddyfile

shaarli.example.com {
	reverse_proxy http://shaarli:80
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:7755 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :7755
  • Stop the other service, or pick a different host port. In 7755:80 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:7755. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, shaarli can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 7755

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1026:100 /portainer/Files/AppData/Config/shaarli/cache (and the same for the other mapped folders)
  • Or set the PUID and PGID variables (defaults 1026:100) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/shaarli/shaarli:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64, arm/v7
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Shaarli is a Compose stack, a set of containers defined in one file and brought up together by Portainer, then started and stopped as a single app.

The app image

An image is the app packed up ready to go, everything Shaarli needs bundled into one download. This template pulls ghcr.io/shaarli/shaarli:latest, which Docker fetches once (about 48 MB) and then starts your own copy from.

Where the image comes from

Docker pulls its images from registries, public libraries of ready-built apps. Shaarli's comes from the GitHub Container Registry, published by shaarli.

Version tags

The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.

Which machines it runs on

Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.

Ports

A port is the door the app answers on. A mapping like 7755:80 means it's reachable on port 7755 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:7755 in a browser. It opens:

  • 7755:80, likely the web interface

Volumes

A volume is where Shaarli keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/www/shaarli/cache from /portainer/Files/AppData/Config/shaarli/cache on the host
  • /var/www/shaarli/data from /portainer/Files/AppData/Config/shaarli/data on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Shaarli takes 3 of them, all with defaults you can leave alone or tweak:

  • PUID, defaults to 1026
  • PGID, defaults to 100
  • TZ, defaults to Europe/Athens

Restart policy

The restart policy here is on-failure, so Shaarli only gets restarted when it exits with an error, not when it finishes cleanly or you stop it yourself. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Users and permissions

The PUID and PGID settings tell it which user and group to act as on your host. Point them at your own account (find yours with id $USER) so the files it writes into your mounted folders come out owned by you rather than root.

Networking

Nothing custom is set, so Shaarli sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.

Container name

Once it's deployed, Portainer names the container shaarli. That's what you'll spot in the containers list and use in commands like docker logs shaarli.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Shaarli up. Add the template list to Portainer once, then deploying Shaarli is a click rather than a wall of config.