安装指南

安装准备

在部署 HeyAuth 之前，您需要对服务器进行初始化，诸如安装系统推荐Ubuntu,安装Nginx等等程序。

通过安装包启动 HeyAuth

HeyAuth 分为三个版本：松散文件版、单文件版以及Docker版。如果是前两者，使用chmod +x heyauth赋予运行权限之后使用./heyauth即可启动。如果是Docker版本，您需要在服务器安装好Docker相关程序后导入镜像来使用。对于Docker版本我们还在进行研发中，待研发完成后会立即更新文档。

通过源码启动 HeyAuth / 构建 HeyAuth

系统环境

HeyAuth V1 基于 Python 构建。通过源码启动或构建 HeyAuth 之前，您需要确保您的服务器具备以下环境：

• Python 3.8+ (推荐3.12.2）
• python3-pip
• pyinstaller（如需构建）

安装依赖

HeyAuth 的相关依赖保存在安装包中的requirements.txt中。构建好Python虚拟环境之后，使用pip install -r requirements.txt来安装依赖。安装依赖需要良好的网络环境，若您的服务器在中国大陆，推荐使用清华大学或阿里云镜像加速。

启动 HeyAuth

解压源码包，使用python3 main.py即可启动 HeyAuth。

构建 HeyAuth

构建HeyAuth的必要前提是您的Python环境中需要包含Pyinstaller。您亦可对源代码使用Cython一类的编译工具进行编译，注意需要把相关依赖写到main.py中，让Pyinstaller能够正确读取到需要导入的依赖。一般情况下，执行pyinstaller build.spec即可完成构建。

修改Nginx配置

更改Nginx配置文件，使得 HeyAuth 能够正确读取到域名以及客户端信息。演示站使用的Nginx配置如下，您可以稍加修改后使用。其中{YOUR_DOMAIN}需要改成您的域名，{YOUR_PORT}需要改成 HeyAuth 的端口号。

server {
    listen 80;
    listen [::]:80;
    server_name {YOUR_DOMAIN};

    # Redirect all HTTP requests to HTTPS
    return 301 https://$host$request_uri;
}

server {
    listen 443 ssl http2;
    listen [::]:443 ssl http2;
    server_name {YOUR_DOMAIN};

    #CERT-APPLY-CHECK--START
    # 用于SSL证书申请时的文件验证相关配置 -- 请勿删除
    include /www/server/panel/vhost/nginx/well-known/{YOUR_DOMAIN}.conf;
    #CERT-APPLY-CHECK--END

    #SSL-START SSL相关配置，请勿删除或修改下一行带注释的404规则
    #error_page 404/404.html;
    #HTTP_TO_HTTPS_START
    if ($server_port !~ 443){
        rewrite ^(/.*)$ https://$host$1 permanent;
    }
    #HTTP_TO_HTTPS_END
    ssl_certificate /www/server/panel/vhost/cert/{YOUR_DOMAIN}/fullchain.pem;
    ssl_certificate_key /www/server/panel/vhost/cert/{YOUR_DOMAIN}/privkey.pem;
    ssl_protocols TLSv1.1 TLSv1.2 TLSv1.3;
    ssl_ciphers EECDH+CHACHA20:EECDH+CHACHA20-draft:EECDH+AES128:RSA+AES128:EECDH+AES256:RSA+AES256:EECDH+3DES:RSA+3DES:!MD5;
    ssl_prefer_server_ciphers on;
    ssl_session_cache shared:SSL:10m;
    ssl_session_timeout 1d;
    add_header Strict-Transport-Security "max-age=31536000";
    error_page 497  https://$host$request_uri;

    # Proxy pass to localhost:{YOUR_PORT}
    location / {
        proxy_pass http://localhost:{YOUR_PORT};
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_http_version 1.1;
        proxy_set_header Upgrade $http_upgrade;
        proxy_set_header Connection "Upgrade";
    }

    #禁止访问的文件或目录
    location ~ ^/(\.user.ini|\.htaccess|\.git|\.env|\.svn|\.project|LICENSE|README.md|\.py|\.db)
    {
        return 404;
    }

    #一键申请SSL证书验证目录相关设置
    location /.well-known{
        allow all;
    }

    #禁止在证书验证目录放入敏感文件
    if ( $uri ~ "^/\.well-known/.*\.(php|jsp|py|js|css|lua|ts|go|zip|tar\.gz|rar|7z|sql|bak)$" ) {
        return 403;
    }

    #LOG START
    access_log  /www/wwwlogs/{YOUR_DOMAIN}.log;
    error_log  /www/wwwlogs/{YOUR_DOMAIN}.error.log;
    #LOG END
}