Portainer Templates logo

Portainer Templates

Hoarder Hoarder

Stack

Bookmarks

Hoarder is an open source 'Bookmark Everything' app that uses AI for automatically tagging the content you throw at it.

Configuration

Type
Compose
Platform
linux
Source

Template by xneo1·Source

Services

hoarder-web

Configuration

Image
ghcr.io/hoarder-app/hoarder-web:latest
Ports
3088:3000
Volumes
/data : /portainer/Files/AppData/Config/hoarder/data
Env vars
REDIS_HOST=redisMEILI_ADDR=http://meilisearch:7700DATA_DIR=/dataHOARDER_VERSION=latestNEXTAUTH_SECRET=qxo0NvLCphGhkAu5fBcS1B0MxCeoig8GNEXTAUTH_URL=http://localhost:3088MEILI_MASTER_KEY=aqxYm5UWCphGhkAu5fBcSJAPbSzeoiC2X
Restart
unless-stopped

Image details

User: hoarder-app

hoarder-redis

Configuration

Image
redis:7.2-alpine
Volumes
/data : /portainer/Files/AppData/Config/hoarder/redis
Restart
unless-stopped

Image details

Pulls: 11.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 9 days ago
Status: active

hoarder-chrome

Configuration

Image
gcr.io/zenika-hub/alpine-chrome:123
Command
--no-sandbox,--disable-gpu,--disable-dev-shm-usage,--remote-debugging-address=0.0.0.0,--remote-debugging-port=9222,--hide-scrollbars
Restart
unless-stopped

hoarder-meilisearch

Configuration

Image
getmeili/meilisearch:v1.6
Volumes
/meili_data : /portainer/Files/AppData/Config/hoarder/meilisearch
Env vars
MEILI_NO_ANALYTICS=trueHOARDER_VERSION=latestNEXTAUTH_SECRET=qxo0NvLCphGhkAu5fBcS1B0MxCeoig8GNEXTAUTH_URL=http://localhost:3088MEILI_MASTER_KEY=aqxYm5UWCphGhkAu5fBcSJAPbSzeoiC2X
Restart
unless-stopped

Image details

Pulls: 48.0M
User: getmeili
Created: Nov 22, 2019
Updated: 5 hours ago
Status: active

hoarder-workers

Configuration

Image
ghcr.io/hoarder-app/hoarder-workers:latest
Volumes
/data : /portainer/Files/AppData/Config/hoarder/data
Env vars
REDIS_HOST=redisMEILI_ADDR=http://meilisearch:7700BROWSER_WEB_URL=http://chrome:9222DATA_DIR=/dataHOARDER_VERSION=latestNEXTAUTH_SECRET=qxo0NvLCphGhkAu5fBcS1B0MxCeoig8GNEXTAUTH_URL=http://localhost:3088MEILI_MASTER_KEY=aqxYm5UWCphGhkAu5fBcSJAPbSzeoiC2X
Restart
unless-stopped

Image details

User: hoarder-app

