server

GitHub

A simple server for sending and receiving messages in real-time per WebSocket. (Includes a sleek web-ui)

AI Prompts & Endpoints
Agent Skills View CodeWiki Knowledge Base

Repository: gotify/server


Stars: 14876

README.md

<p align="center">
<a href="https://github.com/gotify/logo">
<img height="275px" src="https://raw.githubusercontent.com/gotify/logo/master/gotify-logo.png" />
</a>
</p>

<h1 align="center">gotify/server</h1>

<p align="center">
<a href="https://github.com/gotify/server/actions/workflows/build.yml">
<img alt="Build Status" src="https://github.com/gotify/server/actions/workflows/build.yml/badge.svg">
</a>
<a href="https://codecov.io/gh/gotify/server">
<img alt="codecov" src="https://codecov.io/gh/gotify/server/branch/master/graph/badge.svg">
</a>
<a href="https://goreportcard.com/report/github.com/gotify/server">
<img alt="Go Report Card" src="https://goreportcard.com/badge/github.com/gotify/server">
</a>
<a href="https://matrix.to/#/#gotify:matrix.org">
<img alt="Matrix" src="https://img.shields.io/matrix/gotify:matrix.org.svg">
</a>
<a href="https://hub.docker.com/r/gotify/server">
<img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/gotify/server.svg">
</a>
<a href="https://github.com/gotify/server/releases/latest">
<img alt="latest release" src="https://img.shields.io/github/release/gotify/server.svg">
</a>
</p>

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

<img alt="Gotify UI screenshot" src="ui.png" align="right" width="500px"/>

* send messages via REST-API
* receive messages via WebSocket
* manage users, clients and applications
* Plugins
* Web-UI -> ./ui
* CLI for sending messages -> gotify/cli
* Android-App -> gotify/android

[<img src="https://play.google.com/intl/en_gb/badges/images/generic/en_badge_web_generic.png" alt="Get it on Google Play" width="150" />][playstore]
[<img src="https://f-droid.org/badge/get-it-on.png" alt="Get it on F-Droid" width="150"/>][fdroid]

<sub>(Google Play and the Google Play logo are trademarks of Google LLC.)</sub>

---

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

[playstore]: https://play.google.com/store/apps/details?id=com.github.gotify
[fdroid]: https://f-droid.org/de/packages/com.github.gotify/