Portainer Templates logo

Portainer Templates

Gotify Gotify

Container

OtherTools

A simple server for sending and receiving messages

Image details

Pulls: 1.6M
Architecture: amd64, arm64, arm/v7, 386, riscv64, arm
Image size: 48 MB
Latest: 3.0
User: gotify
Created: Feb 23, 2018
Updated: 28 days ago
Status: active

Configuration

Type
Container
Platform
linux
Image
gotify/server-arm7:latest
Ports
9008:80/tcp
Volumes
/app/data : /portainer/Files/AppData/Config/gotify
Env vars
TZ=America/New_YorkGOTIFY_DEFAULTUSER_NAME=adminGOTIFY_DEFAULTUSER_PASS=admin123
Restart
unless-stopped

Template by novaspirit

Notes

Template created by Pi-Hosted Series
Check our Github page: https://github.com/pi-hosted/pi-hosted

Official Webpage: https://gotify.net/
Official Docker Documentation: https://gotify.net/docs/install


ARM7 Image. Documentation is Available here.

Standalone Install

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

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 Gotify, 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.

gotify/server-arm7

!Build Statusbadge-travistravis !codecovbadge-codecovcodecov !Go Report Cardbadge-go-reportgo-report !Swagger Validbadge-swaggerswagger !FOSSA Statusfossa-badgefossa !Api Docsbadge-api-docsapi-docs !latest release versionbadge-releaserelease

Intro

We wanted a simple server for sending and receiving messages (in real time per web socket). For this, not many open source projects existed and most of the existing ones were abandoned. Also, a requirement was that it can be self-hosted. We know there are many free and commercial push services out there.

Features

  • send messages via REST-API
  • receive messages via web socket
  • manage users, clients and applications
  • API Docs (also available at /docs)
  • Web-UI
  • CLI for sending messages -> gotify/cli
  • Android-App -> gotify/android
Documentation
Install ᛫ Configuration ᛫ REST-API ᛫ Setup Dev Environment

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the MIT License - see the LICENSE file for details
badge-api-docs: https://img.shields.io/badge/api-docs-blue.svg badge-swagger: https://img.shields.io/swagger/valid/2.0/https/raw.githubusercontent.com/gotify/server/master/docs/spec.json.svg badge-go-report: https://goreportcard.com/badge/github.com/gotify/server badge-codecov: https://codecov.io/gh/gotify/server/branch/master/graph/badge.svg badge-travis: https://travis-ci.org/gotify/server.svg?branch=master badge-release: https://img.shields.io/github/release/gotify/server.svg release: https://github.com/gotify/server/releases/latest travis: https://travis-ci.org/gotify/server codecov: https://codecov.io/gh/gotify/server go-report: https://goreportcard.com/report/github.com/gotify/server swagger: https://github.com/gotify/server/blob/master/docs/spec.json api-docs: https://gotify.github.io/api-docs/ docker-normal: https://hub.docker.com/r/gotify/server/ docker-arm7: https://hub.docker.com/r/gotify/server-arm7/ playstore: https://play.google.com/store/apps/details?id=com.github.gotify fdroid: https://f-droid.org/de/packages/com.github.gotify/ fossa: https://app.fossa.io/projects/git%2Bgithub.com%2Fgotify%2Fserver fossa-badge: https://app.fossa.io/api/projects/git%2Bgithub.com%2Fgotify%2Fserver.svg?type=shield

Serve Gotify 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 gotify.example.com to http://gotify:80

Add this to your Caddyfile

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

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

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/gotify

Image won't pull

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

Raise an issue

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

A single container

Gotify 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 Gotify needs bundled into one download. This template pulls gotify/server-arm7: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. Gotify's comes from Docker Hub, published by gotify.

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 3.0. 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, 386, riscv64, arm, 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 9008:80 means it's reachable on port 9008 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:9008 in a browser. It opens:

  • 9008:80, likely the web interface

Volumes

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

  • /app/data from /portainer/Files/AppData/Config/gotify on the host

Environment variables

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

  • TZ, defaults to America/New_York
  • GOTIFY_DEFAULTUSER_NAME, defaults to admin
  • GOTIFY_DEFAULTUSER_PASS, defaults to admin123

Restart policy

The restart policy here is unless-stopped, so Docker restarts Gotify 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 Gotify 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 gotify. That's what you'll spot in the containers list and use in commands like docker logs gotify.

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