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 是一个简单的自托管服务器,可以通过 WebSocket 实时收发消息,并自带一个美观的网页界面。
那它运行在哪里——是云服务,还是我自己架设的?需要你自己架设:README 把自托管列为核心要求,网页界面、命令行工具和 Android 应用都是连接到你自己的实例。
我该怎么把它跑起来?先看 README 的 Documentation 部分链接的 Install 安装指南;Configuration、REST-API 参考文档和 Setup Dev Environment 页面就在它旁边。
为什么不直接用现成的推送服务,而要自己做一个?项目创建时,这方面的开源选择很少,而且大多已经无人维护;作者想要一个简单、可自托管的替代方案,来取代那些免费和商业推送服务。
有没有用来接收通知的手机应用?有——配套的 Android 应用(gotify/android)可以在 Google Play 和 F-Droid 上下载。
它采用什么许可证?MIT——可以自由运行、修改和自托管,包括商业用途。
gotify/cli 是用来做什么的?它是一个命令行小工具,用于向你的 gotify 服务器发送消息,这样脚本就能推送通知,而不用手动构造 REST 请求。
我可以自己写一个客户端吗?可以——任何能调用 REST API 的程序都能发送消息,任何支持 WebSocket 的程序都能接收消息;README 里链接的 REST-API 文档描述了这套接口。
所有数据都留在我自己的服务器上吗?这正是它的设计目标:这个服务器就是为自托管而设计的,所以你的消息和账户都保存在你部署它的地方,而不是存放在第三方推送服务上。
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