Standalone Install

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

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 Hoarder, 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:
  hoarder-web:
    image: ghcr.io/hoarder-app/hoarder-web:latest
    restart: unless-stopped
    volumes:
      - /portainer/Files/AppData/Config/hoarder/data:/data
    ports:
      - 3088:3000
    environment:
      REDIS_HOST: redis
      MEILI_ADDR: http://meilisearch:7700
      DATA_DIR: /data
      HOARDER_VERSION: latest
      NEXTAUTH_SECRET: qxo0NvLCphGhkAu5fBcS1B0MxCeoig8G
      NEXTAUTH_URL: http://localhost:3088
      MEILI_MASTER_KEY: aqxYm5UWCphGhkAu5fBcSJAPbSzeoiC2X
  hoarder-redis:
    image: redis:7.2-alpine
    restart: unless-stopped
    volumes:
      - /portainer/Files/AppData/Config/hoarder/redis:/data
  hoarder-chrome:
    image: gcr.io/zenika-hub/alpine-chrome:123
    restart: unless-stopped
    command:
      - --no-sandbox
      - --disable-gpu
      - --disable-dev-shm-usage
      - --remote-debugging-address=0.0.0.0
      - --remote-debugging-port=9222
      - --hide-scrollbars
  hoarder-meilisearch:
    image: getmeili/meilisearch:v1.6
    restart: unless-stopped
    environment:
      MEILI_NO_ANALYTICS: "true"
      HOARDER_VERSION: latest
      NEXTAUTH_SECRET: qxo0NvLCphGhkAu5fBcS1B0MxCeoig8G
      NEXTAUTH_URL: http://localhost:3088
      MEILI_MASTER_KEY: aqxYm5UWCphGhkAu5fBcSJAPbSzeoiC2X
    volumes:
      - /portainer/Files/AppData/Config/hoarder/meilisearch:/meili_data
  hoarder-workers:
    image: ghcr.io/hoarder-app/hoarder-workers:latest
    restart: unless-stopped
    volumes:
      - /portainer/Files/AppData/Config/hoarder/data:/data
    environment:
      REDIS_HOST: redis
      MEILI_ADDR: http://meilisearch:7700
      BROWSER_WEB_URL: http://chrome:9222
      DATA_DIR: /data
      HOARDER_VERSION: latest
      NEXTAUTH_SECRET: qxo0NvLCphGhkAu5fBcS1B0MxCeoig8G
      NEXTAUTH_URL: http://localhost:3088
      MEILI_MASTER_KEY: aqxYm5UWCphGhkAu5fBcSJAPbSzeoiC2X
      # OPENAI_API_KEY: ...
    depends_on:
      hoarder-web:
        condition: service_started

volumes:
  redis:
  meilisearch:
  data:

Or deploy it directly from the source:

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

More install options in our documentation.

Container Documentation

hoarder-redis Documentation

Redis is the world’s fastest data platform for caching, vector search, and NoSQL databases.

Serve Hoarder 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 hoarder.example.com to http://hoarder-web:3000

Add this to your Caddyfile

hoarder.example.com {
	reverse_proxy http://hoarder-web:3000
}

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

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

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/hoarder/data (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull ghcr.io/hoarder-app/hoarder-web: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.

  • 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

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

The services

This stack is built from 5 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • hoarder-web runs ghcr.io/hoarder-app/hoarder-web:latest
  • hoarder-redis runs redis:7.2-alpine
  • hoarder-chrome runs gcr.io/zenika-hub/alpine-chrome:123
  • hoarder-meilisearch runs getmeili/meilisearch:v1.6
  • hoarder-workers runs ghcr.io/hoarder-app/hoarder-workers:latest, starts after hoarder-web

Ports

A port is the door the app answers on. A mapping like 3088:3000 means it's reachable on port 3088 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:3088 in a browser. It opens:

  • 3088:3000, likely the web interface

Volumes

A volume is where Hoarder 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/hoarder/data on the host
  • /data from /portainer/Files/AppData/Config/hoarder/redis on the host
  • /meili_data from /portainer/Files/AppData/Config/hoarder/meilisearch on the host

Environment variables

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

  • REDIS_HOST, defaults to redis
  • MEILI_ADDR, defaults to http://meilisearch:7700
  • DATA_DIR, defaults to /data
  • HOARDER_VERSION, defaults to latest
  • NEXTAUTH_SECRET, defaults to qxo0NvLCphGhkAu5fBcS1B0MxCeoig8G
  • NEXTAUTH_URL, defaults to http://localhost:3088
  • MEILI_MASTER_KEY, defaults to aqxYm5UWCphGhkAu5fBcSJAPbSzeoiC2X
  • MEILI_NO_ANALYTICS, defaults to true
  • BROWSER_WEB_URL, defaults to http://chrome:9222

Restart policy

The restart policy here is unless-stopped, so Docker restarts Hoarder 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).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like hoarder-web) while only the ports above are open to you.

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 Hoarder up. Add the template list to Portainer once, then deploying Hoarder is a click rather than a wall of config.