message pusher
v0.4.12
Создайте свою собственную службу отправки сообщений, поддержите несколько методов отправки сообщений, поддержите Markdown, только один исполняемый файл, готовый к использованию «из коробки».
Загрузка программы·Руководство по развертыванию·Руководство по использованию·Отзывы·Онлайн-демонстрация
Примечание . Официальный сайт развертывания https://msgpusher.com теперь доступен в Интернете, и в настоящее время открыта регистрация. Добро пожаловать на его использование. Если вы получите положительный отзыв, вы можете рассмотреть возможность перехода на сервер с меньшей задержкой в будущем.
Предупреждение : Обновление с
v0.3доv0.4требует ручной миграции базы данных. Подробности см. в разделе Миграция базы данных.
Развертывание: docker run -d --restart always --name message-pusher -p 3000:3000 -e TZ=Asia/Shanghai -v /home/ubuntu/data/message-pusher:/data justsong/message-pusher
Если его невозможно вытащить, замените justsong/message-pusher на ghcr.io/songquanpeng/message-pusher .
Обновление: docker run --rm -v /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower -cR
Номер открытого порта — 3000. Затем используйте Nginx для настройки имени домена, обратного создания и SSL-сертификата. Подробную информацию см. в подробном руководстве по развертыванию.
Данные будут сохранены в каталоге /home/ubuntu/data/message-pusher хост-компьютера (существует только один файл базы данных SQLite). Убедитесь, что каталог существует и имеет разрешение на запись, или измените его на подходящий каталог. .
Эталонная конфигурация Nginx:
server{
server_name msgpusher.com; # 请根据实际情况修改你的域名
location / {
client_max_body_size 64m;
proxy_http_version 1.1;
proxy_pass http://localhost:3000; # 请根据实际情况修改你的端口
proxy_set_header Host $host;
proxy_set_header X-Forwarded-For $remote_addr;
proxy_cache_bypass $http_upgrade;
proxy_set_header Accept-Encoding gzip;
}
}
Затем используйте сертификат-бот Let's Encrypt для настройки HTTPS:
# Ubuntu 安装 certbot：
sudo snap install --classic certbot
sudo ln -s /snap/bin/certbot /usr/bin/certbot
# 生成证书 & 修改 Nginx 配置
sudo certbot --nginx
# 根据指示进行操作
# 重启 Nginx
sudo service nginx restartgit clone https://github.com/songquanpeng/message-pusher.git
cd message-pusher/web
npm install
npm run build
cd ..
go mod download
go build -ldflags " -s -w " -o message-pusherchmod u+x message-pusher
./message-pusher --port 3000 --log-dir ./logsroot , а пароль — 123456 .Если сервису необходимо работать в течение длительного времени, просто запустить его недостаточно. Подробное руководство по развертыванию.
Если вам нужно использовать функцию push-уведомления клиента WebSocket, proxy_read_timeout и proxy_send_timeout в файле конфигурации Nginx должны быть установлены на значение более 1 минуты.
Рекомендуемые настройки:
proxy_read_timeout 300s;
proxy_send_timeout 300s;
Самой системе достаточно загрузить исполняемый файл, чтобы начать его использовать, без каких-либо других зависимостей.
Вы можете настроить его, установив переменные среды или параметры командной строки.
После запуска системы используйте пользователя root для входа в систему и выполнения дальнейших настроек. Пароль по умолчанию — 123456 .
REDIS_CONN_STRING : после установки Redis будет использоваться в качестве хранилища для ограничения частоты запросов вместо использования памяти.REDIS_CONN_STRING=redis://default:redispw@localhost:49153SESSION_SECRET : после установки будет использоваться фиксированный сеансовый ключ, так что файл cookie вошедшего в систему пользователя останется действительным после перезапуска системы.SESSION_SECRET=random_stringSQL_DSN : после установки указанная база данных будет использоваться вместо SQLite.SQL_DSN=root:123456@tcp(localhost:3306)/message-pusher Примечание. При развертывании с помощью Docker используйте -e key=value для установки переменных среды.
Пример: docker run -e SESSION_SECRET=random_string ...
--port <port_number> : укажите номер порта, который прослушивает сервер, значение по умолчанию — 3000 .--port 3000--log-dir <log_dir> : укажите папку журнала. Если не установлено, журнал не будет сохранен.--log-dir ./logs--version : Распечатать номер версии системы и выйти.允许新用户注册.更新用户信息чтобы изменить имя пользователя и пароль по умолчанию.绑定邮箱地址, чтобы привязать электронную почту и включить отправку сообщений электронной почты.默认推送方式. По умолчанию используется передача по электронной почте.推送token для аутентификации вызовов API. Оставьте это поле пустым, если оно не требуется.测试, чтобы проверить успешность настройки.https://<domain>/push/<username><domain> и <username> реальными значениями, например: https://push.mydomain.cn/push/adminGET : https://<domain>/push/<username>?title=<标题>&description=<描述>&content=<Markdown 文本>&channel=<推送方式>&token=<推送token>title : необязательно, ограничено конкретным методом отправки сообщения, его можно игнорировать.description : обязательно, можно заменить на desp .content : необязательно, ограничено конкретным методом отправки сообщения. Поддержка синтаксиса Markdown отличается.channel : необязательно, если не заполнить, система будет использовать канал push-уведомлений по умолчанию, который вы установили в фоновом режиме. Обратите внимание, что здесь заполняется имя канала сообщений, а не тип. Дополнительные типы push-каналов:email : нажмите, отправив электронное письмо (используйте поле title или description , чтобы задать тему электронного письма, используйте поле content , чтобы задать тело, и поддержите полный синтаксис Markdown).test : введите тестовую учетную запись WeChat (используйте поле description , чтобы установить содержимое шаблонного сообщения, Markdown не поддерживается).corp_app : передать через учетную запись корпоративного приложения WeChat (только при использовании корпоративного приложения WeChat, если поле content установлено, поля title и description будут игнорироваться; это нормально при использовании корпоративного плагина WeChat в WeChat).lark_app : запустить приложение, созданное Фейшу самостоятельно.corp : передается через корпоративного робота группы WeChat (настройка поля content будет отображать сообщения Markdown, поддерживая подмножество Markdown; установка поля description будет отображать обычные текстовые сообщения).lark : нажать через робота Feishuqun (примечания такие же, как выше).ding : нажать через группового робота DingTalk (примечания те же, что и выше).bark : пропустить Bark (поддерживает поля title и description ).client : передача через клиент WebSocket (поддерживает поля title и description ).telegram : отправка через робота Telegram (выберите одно из полей description или content , поддерживается подмножество Markdown).discord : Пройдите через групповой бот Discord (примечания такие же, как выше).one_api : отправка сообщений в QQ через протокол OneAPI.group : передача через предварительно настроенную группу каналов передачи сообщений.custom : передача через заранее настроенный пользовательский канал отправки.tencent_alarm : передается через сигналы мониторинга Tencent Cloud, поддерживается только поле description .none : Только сохранять в базу данных, не отправлять.token : если вы установили токен push-уведомления в фоновом режиме, этот элемент является обязательным. Это также можно установить, установив заголовок HTTP- Authorization .url : необязательно. Если не заполнить, система автоматически сгенерирует URL-адрес сообщения, а его содержимым будут сведения о сообщении.to : Необязательно, отправьте указанному пользователю. Если оно не заполнено, оно будет отправлено вам по умолчанию. Это ограничено конкретным методом отправки сообщения, и некоторые методы отправки не поддерживают это.@all : отправить сообщение всем пользователям.user1|user2|user3 : отправить нескольким пользователям, разделенным |async : необязательно, если установлено значение true , отправка сообщения будет выполняться асинхронно в фоновом режиме, а возвращаемый результат содержит поле uuid , которое можно использовать для последующего [Получить статус отправки сообщения] (./docs/API.md#Get статус отправки сообщения через UUID сообщения).render_mode : необязательно,code , тело сообщения будет автоматически вложено в блок кода для рендеринга;raw , анализ Markdown не будет выполняться;markdown , что означает анализ Markdown.POST : поля соответствуют методу запроса GET , указанному выше.Content-Type заголовка должен быть установлен на application/json , иначе он будет обработан как форма.token в режиме запроса POST также можно установить с помощью параметров запроса URL.Уровень поддержки различных каналов:
| Тип канала | title | description | content | url | to | Поддержка уценки |
|---|---|---|---|---|---|---|
email | ✅ | ✅ | ✅ | ✅️ | ✅️ | |
test | ✅ | ✅ | ✅ | ✅️ | ✅️ | ✅ |
corp_app | ✅ | ✅ | ✅ | ✅️ | ✅ | ✅ |
corp | ✅ | ✅ | ✅️ | ✅️ | ✅ | |
lark | ✅ | ✅ | ✅ | ✅ | ||
lark_app | ✅ | ✅ | ️ | ✅ | ✅ | |
ding | ✅ | ✅ | ✅ | ✅️ | ✅ | ✅ |
bark | ✅ | ✅ | ✅ | ✅️ | ✅ | |
client | ✅ | ✅ | ||||
telegram | ✅ | ✅ | ✅ | |||
discord | ✅ | ✅ | ||||
tencent_alarm | ✅ |
Уведомление:
description и content не могут существовать одновременно. Если вам нужны только текстовые сообщения, используйте поле description . Если вам нужно отправлять сообщения Markdown, используйте поле content .Пример:
#! /bin/bash
MESSAGE_PUSHER_SERVER= " https://msgpusher.com "
MESSAGE_PUSHER_USERNAME= " test "
MESSAGE_PUSHER_TOKEN= " 666 "
function send_message {
# POST Form
curl -s -X POST " $MESSAGE_PUSHER_SERVER /push/ $MESSAGE_PUSHER_USERNAME "
-d " title= $1 &description= $2 &content= $3 &token= $MESSAGE_PUSHER_TOKEN "
> /dev/null
}
function send_message_with_json {
# POST JSON
curl -s -X POST " $MESSAGE_PUSHER_SERVER /push/ $MESSAGE_PUSHER_USERNAME "
-H ' Content-Type: application/json '
-d ' {"title":" ' " $1 " ' ","desp":" ' " $2 " ' ", "content":" ' " $3 " ' ", "token":" ' " $MESSAGE_PUSHER_TOKEN " ' "} '
> /dev/null
}
send_message ' title ' ' description ' ' content 'Другая версия:
MESSAGE_PUSHER_SERVER= " https://msgpusher.com "
MESSAGE_PUSHER_USERNAME= " test "
MESSAGE_PUSHER_TOKEN= " 666 "
MESSAGE_PUSHER_CHANNEL= " lark "
sendmsg () {
if [ -t 0 ] ; then
local param= " $* "
else
local param= $( < /dev/stdin )
fi
curl -s -o /dev/null --get --data-urlencode " content= ${param} " " $MESSAGE_PUSHER_SERVER /push/ $MESSAGE_PUSHER_USERNAME ?channel= $MESSAGE_PUSHER_CHANNEL &token= $MESSAGE_PUSHER_TOKEN "
}Тогда вы можете сделать что-то вроде этого:
uname -ra | sendmsg import requests
SERVER = "https://msgpusher.com"
USERNAME = "test"
TOKEN = "666"
def send_message ( title , description , content ):
# GET 方式
# res = requests.get(f"{SERVER}/push/{USERNAME}?title={title}"
# f"&description={description}&content={content}&token={TOKEN}")
# POST 方式
res = requests . post ( f" { SERVER } /push/ { USERNAME } " , json = {
"title" : title ,
"description" : description ,
"content" : content ,
"token" : TOKEN
})
res = res . json ()
if res [ "success" ]:
return None
else :
return res [ "message" ]
error = send_message ( "标题" , "描述" , "**Markdown 内容**" )
if error :
print ( error ) package main
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"net/http"
"net/url"
)
var serverAddress = "https://msgpusher.com"
var username = "test"
var token = "666"
type request struct {
Title string `json:"title"`
Description string `json:"description"`
Content string `json:"content"`
URL string `json:"url"`
Channel string `json:"channel"`
Token string `json:"token"`
}
type response struct {
Success bool `json:"success"`
Message string `json:"message"`
}
func SendMessage ( title string , description string , content string ) error {
req := request {
Title : title ,
Description : description ,
Content : content ,
Token : token ,
}
data , err := json . Marshal ( req )
if err != nil {
return err
}
resp , err := http . Post ( fmt . Sprintf ( "%s/push/%s" , serverAddress , username ),
"application/json" , bytes . NewBuffer ( data ))
if err != nil {
return err
}
var res response
err = json . NewDecoder ( resp . Body ). Decode ( & res )
if err != nil {
return err
}
if ! res . Success {
return errors . New ( res . Message )
}
return nil
}
func SendMessageWithForm ( title string , description string , content string ) error {
resp , err := http . PostForm ( fmt . Sprintf ( "%s/push/%s" , serverAddress , username ),
url. Values { "title" : { title }, "description" : { description }, "content" : { content }, "token" : { token }})
if err != nil {
return err
}
var res response
err = json . NewDecoder ( resp . Body ). Decode ( & res )
if err != nil {
return err
}
if ! res . Success {
return errors . New ( res . Message )
}
return nil
}
func main () {
//err := SendMessage("标题", "描述", "**Markdown 内容**")
err := SendMessageWithForm ( "标题" , "描述" , "**Markdown 内容**" )
if err != nil {
fmt . Println ( "推送失败：" + err . Error ())
} else {
fmt . Println ( "推送成功！" )
}
} using Newtonsoft . Json ;
using RestSharp ;
namespace Demo
{
public class Program
{
public static void Main ( string [ ] args )
{
//推送消息
var sendMsg = MessagePusherTool . SendMessage ( "标题" , "描述" , "**Markdown 内容**" ) ;
if ( sendMsg . Success )
{
Console . WriteLine ( $ "推送成功！" ) ;
}
else
{
Console . WriteLine ( $ "推送失败： { sendMsg . Message } " ) ;
}
}
}
/// <summary>
/// 消息推送工具
///
/// <para>开源地址：https://github.com/songquanpeng/message-pusher</para>
/// <para>支持：Framework、Net3.1、Net5、Net6</para>
/// <para>引用包：</para>
/// <para>dotnet add package Newtonsoft.Json -v 13.0.2</para>
/// <para>dotnet add package RestSharp -v 108.0.3</para>
/// </summary>
public class MessagePusherTool
{
/// <summary>
/// ServerAddress
/// </summary>
public const string ServerAddress = "https://msgpusher.com" ;
/// <summary>
/// UserName
/// </summary>
public const string UserName = "test" ;
/// <summary>
/// Token
/// </summary>
public const string Token = "666" ;
/// <summary>
/// SendMessage
/// </summary>
/// <param name="title">title</param>
/// <param name="description">description</param>
/// <param name="content">content</param>
public static Response SendMessage ( string title , string description , string content )
{
var requestData = new Request ( )
{
Title = title ,
Description = description ,
Content = content ,
Token = Token ,
} ;
var url = $ " { ServerAddress } " ;
var client = new RestClient ( url ) ;
var request = new RestRequest ( $ "push/ { UserName } " , Method . Post ) ;
request . AddJsonBody ( requestData ) ;
var response = client . Execute ( request ) ;
var responseData = response . Content ;
var responseJson = JsonConvert . DeserializeObject < Response > ( responseData ) ;
return responseJson ;
}
/// <summary>
/// Request
/// </summary>
public class Request
{
/// <summary>
/// Title
/// </summary>
[ JsonProperty ( PropertyName = "title" ) ]
public string Title { get ; set ; }
/// <summary>
/// Description
/// </summary>
[ JsonProperty ( PropertyName = "description" ) ]
public string Description { get ; set ; }
/// <summary>
/// Content
/// </summary>
[ JsonProperty ( PropertyName = "content" ) ]
public string Content { get ; set ; }
/// <summary>
/// URL
/// </summary>
[ JsonProperty ( PropertyName = "url" ) ]
public string URL { get ; set ; }
/// <summary>
/// Channel
/// </summary>
[ JsonProperty ( PropertyName = "channel" ) ]
public string Channel { get ; set ; }
/// <summary>
/// Token
/// </summary>
[ JsonProperty ( PropertyName = "token" ) ]
public string Token { get ; set ; }
}
/// <summary>
/// Response
/// </summary>
public class Response
{
/// <summary>
/// Success
/// </summary>
[ JsonProperty ( PropertyName = "success" ) ]
public bool Success { get ; set ; }
/// <summary>
/// Message
/// </summary>
[ JsonProperty ( PropertyName = "message" ) ]
public string Message { get ; set ; }
}
}
} const axios = require ( 'axios' ) ;
const querystring = require ( 'querystring' ) ;
const MESSAGE_PUSHER_SERVER = 'https://msgpusher.com'
const MESSAGE_PUSHER_USERNAME = 'test'
const MESSAGE_PUSHER_TOKEN = '666'
async function send_message ( title , description , content ) {
try {
const postData = querystring . stringify ( {
title : title ,
desp : description ,
content : content ,
token : MESSAGE_PUSHER_TOKEN ,
} )
const response = await axios . post ( ` ${ MESSAGE_PUSHER_SERVER } /push/ ${ MESSAGE_PUSHER_USERNAME } ` , postData , {
headers : {
'Content-Type' : 'application/x-www-form-urlencoded' ,
} ,
} )
if ( response . data . success ) {
return response . data
}
} catch ( error ) {
if ( error . response ) {
return error . response . data
} else {
throw error
}
}
}
send_message ( '标题' , '描述' , '**Markdown 内容**' )
. then ( ( response ) => {
if ( response . success ) {
console . log ( '推送成功:' , response )
} else {
console . log ( '推送失败:' , response )
}
} , ( error ) => {
console . log ( error . message ) ;
} )ОР могут добавлять примеры на других языках.
В качестве примера здесь используется SQLite. Измените другие базы данных самостоятельно. Я попросил ChatGPT перевести его в соответствующую версию SQL, для справки см. папку bin .
v0.3 на v0.4v0.4 , запустите программу, и программа автоматически перенесет структуру таблицы базы данных../bin/migrate_v3_to_v4.py для переноса данных. Обратите внимание: перед выполнением убедитесь, что порядок полей в таблице users в базе данных соответствует порядку полей в скрипте, иначе произойдет путаница данных.
v0.3 основаны на Node.js. Вы можете переключиться на ветку nodejs чтобы просмотреть ее. В этой версии больше нет функциональных обновлений.v0.3 и последующие версии разработаны на основе Gin Template v0.2.1 .pattern web/build: no matching files found .
