a simple self-hosted server for sending and receiving messages

自建消息服務(wù)。

跨平臺，Dockerable，簡單，開源，免費，自建。

服務(wù)端、客戶端、應(yīng)用 都有。

Intro

This is the documentation of gotify/server. Lets start with some definitions:

約定如下

A client is a device or application that can manage clients, messages and applications. However a client is not allowed to send messages.

用戶：代管理用戶、消息、應(yīng)用的設(shè)備或應(yīng)用。用戶不能發(fā)送消息。

An application is a device or application that only can send messages.

應(yīng)用：僅能發(fā)送消息的設(shè)備或者應(yīng)用。

Users are only able to manage (view/edit/delete) clients and applications (includes messages sent by the app) that they've created.

用戶：僅管理（查、改、刪）已創(chuàng)建的用戶和應(yīng)用（包括app發(fā)送的消息）

A message has the following attributes: content, title, creation date, application id and priority.

消息包含如下字段：內(nèi)容，標(biāo)題，創(chuàng)建日期，應(yīng)用ID，優(yōu)先級。

An application can be added via

• WebUI: click the?apps-tab in the upper right corner when logged in and add an application

• REST-API:?curl -u admin:admin https://yourdomain.com/application -F "name=test" -F "description=tutorial"?See?API-Docs

可以通過WebUI或REST-API注冊應(yīng)用。

To authenticate as an application you need the application token. The token is returned in the REST request and is viewable in the WebUI.

與服務(wù)器通信通過應(yīng)用程序令牌身份驗證。REST請求返回程序令牌，可在WebUI查看。

Message Extras

Extras are used to carry extra information, change how clients behave, etc. Extras are stored in a key-value scheme and are only accepted in?POST /message?requests with?application/json?content-type.

消息擴展

用于改變用戶響應(yīng)等。以鍵值對方式存儲。僅響應(yīng)requests?with?application/json content-type的POST方法。

reverse proxy

可用反向代理。

Nginx/Apache/Caddy2/Haproxy

Database

Dialect?????????Connection

sqlite3????????? ?path/to/database.db

mysql????????????gotify:secret@/gotifydb?charset=utf8&parseTime=True&loc=Local

postgres????? ? host=localhost port=3306 user=gotify dbname=gotify password=secret

When using postgres without SSL then?sslmode=disable?must be added to the connection string. See?#90.

For?mysql?and?postgres: Make sure the defined database exists and the user has sufficient permissions.