Portainer Templates logo

Portainer Templates

Shiori (stack) Shiori (stack)

Tools

Shiori is a simple bookmarks manager written in the Go language. Intended as a simple clone of Pocket.You can use it as command line application or as web application.

Image details

Architecture: amd64, arm64, arm/v7
Image size: 13 MB
User: go-shiori

Source details

Repo: go-shiori/shiori
Stars: 11.6k
Forks: 625
Language: Go
License: MIT
Latest: v1.8.0 · 10 months ago
Updated: 1 month ago

Configuration

Type
Compose
Platform
linux
Image
ghcr.io/go-shiori/shiori
Ports
8580:8080
Volumes
/data : /portainer/Files/AppData/Config/shiori
Env vars
TZ=Europe/AthensPUID=1000PGID=1000
Restart
unless-stopped
Source
Repo

Template by xneo1·Source

Standalone Install

Select an install method, to see config/commands for deploying Shiori (stack)

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 Shiori (stack), 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:
  shiori:
    image: ghcr.io/go-shiori/shiori
    container_name: shiori-default
    environment:
      - TZ=Europe/Athens
      - PUID=1000
      - PGID=1000
    ports:
      - 8580:8080
    restart: unless-stopped
    volumes:
      - /portainer/Files/AppData/Config/shiori:/data

Or deploy it directly from the source:

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

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

Shiori

IC Go Report Card #shiori-general:matrix.org Containers
Check out our latest Announcements
Shiori is a simple bookmarks manager written in the Go language. Intended as a simple clone of Pocketpocket. You can use it as a command line application or as a web application. This application is distributed as a single binary, which means it can be installed and used easily.
!Screenshotscreenshot

Features

  • Basic bookmarks management i.e. add, edit, delete and search.
  • Import and export bookmarks from and to Netscape Bookmark file.
  • Import bookmarks from Pocket.
  • Simple and clean command line interface.
  • Simple and pretty web interface for those who don't want to use a command line app.
  • Portable, thanks to its single binary format.
  • Support for sqlite3, PostgreSQL, MariaDB and MySQL as its database.
  • Where possible, by default shiori will parse the readable content and create an offline archive of the webpage.
  • BETA web extensionweb-extension support for Firefox and Chrome.

!Comparison of reader mode and archive modemode-comparison

Documentation

All documentation is available in the docs folderdocumentation. If you think there is incomplete or incorrect information, feel free to edit it by submitting a pull request.

License

Shiori is distributed under the terms of the MIT licensemit, which means you can use it and modify it however you want. However, if you make an enhancement for it, if possible, please send a pull request.

Serve Shiori (stack) 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 shiori-stack.example.com to http://shiori:8080

Add this to your Caddyfile

shiori-stack.example.com {
	reverse_proxy http://shiori:8080
}

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:8580 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8580
  • Stop the other service, or pick a different host port. In 8580:8080 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:8580. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, shiori can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8580

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 1000:1000 /portainer/Files/AppData/Config/shiori
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/go-shiori/shiori

  • "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.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

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

Shiori (stack) 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 Shiori (stack) needs bundled into one download. This template pulls ghcr.io/go-shiori/shiori, which Docker fetches once (about 13 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. Shiori (stack)'s comes from the GitHub Container Registry, published by go-shiori.

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 8580:8080 means it's reachable on port 8580 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:8580 in a browser. It opens:

  • 8580:8080, likely the web interface

Volumes

A volume is where Shiori (stack) 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:

  • /data from /portainer/Files/AppData/Config/shiori on the host

Environment variables

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

  • TZ, defaults to Europe/Athens
  • PUID, defaults to 1000
  • PGID, defaults to 1000

Restart policy

The restart policy here is unless-stopped, so Docker restarts Shiori (stack) after a crash or reboot, but leaves it off when you stop it on purpose. 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 Shiori (stack) 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 shiori. That's what you'll spot in the containers list and use in commands like docker logs shiori.

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.

Open source license

Shiori (stack) is open source, released under the MIT license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.

Portainer app templates

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