server README

The project's README from github.com/gotify/server. As one markdown file: README.md.

gotify/server

Build Status codecov Matrix Docker Pulls latest release

Intro

We wanted a simple server for sending and receiving messages (in real time per WebSocket). 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

Gotify UI screenshot

Get it on Google Play Get it on F-Droid

(Google Play and the Google Play logo are trademarks of Google LLC.)


Documentation

Install ᛫ Configuration ᛫ REST-API ᛫ Setup Dev Environment

Contributing

We welcome all kinds of contribution, including bug reports, feature requests, documentation improvements, UI refinements, etc. Check out CONTRIBUTING.md for guidelines.

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

server (gotify/server)

notifications
Searching Database…

16.1K ·GitHub
What is this?Gotify is a simple self-hosted server for sending and receiving messages in real time over WebSocket, with a sleek web UI included.
So where does it run — is this a cloud service or something I host myself?You host it yourself: the README names self-hosting as a core requirement, and the web UI, CLI and Android app all connect to your own instance.
How do I get it running?Start with the Install guide linked in the Documentation section of the README; Configuration, a REST-API reference and a Setup Dev Environment page sit next to it.
Why build this instead of using an existing push service?When it was created, there were few open-source options for this and most existing ones were abandoned; the author wanted a simple, self-hostable alternative to the free and commercial push services.
Is there a mobile app for receiving the notifications?Yes — a companion Android app (gotify/android) is available through Google Play and F-Droid.
How is it licensed?MIT — free to run, modify and self-host, including for commercial use.
What is the gotify/cli for?It is a command-line helper for sending messages to your gotify server, so scripts can push notifications without hand-crafting REST requests.
Can I write my own client?Yes — anything that can call the REST API can send messages, and anything that speaks WebSocket can receive them; the REST-API docs linked from the README describe the interface.
Does everything stay on my own infrastructure?That is the design goal: the server is meant to be self-hosted, so your messages and accounts live where you deploy it instead of at a third-party push service.
What are similar projects?appwrite, novu, chat, awesome-selfhosted, hivepaas, ntfy, boop, gatus
Creator
gotify
Size
5 MB
Stars
16.1K
Age
8y
Commits · 90 Days