shiori v0.1.0

Apps

Shiori — a simple, fast bookmark manager written in Go: save, tag, search, and archive pages for offline reading, with a clean web UI and a CLI. Deployed as a single host-networked Nomad service on SQLite with a data volume.

nomad-pack run shiori --registry nomploy

Source ↗ Project ↗ ★ 11.6k

2 tasks http 8105 1 volume image ghcr.io/go-shiori/shiori:latest

Variables 10

values.hcl

Save as values.hcl, edit, then run:

nomad-pack run shiori -f values.hcl --registry nomploy

# The name of the Nomad job.
job_name = "shiori"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The Shiori container image. Pin a tag in production.
image = "ghcr.io/go-shiori/shiori:latest"

# Host port for the Shiori web UI.
port = 8105

# Secret used to sign sessions (SHIORI_HTTP_SECRET_KEY). Set a long random value.
secret_key = "change-me-to-a-long-random-secret"

# UID Shiori runs as (the image is distroless/nonroot). The data volume is chown'd to this.
uid = 65532

# Named volume for the SQLite database and archived pages (/shiori).
data_volume = "shiori_data"

# Placement constraints. Pin to the node holding the volume. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# The task resources.
resources = {
    cpu    = 200
    memory = 128
  }

Name	Type	Default	Description
job_name	string	"shiori"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"ghcr.io/go-shiori/shiori:latest"	The Shiori container image. Pin a tag in production.
port	number	8105	Host port for the Shiori web UI.
secret_key set me	string	"change-me-to-a-long-random-secret"	Secret used to sign sessions (SHIORI_HTTP_SECRET_KEY). Set a long random value.
uid	number	65532	UID Shiori runs as (the image is distroless/nonroot). The data volume is chown'd to this.
data_volume	string	"shiori_data"	Named volume for the SQLite database and archived pages (/shiori).
constraints	list	[]	Placement constraints. Pin to the node holding the volume. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources	object	{ cpu = 200 memory = 128 }	The task resources.

Readme

shiori

Shiori — a simple, fast bookmark manager written in Go: save, tag, search, and archive pages for offline reading, with a clean web UI and a CLI.

Single host-networked Nomad service on SQLite with a data volume. A busybox prestart task chowns the data volume to Shiori's UID (the image is distroless/nonroot).

Deploy

nomad-pack registry add nomploy https://github.com/Nomploy/nomad-packs
nomad-pack run shiori --registry=nomploy

Configure

Variable	Default	Description
`port`	`8105`	Web UI port.
`secret_key`	placeholder	`SHIORI_HTTP_SECRET_KEY` — set a long random value.
`uid`	`65532`	User Shiori runs as; data volume is chown'd to it.
`data_volume`	`shiori_data`	`/shiori` — SQLite database + archives.
`image`	`ghcr.io/go-shiori/shiori:latest`	Image. Pin a tag in production.
`resources`	`{ cpu = 200, memory = 128 }`	Task resources.

Default login is shiori / gopher — change it immediately. See also the linkwarden pack (heavier, with full-page archiving). Pin the job to the node holding the volume with constraints.