PPAgent 文档

Appearance

关于公网和域名 ​

有公网域名和IP时 ​

有众多数据源都需要有公网支持（如微信公众号、企业微信等），甚至是域名支持，因此建议申请域名后，绑定到当前设备，然后通过nginx进行映射绑定，以下是一个nginx配置示例：

nginx
upstream ppagent {
        server your-local-ip:5050;
}


server {
        listen 443 ssl;
        listen 80;
        http2 on;
        server_name your-domain;
        ssl_certificate /xxxx/fullchain.pem;
        ssl_certificate_key /xxxx/privkey.pem;

        ssl_session_timeout 1d;
        ssl_session_cache shared:MozSSL:10m; # about 40000 sessions
        ssl_session_tickets off;

        ssl_protocols TLSv1.2 TLSv1.3;
        ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384;
        ssl_prefer_server_ciphers on;

        location / {
                proxy_pass http://ppagent;
                proxy_read_timeout 300s;
                proxy_send_timeout 300s;
                proxy_set_header Host $host;
                proxy_set_header X-Forwarded-For $remote_addr;
                proxy_http_version 1.1;
                proxy_set_header Upgrade $http_upgrade;
                proxy_set_header Connection "upgrade";
                proxy_set_header Accept-Encoding gzip;
                proxy_cache_bypass $http_upgrade;
        }

}

没有公网IP时 ​

框架内置了ngrok客户端，您需要前往 https://dashboard.ngrok.com/signup注册并获取token，填入.env文件中的PUBLIC_TUNNEL_TOKEN中，程序启动后会自动申请一个临时的外网可访问的域名。

如果希望使用ngrok控制台中已经申请永久使用的域名，可以设置PUBLIC_TUNNEL_NAME字段，如设置为 your-custom-prefix.ngrok-free.app。

如果出现连接问题，可以尝试手动访问一次生成的域名。如果仍有问题，还可以尝试重启docker服务。