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)

Searching Database…

16.1K ·GitHub
Что это такое?Gotify — это простой self-hosted сервер для отправки и получения сообщений в реальном времени через WebSocket, со стильным веб-интерфейсом в комплекте.
А где он работает — это облачный сервис или что-то, что я размещаю сам?Вы размещаете его сами: в README self-hosting назван одним из основных требований, а веб-интерфейс, CLI и Android-приложение подключаются к вашему собственному экземпляру.
Как его запустить?Начните с руководства по установке (Install guide), ссылка на которое есть в разделе Documentation файла README; рядом находятся страницы Configuration, справочник по REST-API и Setup Dev Environment.
Зачем делать такой проект, если уже есть готовые push-сервисы?Когда проект создавался, open-source-решений для этого было мало, а большинство существующих были заброшены; автор хотел получить простую альтернативу с self-hosting'ом вместо бесплатных и коммерческих push-сервисов.
Есть ли мобильное приложение для получения уведомлений?Да — есть приложение для Android (gotify/android), доступное в Google Play и F-Droid.
Под какой лицензией он распространяется?MIT — можно свободно запускать, изменять и размещать у себя, в том числе в коммерческих целях.
Для чего нужен gotify/cli?Это консольная утилита для отправки сообщений на ваш gotify server — благодаря ей скрипты могут присылать уведомления без ручного составления REST-запросов.
Могу ли я написать своего клиента?Да — отправлять сообщения может всё, что умеет вызывать REST API, а получать их — всё, что работает по WebSocket; интерфейс описан в документации по REST-API, на которую ссылается README.
Все ли данные остаются на моей инфраструктуре?В этом и состоит цель проекта: сервер рассчитан на self-hosting, поэтому ваши сообщения и учётные записи лежат там, где вы его развернули, а не у стороннего push-сервиса.
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