message pusher
v0.4.12
Crie seu próprio serviço de envio de mensagens, suporte a vários métodos de envio de mensagens, suporte a Markdown, apenas um único arquivo executável, pronto para uso imediato
Download do programa·Tutorial de implantação·Tutorial de uso·Feedback·Demonstração on-line
Nota : O site oficial de implantação https://msgpusher.com já está online e o registro está aberto. Se receber feedback positivo, considere mudar para um servidor com latência mais baixa no futuro.
Aviso : A atualização da
v0.3parav0.4requer migração manual do banco de dados.
Implantação: 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
Se não puder ser extraído, substitua justsong/message-pusher por ghcr.io/songquanpeng/message-pusher .
Atualização: docker run --rm -v /var/run/docker.sock:/var/run/docker.sock containrrr/watchtower -cR
O número da porta aberta é 3000. Em seguida, use o Nginx para configurar o nome de domínio, geração reversa e certificado SSL. Consulte o tutorial de implantação detalhado para obter detalhes.
Os dados serão salvos no diretório /home/ubuntu/data/message-pusher da máquina host (há apenas um arquivo de banco de dados SQLite). Certifique-se de que o diretório exista e tenha permissão de gravação ou altere-o para um diretório adequado). .
Configuração de referência do 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;
}
}
Em seguida, use o certbot do Let's Encrypt para configurar o 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 e a senha é 123456 .Se o serviço precisar ser executado por um longo período, simplesmente iniciá-lo não será suficiente.
Se você precisar usar a função push do cliente WebSocket, proxy_read_timeout e proxy_send_timeout no arquivo de configuração Nginx deverão ser definidos para mais de 1 minuto.
Configurações recomendadas:
proxy_read_timeout 300s;
proxy_send_timeout 300s;
O próprio sistema só precisa baixar um arquivo executável para começar a utilizá-lo, sem outras dependências.
Você pode configurá-lo definindo variáveis de ambiente ou parâmetros de linha de comando.
Após a inicialização do sistema, use o usuário root para efetuar login no sistema e fazer outras configurações. A senha padrão é 123456 .
REDIS_CONN_STRING : Após a configuração, o Redis será usado como armazenamento para limite de frequência de solicitação em vez de usar armazenamento de memória.REDIS_CONN_STRING=redis://default:redispw@localhost:49153SESSION_SECRET : Após a configuração, será utilizada uma chave de sessão fixa, para que o cookie do usuário logado ainda seja válido após a reinicialização do sistema.SESSION_SECRET=random_stringSQL_DSN : Após a configuração, o banco de dados especificado será usado no lugar do SQLite.SQL_DSN=root:123456@tcp(localhost:3306)/message-pusher Observação: ao implantar com Docker, use -e key=value para definir variáveis de ambiente.
Exemplo: docker run -e SESSION_SECRET=random_string ...
--port <port_number> : Especifique o número da porta que o servidor escuta, o padrão é 3000 .--port 3000--log-dir <log_dir> : Especifique a pasta de log. Se não for definido, o log não será salvo.--log-dir ./logs--version : Imprime o número da versão do sistema e sai.允许新用户注册.更新用户信息para alterar o nome de usuário e a senha padrão.绑定邮箱地址para vincular o e-mail e ativar o envio de mensagens de e-mail.默认推送方式. O padrão é push via email.推送token para autenticação de chamada de API push. Deixe em branco se não for necessário.测试correspondente para testar se a configuração foi bem-sucedida.https://<domain>/push/<username><domain> e <username> acima por valores reais, por exemplo: https://push.mydomain.cn/push/adminGET : https://<domain>/push/<username>?title=<标题>&description=<描述>&content=<Markdown 文本>&channel=<推送方式>&token=<推送token>title : Opcional, limitado pelo método push de mensagem específico, pode ser ignorado.description : obrigatório, pode ser substituído por desp .content : opcional, limitado pelo método push de mensagem específico, o suporte à sintaxe Markdown é diferente.channel : opcional, se não for preenchido, o sistema usará o canal push padrão que você definiu em segundo plano. Observe que o nome do canal de mensagem é preenchido aqui, não o tipo. Os tipos de canais push opcionais são:email : Push enviando um email (use o campo title ou description para definir o assunto do email, use content para definir o corpo e ofereça suporte à sintaxe Markdown completa).test : envie através da conta de teste do WeChat (use o campo description para definir o conteúdo da mensagem do modelo, Markdown não é suportado).corp_app : envie por meio da conta do aplicativo WeChat corporativo (somente ao usar o APP WeChat corporativo, se o campo content estiver definido, title e description serão ignorados; é normal ao usar o plug-in WeChat corporativo no WeChat).lark_app : acesse o aplicativo criado por Feishu.corp : enviado por meio do robô do grupo WeChat corporativo (definir o campo content renderizará mensagens Markdown, suportando um subconjunto de Markdown; definir description renderizará mensagens de texto comuns).lark : push via robô Feishuqun (as notas são as mesmas acima).ding : push via robô do grupo DingTalk (as notas são as mesmas acima).bark : empurra Bark (suporta campos title e description ).client : push via cliente WebSocket (suporta campos title e description ).telegram : push via robô Telegram (escolha um dos campos de description ou content , suporta um subconjunto de Markdown).discord : Push through Discord group bot (as notas são as mesmas acima).one_api : envia mensagens para QQ por meio do protocolo OneAPI.group : Push através de um grupo de canais push de mensagem pré-configurado.custom : envie por meio de um canal push personalizado pré-configurado.tencent_alarm : enviado por meio de alarmes de monitoramento da Tencent Cloud, apenas o campo description é compatível.none : salve apenas no banco de dados, não envie por push.token : se você definir um token push em segundo plano, este item será obrigatório. Isso também pode ser definido definindo o cabeçalho Authorization HTTP.url : Opcional, caso não seja preenchido o sistema gerará automaticamente uma URL para a mensagem, e seu conteúdo serão os detalhes da mensagem.to : Opcional, envie para o usuário especificado. Se não for preenchido, ele será enviado para você por padrão. É limitado pelo método push de mensagem específico e alguns métodos push não suportam isso.@all : envia para todos os usuários.user1|user2|user3 : Envie para vários usuários, separados por |async : opcional, se definido como true , o envio da mensagem será executado de forma assíncrona em segundo plano e o resultado retornado contém o campo uuid , que pode ser usado para [Obter status de envio da mensagem] subsequente (./docs/API.md#Get status de envio de mensagem através do UUID da mensagem).render_mode : opcional,code , o corpo da mensagem será automaticamente aninhado no bloco de código para renderização;raw , a análise de Markdown não será executada;markdown , que significa análise de Markdown.POST : os campos são consistentes com o método de solicitação GET acima.Content-Type deverá ser definido como application/json , caso contrário será processado como Form.token no modo de solicitação POST também pode ser definido por meio de parâmetros de consulta de URL.Nível de suporte para vários canais:
| Tipo de canal | title | description | content | url | to | Suporte de redução |
|---|---|---|---|---|---|---|
email | ✅ | ✅ | ✅ | ✅️ | ✅️ | |
test | ✅ | ✅ | ✅ | ✅️ | ✅️ | ✅ |
corp_app | ✅ | ✅ | ✅ | ✅️ | ✅ | ✅ |
corp | ✅ | ✅ | ✅️ | ✅️ | ✅ | |
lark | ✅ | ✅ | ✅ | ✅ | ||
lark_app | ✅ | ✅ | ️ | ✅ | ✅ | |
ding | ✅ | ✅ | ✅ | ✅️ | ✅ | ✅ |
bark | ✅ | ✅ | ✅ | ✅️ | ✅ | |
client | ✅ | ✅ | ||||
telegram | ✅ | ✅ | ✅ | |||
discord | ✅ | ✅ | ||||
tencent_alarm | ✅ |
Perceber:
description e content não podem existir ao mesmo tempo. Se você precisar apenas de mensagens de texto, use description . Se precisar enviar mensagens Markdown, use content .Exemplo:
#! /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 'Outra versão:
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 "
}Então você pode fazer algo assim:
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 ) ;
} )Os PRs podem adicionar exemplos em mais idiomas.
SQLite é usado como exemplo aqui. Modifique outros bancos de dados você mesmo. Pedi ao ChatGPT para traduzi-lo para a versão SQL correspondente, consulte a pasta bin para referência.
v0.3 para a v0.4v0.4 , inicie o programa e o programa migrará automaticamente a estrutura da tabela do banco de dados../bin/migrate_v3_to_v4.py para migrar os dados. Observe que antes da execução, certifique-se de que a ordem dos campos na tabela de users no banco de dados seja consistente com a do script, caso contrário ocorrerá confusão de dados.
v0.3 são baseadas em Node.js. Você pode mudar para nodejs para visualizá-lo.v0.3 e versões subsequentes são desenvolvidas com base no Gin Template v0.2.1 .pattern web/build: no matching files found .
