Portainer Templates logo

Portainer Templates

Trilium Trilium

Container

Productivity

Trilium Notes is a hierarchical note taking application with focus on building large personal knowledge bases

Image details

Pulls: 13.8M
Architecture: amd64, arm64, arm/v7, arm/v6
Image size: 190 MB
Latest: 0.63-latest
User: zadam
Created: Jun 10, 2018
Updated: 2 years ago
Status: active

Source details

Repo: zadam/trilium
Stars: 37.4k
Forks: 3k
Language: TypeScript
License: AGPL-3.0
Latest: v0.104.1 · 21 days ago
Updated: 4 hours ago
Website: triliumnotes.org/

Configuration

Type
Container
Platform
linux
Image
zadam/trilium:latest
Ports
3388:8080/tcp
Volumes
/home/node/trilium-data : /portainer/Files/AppData/Config/trilium-data
Env vars
TRILIUM_DATA_DIR=/home/node/trilium-dataPORT=''
Restart
unless-stopped

Template by xneo1

Standalone Install

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

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 Trilium, fill in any config options, and hit Deploy

Template Import URL

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

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

See https://github.com/zadam/trilium for details.

Serve Trilium 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 trilium.example.com to http://trilium:8080

Add this to your Caddyfile

trilium.example.com {
	reverse_proxy http://trilium: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 trilium
  • 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:3388 failed: port is already allocated", something else on your server is using that port.

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

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/trilium-data

Image won't pull

Test the pull directly on the host: docker pull zadam/trilium: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, arm/v6
  • 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 trilium --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Required settings are blank

PORT has no default value, and trilium may crash or misbehave if left empty.

  • Fill it in on the deploy screen before hitting deploy.

Raise an issue

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

A single container

Trilium runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.

The app image

An image is the app packed up ready to go, everything Trilium needs bundled into one download. This template pulls zadam/trilium:latest, which Docker fetches once (about 190 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. Trilium's comes from Docker Hub, published by zadam.

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. Newest right now is 0.63-latest. 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, arm/v6, 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 3388:8080 means it's reachable on port 3388 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:3388 in a browser. It opens:

  • 3388:8080, likely the web interface

Volumes

A volume is where Trilium 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:

  • /home/node/trilium-data from /portainer/Files/AppData/Config/trilium-data on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Trilium takes 2 of them, and one needs a value before it'll start properly:

  • TRILIUM_DATA_DIR, defaults to /home/node/trilium-data
  • PORT, needs a value

Restart policy

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

Nothing custom is set, so Trilium 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 trilium. That's what you'll spot in the containers list and use in commands like docker logs trilium.

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

Trilium is open source, released under the AGPL-3.0 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 Trilium up. Add the template list to Portainer once, then deploying Trilium is a click rather than a wall of config.