From 503cff3b53c72f8d8be5729e6e55cc0e69c7451a Mon Sep 17 00:00:00 2001 From: milimoe Date: Tue, 10 Nov 2026 01:58:24 +0800 Subject: [PATCH] build: add publish-linux.bat for Ubuntu framework-dependent deployment package --- .gitignore | 3 + OshimaBot/README.md | 22 +++++ publish-linux.bat | 191 ++++++++++++++++++++++++++++++++++++++++++++ 3 files changed, 216 insertions(+) create mode 100644 publish-linux.bat diff --git a/.gitignore b/.gitignore index 359afa2..2b96218 100644 --- a/.gitignore +++ b/.gitignore @@ -28,3 +28,6 @@ rounds_archive.zip *.db-wal *.db-shm TestResults/ + +# Ubuntu 部署包产物(publish-linux.bat 生æˆ�) +/publish/ diff --git a/OshimaBot/README.md b/OshimaBot/README.md index ff4c3f9..7b2357f 100644 --- a/OshimaBot/README.md +++ b/OshimaBot/README.md @@ -39,6 +39,28 @@ dotnet tool install dotnet-ef --version 10.0.11 --tool-path .tools ./.tools/dotnet-ef.exe database update --project OshimaBot/OshimaBot.csproj ``` +## Linux 部署包(Ubuntu x64) + +在**仓库根目录**è¿�行 `publish-linux.bat`,一键生æˆ�框架ä¾�赖版(`--self-contained false`,**ä¸�å�« .NET runtime**): + +| 产物 | 说明 | +|---|---| +| `publish\linux-x64-fd\` | å�¯ç›´æŽ¥ä¸Šä¼ çš„部署目录,å�« `OshimaBot.dll`ã€�ä¾�赖库ã€�`appsettings*.json` 与英文 `DEPLOY.txt` | +| `publish\OshimaBot-linux-x64-fd.zip` | å�Œå†…容压缩包,解压å�³ç”¨ | + +脚本会先清ç�†æ—§äº§ç‰©ã€�校验仓库外的 `FunGame.Core` 引用,先å°�试 `--no-restore` å�‘布ã€�失败å†�回退到带还原的å�‘布;完æˆ�å�Ž**剔除本机 `*.db*` / `*.pfx` / `appsettings.*.local.json` / `rounds_archive.zip`**,ç»�ä¸�把本地存档或凭æ�®å¸¦è¿›éƒ¨ç½²åŒ…。`publish/` 已被 gitignore。 + +目标机(Ubuntu 22.04 / 24.04 x64)需预装 **.NET 10 ASP.NET Core Runtime**,然å�Žï¼š + +```bash +sudo unzip -o OshimaBot-linux-x64-fd.zip -d /opt/oshimobot +cd /opt/oshimobot +dotnet OshimaBot.dll --urls http://127.0.0.1:5090 +curl http://127.0.0.1:5090/health +``` + +凭æ�®ç”¨çŽ¯å¢ƒå�˜é‡�(`QQBot__Enabled` / `QQBot__AppId` / `QQBot__Secret` / `Server__ApiKey`)注入,ä¸�è¦�写进 `appsettings.json`ï¼›SQLite æ•°æ�®åº“首次å�¯åŠ¨è‡ªåŠ¨åˆ›å»ºå¹¶è¿�移。systemd unit 模æ�¿ã€�备份与å��å�‘代ç�†è¯´æ˜Žè§�包内 `DEPLOY.txt`。 + ## é…�ç½® **ä¸�è¦�把真实凭æ�®æ��交进仓库**,用 `dotnet user-secrets` 或环境å�˜é‡�: diff --git a/publish-linux.bat b/publish-linux.bat new file mode 100644 index 0000000..826fd41 --- /dev/null +++ b/publish-linux.bat @@ -0,0 +1,191 @@ +@echo off +:: ============================================================ +:: Éú³É OshimaBot µÄ Ubuntu linux-x64 ¿ò¼ÜÒÀÀµ²¿Êð°ü (fd) +:: +:: Ó÷¨£ºÔÚ²Ö¿â¸ùĿ¼ִÐÐ publish-linux.bat£¨Ë«»÷Òà¿É£© +:: +:: ²úÎï½á¹¹£º +:: publish\linux-x64-fd\ ¿ÉÖ±½ÓÉÏ´«µÄ²¿ÊðĿ¼ +:: OshimaBot.dll + È«²¿ÒÀÀµ dll + appsettings*.json +:: DEPLOY.txt Ó¢ÎIJ¿Êð˵Ã÷£º»·¾³±äÁ¿ / systemd / ±¸·Ý +:: publish\OshimaBot-linux-x64-fd.zip ͬÄÚÈÝѹËõ°ü +:: +:: Ä¿±ê»ú£¨Ubuntu 22.04 / 24.04 x64£©Ðè×ÔÐа²×° .NET 10 ASP.NET Core Runtime£¬ +:: ±¾°ü²»º¬ .NET runtime£¬Ò²²»º¬±¾»ú SQLite Êý¾Ý¿âÓëÈÎºÎÆ¾¾Ý£º +:: dotnet OshimaBot.dll --urls http://127.0.0.1:5090 +:: +:: ×¢Ò⣺±¾½Å±¾Óà goto ±êÇ©×ö´íÎó´¦Àí£¨cmd ½âÎö´ø×ªÒåÀ¨ºÅµÄ¶àÐÐ +:: if/else ·ÖÖ§¿é»áʧЧ£¬Á½·ÖÖ§¶¼Ö´ÐУ©£¬²»Òª¸Ä³É¶àÐÐ if/else¡£ +:: ============================================================ +setlocal +chcp 936 >nul 2>nul +cd /d "%~dp0" + +set "OUT=publish\linux-x64-fd" +set "ZIP=publish\OshimaBot-linux-x64-fd.zip" +set "DEPLOY=%OUT%\DEPLOY.txt" + +echo ==^> 1/6 ¼ì²é¹¹½¨»·¾³ +where dotnet >nul 2>nul +if errorlevel 1 goto err_no_dotnet +if not exist "OshimaBot\OshimaBot.csproj" goto err_no_project +if not exist "..\..\FunGame\FunGame.Core\src\FunGame.Core.csproj" goto err_no_core +dotnet --version + +echo ==^> 2/6 ÇåÀí¾É·¢²¼²úÎï +if exist "%OUT%" rmdir /s /q "%OUT%" +if exist "%ZIP%" del /f /q "%ZIP%" +if not exist publish mkdir publish + +echo ==^> 3/6 ·¢²¼ linux-x64 ¿ò¼ÜÒÀÀµ°æ --self-contained false +dotnet publish OshimaBot\OshimaBot.csproj -c Release -r linux-x64 --self-contained false -o "%OUT%" --no-restore +if not errorlevel 1 goto step4 +echo --no-restore ʧ°Ü£¬ÇåÀí°ë³ÉÆ·ºó»ØÍ˵½´ø»¹Ô­µÄ·¢²¼ +if exist "%OUT%" rmdir /s /q "%OUT%" +dotnet publish OshimaBot\OshimaBot.csproj -c Release -r linux-x64 --self-contained false -o "%OUT%" +if errorlevel 1 goto err_publish + +:step4 +echo ==^> 4/6 УÑé²úÎï¡¢ÌÞ³ý±¾»úÊý¾Ý²¢Ð´È벿Êð˵Ã÷ +if not exist "%OUT%\OshimaBot.dll" goto err_missing +if not exist "%OUT%\appsettings.json" goto err_missing +:: ±¾»úÊý¾Ý¿âº¬Õ˺š¢ApiKey ¹þÏ£ÓëÍæ·¨Êý¾Ý£¬¾ø²»Ëæ°ü·¢²¼£»Ä¿±ê»úÊ×´ÎÆô¶¯×Ô¶¯½¨¿â +del /f /q "%OUT%\*.db*" >nul 2>nul +del /f /q "%OUT%\appsettings.*.local.json" >nul 2>nul +del /f /q "%OUT%\*.pfx" >nul 2>nul +del /f /q "%OUT%\rounds_archive.zip" >nul 2>nul + +>"%DEPLOY%" echo OshimaBot - Ubuntu linux-x64 deployment package +>>"%DEPLOY%" echo ============================================================ +>>"%DEPLOY%" echo Framework-dependent build. The .NET runtime is NOT included. +>>"%DEPLOY%" echo This package contains no local database and no credentials. +>>"%DEPLOY%" echo. +>>"%DEPLOY%" echo Prerequisites on the target host +>>"%DEPLOY%" echo Ubuntu 22.04 or 24.04, x64 +>>"%DEPLOY%" echo .NET 10 ASP.NET Core Runtime already installed +>>"%DEPLOY%" echo A writable directory for the SQLite database +>>"%DEPLOY%" echo. +>>"%DEPLOY%" echo 1. Extract +>>"%DEPLOY%" echo sudo mkdir -p /opt/oshimobot +>>"%DEPLOY%" echo sudo unzip -o OshimaBot-linux-x64-fd.zip -d /opt/oshimobot +>>"%DEPLOY%" echo cd /opt/oshimobot +>>"%DEPLOY%" echo. +>>"%DEPLOY%" echo 2. Configure secrets with environment variables or an +>>"%DEPLOY%" echo appsettings.Production.json override file. +>>"%DEPLOY%" echo Never put real credentials into appsettings.json. +>>"%DEPLOY%" echo ASPNETCORE_ENVIRONMENT=Production +>>"%DEPLOY%" echo QQBot__Enabled=true +>>"%DEPLOY%" echo QQBot__Mode=WebSocket +>>"%DEPLOY%" echo QQBot__Environment=Production +>>"%DEPLOY%" echo QQBot__AppId=YOUR_APP_ID +>>"%DEPLOY%" echo QQBot__Secret=YOUR_BOT_SECRET +>>"%DEPLOY%" echo Server__ApiKey=YOUR_THIRD_PARTY_KEY +>>"%DEPLOY%" echo Database__ConnectionString=Data Source=oshimobot.db +>>"%DEPLOY%" echo. +>>"%DEPLOY%" echo Notes +>>"%DEPLOY%" echo - QQBot__Environment selects the official or sandbox API domain. +>>"%DEPLOY%" echo - GatewayUrl left blank uses GET /gateway/bot auto discovery. +>>"%DEPLOY%" echo - Server__ApiKey is a one-time bootstrap key. After the first +>>"%DEPLOY%" echo start remove the plain value; auth then reads api_keys only. +>>"%DEPLOY%" echo - Webhook is disabled by default. POST /QQBot returns 404. +>>"%DEPLOY%" echo. +>>"%DEPLOY%" echo 3. Start manually +>>"%DEPLOY%" echo dotnet OshimaBot.dll --urls http://127.0.0.1:5090 +>>"%DEPLOY%" echo curl http://127.0.0.1:5090/health +>>"%DEPLOY%" echo. +>>"%DEPLOY%" echo 4. systemd unit at /etc/systemd/system/oshimobot.service +>>"%DEPLOY%" echo [Unit] +>>"%DEPLOY%" echo Description=OshimaBot QQ MUD +>>"%DEPLOY%" echo After=network.target +>>"%DEPLOY%" echo [Service] +>>"%DEPLOY%" echo Type=simple +>>"%DEPLOY%" echo WorkingDirectory=/opt/oshimobot +>>"%DEPLOY%" echo ExecStart=/usr/bin/dotnet /opt/oshimobot/OshimaBot.dll --urls http://127.0.0.1:5090 +>>"%DEPLOY%" echo Environment=ASPNETCORE_ENVIRONMENT=Production +>>"%DEPLOY%" echo Environment=QQBot__Enabled=true +>>"%DEPLOY%" echo Environment=QQBot__AppId=YOUR_APP_ID +>>"%DEPLOY%" echo Environment=QQBot__Secret=YOUR_BOT_SECRET +>>"%DEPLOY%" echo Restart=always +>>"%DEPLOY%" echo RestartSec=5 +>>"%DEPLOY%" echo [Install] +>>"%DEPLOY%" echo WantedBy=multi-user.target +>>"%DEPLOY%" echo. +>>"%DEPLOY%" echo sudo systemctl daemon-reload +>>"%DEPLOY%" echo sudo systemctl enable --now oshimobot +>>"%DEPLOY%" echo sudo journalctl -u oshimobot -f +>>"%DEPLOY%" echo. +>>"%DEPLOY%" echo 5. Data +>>"%DEPLOY%" echo The database is created and migrated on first start. Relative +>>"%DEPLOY%" echo paths in Database__ConnectionString resolve against +>>"%DEPLOY%" echo WorkingDirectory. Stop the service before backup, then copy +>>"%DEPLOY%" echo oshimobot.db, oshimobot.db-wal and oshimobot.db-shm together, +>>"%DEPLOY%" echo or use VACUUM INTO for a consistent snapshot. +>>"%DEPLOY%" echo Simulation statistics and logs live in simulation_statistics +>>"%DEPLOY%" echo and simulation_runs. No JSON save files are needed. +>>"%DEPLOY%" echo. +>>"%DEPLOY%" echo 6. Optional reverse proxy +>>"%DEPLOY%" echo nginx proxy_pass to http://127.0.0.1:5090 +>>"%DEPLOY%" echo GET /health is the readiness endpoint. +if not exist "%DEPLOY%" goto err_copy + +echo ==^> 5/6 ´ò°ü zip +if not exist "%SystemRoot%\System32\tar.exe" goto no_tar +pushd "%OUT%" +"%SystemRoot%\System32\tar.exe" -a -cf "..\OshimaBot-linux-x64-fd.zip" * +if errorlevel 1 goto err_zip_in +popd +goto step6 + +:err_zip_in +popd +goto err_zip + +:no_tar +echo δÕÒµ½ÏµÍ³ tar.exe£¬Ìø¹ýѹËõ°ü£¬½ö±£ÁôĿ¼²úÎï + +:step6 +echo ==^> 6/6 Íê³É +echo. +echo ²¿ÊðĿ¼ : %CD%\%OUT% +if exist "%ZIP%" echo ѹËõ°ü : %CD%\%ZIP% +echo. +echo Ä¿±ê»úÐèԤװ .NET 10 ASP.NET Core Runtime£¬ÉÏ´«½âѹºóÖ´ÐУº +echo dotnet OshimaBot.dll --urls http://127.0.0.1:5090 +echo curl http://127.0.0.1:5090/health +echo. +echo ƾ¾ÝÓû·¾³±äÁ¿×¢È루QQBot__AppId / QQBot__Secret / Server__ApiKey µÈ£©£¬ +echo ²»ÒªÐ´½ø appsettings.json£»Êý¾Ý¿âÊ×´ÎÆô¶¯×Ô¶¯´´½¨¡£Ïê¼û°üÄÚ DEPLOY.txt¡£ +echo. +goto :eof + +:err_no_dotnet +echo [´íÎó] δÕÒµ½ dotnet£¬ÇëÏȰ²×° .NET 10 SDK +exit /b 1 + +:err_no_project +echo [´íÎó] ÇëÔÚ²Ö¿â¸ùĿ¼ÔËÐб¾½Å±¾£¨ÕÒ²»µ½ OshimaBot\OshimaBot.csproj£© +exit /b 1 + +:err_no_core +echo [´íÎó] ÕÒ²»µ½²Ö¿âÍâµÄ FunGame.Core.csproj +echo OshimaBot.slnx Ïà¶ÔÒýÓà ..\..\FunGame\FunGame.Core\src\FunGame.Core.csproj +echo »»»úÆ÷±àÒëʱÐèÏ顄 FunGame.Core ·Åµ½¶ÔӦλÖ㬻ò¸Ä³É×ÓÄ£¿é / °üÒýÓà +exit /b 1 + +:err_publish +echo [´íÎó] dotnet publish ʧ°Ü +exit /b 1 + +:err_missing +echo [´íÎó] ·¢²¼²úÎïȱÉÙ OshimaBot.dll »ò appsettings.json +exit /b 1 + +:err_copy +echo [´íÎó] дÈë DEPLOY.txt ʧ°Ü +exit /b 1 + +:err_zip +echo [´íÎó] ´ò°ü zip ʧ°Ü£¬publish\linux-x64-fd Ŀ¼²úÎïÈÔ¿ÉʹÓà +exit /b 1 + +endlocal