├── Dockerfile ├── package.json ├── .github └── workflows │ └── build-docker-image.yml ├── README.md ├── index.js └── LICENSE /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM node:alpine3.20 2 | 3 | WORKDIR /tmp 4 | 5 | COPY . . 6 | 7 | EXPOSE 3000/tcp 8 | 9 | RUN apk update && apk upgrade &&\ 10 | apk add --no-cache openssl curl gcompat iproute2 coreutils &&\ 11 | apk add --no-cache bash &&\ 12 | chmod +x index.js &&\ 13 | npm install 14 | 15 | CMD ["node", "index.js"] 16 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "nodejs-argo", 3 | "version": "1,0,0", 4 | "description": "Thsi is a node project", 5 | "main": "index.js", 6 | "author": "eooce", 7 | "repository": "", 8 | "license": "MIT", 9 | "private": false, 10 | "scripts": { 11 | "dev": "node index.js", 12 | "start": "node index.js" 13 | }, 14 | "dependencies": { 15 | "axios": "latest", 16 | "express": "^4.18.2" 17 | }, 18 | "engines": { 19 | "node": ">=14" 20 | } 21 | } 22 | -------------------------------------------------------------------------------- /.github/workflows/build-docker-image.yml: -------------------------------------------------------------------------------- 1 | name: Build and Push Docker Image 2 | 3 | on: 4 | push: 5 | branches: [ main ] 6 | paths: 7 | - 'Dockerfile' 8 | - 'index.js' 9 | - 'package.json' 10 | pull_request: 11 | branches: [ main ] 12 | workflow_dispatch: 13 | 14 | jobs: 15 | build: 16 | runs-on: ubuntu-latest 17 | permissions: 18 | contents: read 19 | packages: write 20 | 21 | steps: 22 | - name: Checkout repository 23 | uses: actions/checkout@v4 24 | 25 | - name: Log in to GitHub Container Registry 26 | uses: docker/login-action@v3 27 | with: 28 | registry: ghcr.io 29 | username: ${{ github.actor }} 30 | password: ${{ secrets.GITHUB_TOKEN }} 31 | 32 | - name: Set up Docker Buildx 33 | uses: docker/setup-buildx-action@v3 34 | 35 | - name: Build and push Docker image 36 | uses: docker/build-push-action@v5 37 | with: 38 | context: . 39 | push: true 40 | platforms: linux/amd64,linux/arm64 41 | tags: | 42 | ghcr.io/${{ github.repository_owner }}/nodejs:latest 43 | labels: | 44 | org.opencontainers.image.source=https://github.com/${{ github.repository }} 45 | org.opencontainers.image.description=HTTP Server 46 | org.opencontainers.image.licenses=MIT 47 | cache-from: type=gha 48 | cache-to: type=gha,mode=max 49 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |
2 | 3 | # nodejs-argo隧道代理 4 | 5 | [![npm version](https://img.shields.io/npm/v/nodejs-argo.svg)](https://www.npmjs.com/package/nodejs-argo) 6 | [![npm downloads](https://img.shields.io/npm/dm/nodejs-argo.svg)](https://www.npmjs.com/package/nodejs-argo) 7 | [![License](https://img.shields.io/npm/l/nodejs-argo.svg)](https://github.com/eooce/nodejs-argo/blob/main/LICENSE) 8 | 9 | nodejs-argo是一个强大的Argo隧道部署工具，专为PaaS平台和游戏玩具平台设计。它支持多种代理协议（VLESS、VMess、Trojan等），并集成了哪吒探针功能。 10 | 11 | --- 12 | 13 | Telegram交流反馈群组：https://t.me/eooceu 14 |
15 | 16 | ## 郑重声明 17 | * 本项目自2025年10月29日15时45分起,已更改开源协议为GPL 3.0,并包含以下特定要求 18 | * 此项目仅限个人使用，禁止用于商业行为(包括但不限于：youtube,bilibili,tiktok,facebook..等等) 19 | * 禁止新建项目将代码复制到自己仓库中用做商业行为 20 | * 请遵守当地法律法规,禁止滥用做公共代理行为 21 | * 如有违反以上条款者将追究法律责任 22 | 23 | ## 说明 （部署前请仔细阅读） 24 | 25 | * 本项目是针对node环境的paas平台和游戏玩具而生，采用Argo隧道部署节点，集成哪吒探针v0或v1可选。 26 | * node玩具平台只需上传index.js和package.json即可，paas平台需要docker部署的才上传Dockerfile。 27 | * 不填写ARGO_DOMAIN和ARGO_AUTH两个变量即启用临时隧道，反之则使用固定隧道。 28 | * 哪吒v0/v1可选,当哪吒端口为{443,8443,2096,2087,2083,2053}其中之一时，自动开启tls。 29 | 30 | ## 📋 环境变量 31 | 32 | | 变量名 | 是否必须 | 默认值 | 说明 | 33 | |--------|----------|--------|------| 34 | | UPLOAD_URL | 否 | - | 订阅上传地址 | 35 | | PROJECT_URL | 否 | https://www.google.com | 项目分配的域名 | 36 | | AUTO_ACCESS | 否 | false | 是否开启自动访问保活 | 37 | | PORT | 否 | 3000 | HTTP服务监听端口 | 38 | | ARGO_PORT | 否 | 8001 | Argo隧道端口 | 39 | | UUID | 否 | 89c13786-25aa-4520-b2e7-12cd60fb5202 | 用户UUID | 40 | | NEZHA_SERVER | 否 | - | 哪吒面板域名 | 41 | | NEZHA_PORT | 否 | - | 哪吒端口 | 42 | | NEZHA_KEY | 否 | - | 哪吒密钥 | 43 | | ARGO_DOMAIN | 否 | - | Argo固定隧道域名 | 44 | | ARGO_AUTH | 否 | - | Argo固定隧道密钥 | 45 | | CFIP | 否 | www.visa.com.tw | 节点优选域名或IP | 46 | | CFPORT | 否 | 443 | 节点端口 | 47 | | NAME | 否 | Vls | 节点名称前缀 | 48 | | FILE_PATH | 否 | ./tmp | 运行目录 | 49 | | SUB_PATH | 否 | sub | 订阅路径 | 50 | 51 | ## 🌐 订阅地址 52 | 53 | - 标准端口：`https://your-domain.com/sub` 54 | - 非标端口：`http://your-domain.com:port/sub` 55 | 56 | --- 57 | 58 | ## 🚀 进阶使用 59 | 60 | ### 安装 61 | 62 | ```bash 63 | # 全局安装（推荐） 64 | npm install -g nodejs-argo 65 | 66 | # 或者使用yarn 67 | yarn global add nodejs-argo 68 | 69 | # 或者使用pnpm 70 | pnpm add -g nodejs-argo 71 | ``` 72 | 73 | ### 基本使用 74 | 75 | ```bash 76 | # 直接运行（使用默认配置） 77 | nodejs-argo 78 | 79 | # 使用npx运行 80 | npx nodejs-argo 81 | 82 | # 设置环境变量运行 83 | PORT=3000 npx nodejs-argo 84 | ``` 85 | 86 | ### 环境变量配置 87 | 88 | 可使用 `.env` 文件来配置环境变量运行 89 | 90 | 91 | 或者直接在命令行中设置： 92 | 93 | ```bash 94 | export UPLOAD_URL="https://your-merge-sub-domain.com" 95 | export PROJECT_URL="https://your-project-domain.com" 96 | export PORT=3000 97 | export UUID="your-uuid-here" 98 | export NEZHA_SERVER="nz.your-domain.com:8008" 99 | export NEZHA_KEY="your-nezha-key" 100 | ``` 101 | 102 | ## 📦 作为npm模块使用 103 | 104 | ```javascript 105 | // CommonJS 106 | const nodejsArgo = require('nodejs-argo'); 107 | 108 | // ES6 Modules 109 | import nodejsArgo from 'nodejs-argo'; 110 | 111 | // 启动服务 112 | nodejsArgo.start(); 113 | ``` 114 | 115 | ## 🔧 后台运行 116 | 117 | ### 使用screen（推荐） 118 | ```bash 119 | # 创建screen会话 120 | screen -S argo 121 | 122 | # 运行应用 123 | nodejs-argo 124 | 125 | # 按 Ctrl+A 然后按 D 分离会话 126 | # 重新连接：screen -r argo 127 | ``` 128 | 129 | ### 使用tmux 130 | ```bash 131 | # 创建tmux会话 132 | tmux new-session -d -s argo 133 | 134 | # 运行应用 135 | tmux send-keys -t argo "nodejs-argo" Enter 136 | 137 | # 分离会话：tmux detach -s argo 138 | # 重新连接：tmux attach -t argo 139 | ``` 140 | 141 | ### 使用PM2 142 | ```bash 143 | # 安装PM2 144 | npm install -g pm2 145 | 146 | # 启动应用 147 | pm2 start nodejs-argo --name "argo-service" 148 | 149 | # 管理应用 150 | pm2 status 151 | pm2 logs argo-service 152 | pm2 restart argo-service 153 | ``` 154 | 155 | ### 使用systemd（Linux系统服务） 156 | ```bash 157 | # 创建服务文件 158 | sudo nano /etc/systemd/system/nodejs-argo.service 159 | 160 | ``` 161 | [Unit] 162 | Description=Node.js Argo Service 163 | After=network.target 164 | 165 | [Service] 166 | Type=simple 167 | User=root 168 | WorkingDirectory=/root/test 169 | Environment=ARGO_PORT=8080 170 | Environment=PORT=3000 171 | ExecStart=/usr/bin/npx nodejs-argo 172 | Restart=always 173 | RestartSec=10 174 | 175 | [Install] 176 | WantedBy=multi-user.target 177 | ``` 178 | 179 | # 启动服务 180 | sudo systemctl start nodejs-argo 181 | sudo systemctl enable nodejs-argo 182 | ``` 183 | 184 | ## 🔄 更新 185 | 186 | ```bash 187 | # 更新全局安装的包 188 | npm update -g nodejs-argo 189 | 190 | # 或者重新安装 191 | npm uninstall -g nodejs-argo 192 | npm install -g nodejs-argo 193 | ``` 194 | 195 | ## 📚 更多信息 196 | 197 | - [GitHub仓库](https://github.com/eooce/nodejs-argo) 198 | - [npm包页面](https://www.npmjs.com/package/nodejs-argo) 199 | - [问题反馈](https://github.com/eooce/nodejs-argo/issues) 200 | 201 | --- 202 | 203 | ## 赞助 204 | * 感谢[VPS.Town](https://vps.town)提供赞助 https://vps.town 205 | 206 | * 感谢[ZMTO](https://zmto.com/?affid=1548)提供赞助优质双isp vps。 207 | 208 | ## 许可证 209 | GPL 3.0 210 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | const express = require("express"); 2 | const app = express(); 3 | const axios = require("axios"); 4 | const os = require('os'); 5 | const fs = require("fs"); 6 | const path = require("path"); 7 | const { promisify } = require('util'); 8 | const exec = promisify(require('child_process').exec); 9 | const { execSync } = require('child_process'); // 只填写UPLOAD_URL将上传节点,同时填写UPLOAD_URL和PROJECT_URL将上传订阅 10 | const UPLOAD_URL = process.env.UPLOAD_URL || ''; // 节点或订阅自动上传地址,需填写部署Merge-sub项目后的首页地址,例如：https://merge.xxx.com 11 | const PROJECT_URL = process.env.PROJECT_URL || ''; // 需要上传订阅或保活时需填写项目分配的url,例如：https://google.com 12 | const AUTO_ACCESS = process.env.AUTO_ACCESS || false; // false关闭自动保活，true开启,需同时填写PROJECT_URL变量 13 | const FILE_PATH = process.env.FILE_PATH || './tmp'; // 运行目录,sub节点文件保存目录 14 | const SUB_PATH = process.env.SUB_PATH || 'sub'; // 订阅路径 15 | const PORT = process.env.SERVER_PORT || process.env.PORT || 3000; // http服务订阅端口 16 | const UUID = process.env.UUID || '9afd1229-b893-40c1-84dd-51e7ce204913'; // 使用哪吒v1,在不同的平台运行需修改UUID,否则会覆盖 17 | const NEZHA_SERVER = process.env.NEZHA_SERVER || ''; // 哪吒v1填写形式: nz.abc.com:8008 哪吒v0填写形式：nz.abc.com 18 | const NEZHA_PORT = process.env.NEZHA_PORT || ''; // 使用哪吒v1请留空，哪吒v0需填写 19 | const NEZHA_KEY = process.env.NEZHA_KEY || ''; // 哪吒v1的NZ_CLIENT_SECRET或哪吒v0的agent密钥 20 | const ARGO_DOMAIN = process.env.ARGO_DOMAIN || ''; // 固定隧道域名,留空即启用临时隧道 21 | const ARGO_AUTH = process.env.ARGO_AUTH || ''; // 固定隧道密钥json或token,留空即启用临时隧道,json获取地址：https://json.zone.id 22 | const ARGO_PORT = process.env.ARGO_PORT || 8001; // 固定隧道端口,使用token需在cloudflare后台设置和这里一致 23 | const CFIP = process.env.CFIP || 'cdns.doon.eu.org'; // 节点优选域名或优选ip 24 | const CFPORT = process.env.CFPORT || 443; // 节点优选域名或优选ip对应的端口 25 | const NAME = process.env.NAME || ''; // 节点名称 26 | 27 | // 创建运行文件夹 28 | if (!fs.existsSync(FILE_PATH)) { 29 | fs.mkdirSync(FILE_PATH); 30 | console.log(`${FILE_PATH} is created`); 31 | } else { 32 | console.log(`${FILE_PATH} already exists`); 33 | } 34 | 35 | // 生成随机6位字符文件名 36 | function generateRandomName() { 37 | const characters = 'abcdefghijklmnopqrstuvwxyz'; 38 | let result = ''; 39 | for (let i = 0; i < 6; i++) { 40 | result += characters.charAt(Math.floor(Math.random() * characters.length)); 41 | } 42 | return result; 43 | } 44 | 45 | // 全局常量 46 | const npmName = generateRandomName(); 47 | const webName = generateRandomName(); 48 | const botName = generateRandomName(); 49 | const phpName = generateRandomName(); 50 | let npmPath = path.join(FILE_PATH, npmName); 51 | let phpPath = path.join(FILE_PATH, phpName); 52 | let webPath = path.join(FILE_PATH, webName); 53 | let botPath = path.join(FILE_PATH, botName); 54 | let subPath = path.join(FILE_PATH, 'sub.txt'); 55 | let listPath = path.join(FILE_PATH, 'list.txt'); 56 | let bootLogPath = path.join(FILE_PATH, 'boot.log'); 57 | let configPath = path.join(FILE_PATH, 'config.json'); 58 | 59 | // 如果订阅器上存在历史运行节点则先删除 60 | function deleteNodes() { 61 | try { 62 | if (!UPLOAD_URL) return; 63 | if (!fs.existsSync(subPath)) return; 64 | 65 | let fileContent; 66 | try { 67 | fileContent = fs.readFileSync(subPath, 'utf-8'); 68 | } catch { 69 | return null; 70 | } 71 | 72 | const decoded = Buffer.from(fileContent, 'base64').toString('utf-8'); 73 | const nodes = decoded.split('\n').filter(line => 74 | /(vless|vmess|trojan|hysteria2|tuic):\/\//.test(line) 75 | ); 76 | 77 | if (nodes.length === 0) return; 78 | 79 | axios.post(`${UPLOAD_URL}/api/delete-nodes`, 80 | JSON.stringify({ nodes }), 81 | { headers: { 'Content-Type': 'application/json' } } 82 | ).catch((error) => { 83 | return null; 84 | }); 85 | return null; 86 | } catch (err) { 87 | return null; 88 | } 89 | } 90 | 91 | // 清理历史文件 92 | function cleanupOldFiles() { 93 | try { 94 | const files = fs.readdirSync(FILE_PATH); 95 | files.forEach(file => { 96 | const filePath = path.join(FILE_PATH, file); 97 | try { 98 | const stat = fs.statSync(filePath); 99 | if (stat.isFile()) { 100 | fs.unlinkSync(filePath); 101 | } 102 | } catch (err) { 103 | // 忽略所有错误，不记录日志 104 | } 105 | }); 106 | } catch (err) { 107 | // 忽略所有错误，不记录日志 108 | } 109 | } 110 | 111 | // 根路由 112 | app.get("/", function(req, res) { 113 | res.send("Hello world!"); 114 | }); 115 | 116 | // 生成xr-ay配置文件 117 | async function generateConfig() { 118 | const config = { 119 | log: { access: '/dev/null', error: '/dev/null', loglevel: 'none' }, 120 | inbounds: [ 121 | { port: ARGO_PORT, protocol: 'vless', settings: { clients: [{ id: UUID, flow: 'xtls-rprx-vision' }], decryption: 'none', fallbacks: [{ dest: 3001 }, { path: "/vless-argo", dest: 3002 }, { path: "/vmess-argo", dest: 3003 }, { path: "/trojan-argo", dest: 3004 }] }, streamSettings: { network: 'tcp' } }, 122 | { port: 3001, listen: "127.0.0.1", protocol: "vless", settings: { clients: [{ id: UUID }], decryption: "none" }, streamSettings: { network: "tcp", security: "none" } }, 123 | { port: 3002, listen: "127.0.0.1", protocol: "vless", settings: { clients: [{ id: UUID, level: 0 }], decryption: "none" }, streamSettings: { network: "ws", security: "none", wsSettings: { path: "/vless-argo" } }, sniffing: { enabled: true, destOverride: ["http", "tls", "quic"], metadataOnly: false } }, 124 | { port: 3003, listen: "127.0.0.1", protocol: "vmess", settings: { clients: [{ id: UUID, alterId: 0 }] }, streamSettings: { network: "ws", wsSettings: { path: "/vmess-argo" } }, sniffing: { enabled: true, destOverride: ["http", "tls", "quic"], metadataOnly: false } }, 125 | { port: 3004, listen: "127.0.0.1", protocol: "trojan", settings: { clients: [{ password: UUID }] }, streamSettings: { network: "ws", security: "none", wsSettings: { path: "/trojan-argo" } }, sniffing: { enabled: true, destOverride: ["http", "tls", "quic"], metadataOnly: false } }, 126 | ], 127 | dns: { servers: ["https+local://8.8.8.8/dns-query"] }, 128 | outbounds: [ { protocol: "freedom", tag: "direct" }, {protocol: "blackhole", tag: "block"} ] 129 | }; 130 | fs.writeFileSync(path.join(FILE_PATH, 'config.json'), JSON.stringify(config, null, 2)); 131 | } 132 | 133 | // 判断系统架构 134 | function getSystemArchitecture() { 135 | const arch = os.arch(); 136 | if (arch === 'arm' || arch === 'arm64' || arch === 'aarch64') { 137 | return 'arm'; 138 | } else { 139 | return 'amd'; 140 | } 141 | } 142 | 143 | // 下载对应系统架构的依赖文件 144 | function downloadFile(fileName, fileUrl, callback) { 145 | const filePath = fileName; 146 | 147 | // 确保目录存在 148 | if (!fs.existsSync(FILE_PATH)) { 149 | fs.mkdirSync(FILE_PATH, { recursive: true }); 150 | } 151 | 152 | const writer = fs.createWriteStream(filePath); 153 | 154 | axios({ 155 | method: 'get', 156 | url: fileUrl, 157 | responseType: 'stream', 158 | }) 159 | .then(response => { 160 | response.data.pipe(writer); 161 | 162 | writer.on('finish', () => { 163 | writer.close(); 164 | console.log(`Download ${path.basename(filePath)} successfully`); 165 | callback(null, filePath); 166 | }); 167 | 168 | writer.on('error', err => { 169 | fs.unlink(filePath, () => { }); 170 | const errorMessage = `Download ${path.basename(filePath)} failed: ${err.message}`; 171 | console.error(errorMessage); // 下载失败时输出错误消息 172 | callback(errorMessage); 173 | }); 174 | }) 175 | .catch(err => { 176 | const errorMessage = `Download ${path.basename(filePath)} failed: ${err.message}`; 177 | console.error(errorMessage); // 下载失败时输出错误消息 178 | callback(errorMessage); 179 | }); 180 | } 181 | 182 | // 下载并运行依赖文件 183 | async function downloadFilesAndRun() { 184 | 185 | const architecture = getSystemArchitecture(); 186 | const filesToDownload = getFilesForArchitecture(architecture); 187 | 188 | if (filesToDownload.length === 0) { 189 | console.log(`Can't find a file for the current architecture`); 190 | return; 191 | } 192 | 193 | const downloadPromises = filesToDownload.map(fileInfo => { 194 | return new Promise((resolve, reject) => { 195 | downloadFile(fileInfo.fileName, fileInfo.fileUrl, (err, filePath) => { 196 | if (err) { 197 | reject(err); 198 | } else { 199 | resolve(filePath); 200 | } 201 | }); 202 | }); 203 | }); 204 | 205 | try { 206 | await Promise.all(downloadPromises); 207 | } catch (err) { 208 | console.error('Error downloading files:', err); 209 | return; 210 | } 211 | // 授权和运行 212 | function authorizeFiles(filePaths) { 213 | const newPermissions = 0o775; 214 | filePaths.forEach(absoluteFilePath => { 215 | if (fs.existsSync(absoluteFilePath)) { 216 | fs.chmod(absoluteFilePath, newPermissions, (err) => { 217 | if (err) { 218 | console.error(`Empowerment failed for ${absoluteFilePath}: ${err}`); 219 | } else { 220 | console.log(`Empowerment success for ${absoluteFilePath}: ${newPermissions.toString(8)}`); 221 | } 222 | }); 223 | } 224 | }); 225 | } 226 | const filesToAuthorize = NEZHA_PORT ? [npmPath, webPath, botPath] : [phpPath, webPath, botPath]; 227 | authorizeFiles(filesToAuthorize); 228 | 229 | //运行ne-zha 230 | if (NEZHA_SERVER && NEZHA_KEY) { 231 | if (!NEZHA_PORT) { 232 | // 检测哪吒是否开启TLS 233 | const port = NEZHA_SERVER.includes(':') ? NEZHA_SERVER.split(':').pop() : ''; 234 | const tlsPorts = new Set(['443', '8443', '2096', '2087', '2083', '2053']); 235 | const nezhatls = tlsPorts.has(port) ? 'true' : 'false'; 236 | // 生成 config.yaml 237 | const configYaml = ` 238 | client_secret: ${NEZHA_KEY} 239 | debug: false 240 | disable_auto_update: true 241 | disable_command_execute: false 242 | disable_force_update: true 243 | disable_nat: false 244 | disable_send_query: false 245 | gpu: false 246 | insecure_tls: true 247 | ip_report_period: 1800 248 | report_delay: 4 249 | server: ${NEZHA_SERVER} 250 | skip_connection_count: true 251 | skip_procs_count: true 252 | temperature: false 253 | tls: ${nezhatls} 254 | use_gitee_to_upgrade: false 255 | use_ipv6_country_code: false 256 | uuid: ${UUID}`; 257 | 258 | fs.writeFileSync(path.join(FILE_PATH, 'config.yaml'), configYaml); 259 | 260 | // 运行 v1 261 | const command = `nohup ${phpPath} -c "${FILE_PATH}/config.yaml" >/dev/null 2>&1 &`; 262 | try { 263 | await exec(command); 264 | console.log(`${phpName} is running`); 265 | await new Promise((resolve) => setTimeout(resolve, 1000)); 266 | } catch (error) { 267 | console.error(`php running error: ${error}`); 268 | } 269 | } else { 270 | let NEZHA_TLS = ''; 271 | const tlsPorts = ['443', '8443', '2096', '2087', '2083', '2053']; 272 | if (tlsPorts.includes(NEZHA_PORT)) { 273 | NEZHA_TLS = '--tls'; 274 | } 275 | const command = `nohup ${npmPath} -s ${NEZHA_SERVER}:${NEZHA_PORT} -p ${NEZHA_KEY} ${NEZHA_TLS} --disable-auto-update --report-delay 4 --skip-conn --skip-procs >/dev/null 2>&1 &`; 276 | try { 277 | await exec(command); 278 | console.log(`${npmName} is running`); 279 | await new Promise((resolve) => setTimeout(resolve, 1000)); 280 | } catch (error) { 281 | console.error(`npm running error: ${error}`); 282 | } 283 | } 284 | } else { 285 | console.log('NEZHA variable is empty,skip running'); 286 | } 287 | //运行xr-ay 288 | const command1 = `nohup ${webPath} -c ${FILE_PATH}/config.json >/dev/null 2>&1 &`; 289 | try { 290 | await exec(command1); 291 | console.log(`${webName} is running`); 292 | await new Promise((resolve) => setTimeout(resolve, 1000)); 293 | } catch (error) { 294 | console.error(`web running error: ${error}`); 295 | } 296 | 297 | // 运行cloud-fared 298 | if (fs.existsSync(botPath)) { 299 | let args; 300 | 301 | if (ARGO_AUTH.match(/^[A-Z0-9a-z=]{120,250}$/)) { 302 | args = `tunnel --edge-ip-version auto --no-autoupdate --protocol http2 run --token ${ARGO_AUTH}`; 303 | } else if (ARGO_AUTH.match(/TunnelSecret/)) { 304 | args = `tunnel --edge-ip-version auto --config ${FILE_PATH}/tunnel.yml run`; 305 | } else { 306 | args = `tunnel --edge-ip-version auto --no-autoupdate --protocol http2 --logfile ${FILE_PATH}/boot.log --loglevel info --url http://localhost:${ARGO_PORT}`; 307 | } 308 | 309 | try { 310 | await exec(`nohup ${botPath} ${args} >/dev/null 2>&1 &`); 311 | console.log(`${botName} is running`); 312 | await new Promise((resolve) => setTimeout(resolve, 2000)); 313 | } catch (error) { 314 | console.error(`Error executing command: ${error}`); 315 | } 316 | } 317 | await new Promise((resolve) => setTimeout(resolve, 5000)); 318 | 319 | } 320 | 321 | //根据系统架构返回对应的url 322 | function getFilesForArchitecture(architecture) { 323 | let baseFiles; 324 | if (architecture === 'arm') { 325 | baseFiles = [ 326 | { fileName: webPath, fileUrl: "https://arm64.ssss.nyc.mn/web" }, 327 | { fileName: botPath, fileUrl: "https://arm64.ssss.nyc.mn/bot" } 328 | ]; 329 | } else { 330 | baseFiles = [ 331 | { fileName: webPath, fileUrl: "https://amd64.ssss.nyc.mn/web" }, 332 | { fileName: botPath, fileUrl: "https://amd64.ssss.nyc.mn/bot" } 333 | ]; 334 | } 335 | 336 | if (NEZHA_SERVER && NEZHA_KEY) { 337 | if (NEZHA_PORT) { 338 | const npmUrl = architecture === 'arm' 339 | ? "https://arm64.ssss.nyc.mn/agent" 340 | : "https://amd64.ssss.nyc.mn/agent"; 341 | baseFiles.unshift({ 342 | fileName: npmPath, 343 | fileUrl: npmUrl 344 | }); 345 | } else { 346 | const phpUrl = architecture === 'arm' 347 | ? "https://arm64.ssss.nyc.mn/v1" 348 | : "https://amd64.ssss.nyc.mn/v1"; 349 | baseFiles.unshift({ 350 | fileName: phpPath, 351 | fileUrl: phpUrl 352 | }); 353 | } 354 | } 355 | 356 | return baseFiles; 357 | } 358 | 359 | // 获取固定隧道json 360 | function argoType() { 361 | if (!ARGO_AUTH || !ARGO_DOMAIN) { 362 | console.log("ARGO_DOMAIN or ARGO_AUTH variable is empty, use quick tunnels"); 363 | return; 364 | } 365 | 366 | if (ARGO_AUTH.includes('TunnelSecret')) { 367 | fs.writeFileSync(path.join(FILE_PATH, 'tunnel.json'), ARGO_AUTH); 368 | const tunnelYaml = ` 369 | tunnel: ${ARGO_AUTH.split('"')[11]} 370 | credentials-file: ${path.join(FILE_PATH, 'tunnel.json')} 371 | protocol: http2 372 | 373 | ingress: 374 | - hostname: ${ARGO_DOMAIN} 375 | service: http://localhost:${ARGO_PORT} 376 | originRequest: 377 | noTLSVerify: true 378 | - service: http_status:404 379 | `; 380 | fs.writeFileSync(path.join(FILE_PATH, 'tunnel.yml'), tunnelYaml); 381 | } else { 382 | console.log("ARGO_AUTH mismatch TunnelSecret,use token connect to tunnel"); 383 | } 384 | } 385 | 386 | // 获取临时隧道domain 387 | async function extractDomains() { 388 | let argoDomain; 389 | 390 | if (ARGO_AUTH && ARGO_DOMAIN) { 391 | argoDomain = ARGO_DOMAIN; 392 | console.log('ARGO_DOMAIN:', argoDomain); 393 | await generateLinks(argoDomain); 394 | } else { 395 | try { 396 | const fileContent = fs.readFileSync(path.join(FILE_PATH, 'boot.log'), 'utf-8'); 397 | const lines = fileContent.split('\n'); 398 | const argoDomains = []; 399 | lines.forEach((line) => { 400 | const domainMatch = line.match(/https?:\/\/([^ ]*trycloudflare\.com)\/?/); 401 | if (domainMatch) { 402 | const domain = domainMatch[1]; 403 | argoDomains.push(domain); 404 | } 405 | }); 406 | 407 | if (argoDomains.length > 0) { 408 | argoDomain = argoDomains[0]; 409 | console.log('ArgoDomain:', argoDomain); 410 | await generateLinks(argoDomain); 411 | } else { 412 | console.log('ArgoDomain not found, re-running bot to obtain ArgoDomain'); 413 | // 删除 boot.log 文件，等待 2s 重新运行 server 以获取 ArgoDomain 414 | fs.unlinkSync(path.join(FILE_PATH, 'boot.log')); 415 | async function killBotProcess() { 416 | try { 417 | if (process.platform === 'win32') { 418 | await exec(`taskkill /f /im ${botName}.exe > nul 2>&1`); 419 | } else { 420 | await exec(`pkill -f "[${botName.charAt(0)}]${botName.substring(1)}" > /dev/null 2>&1`); 421 | } 422 | } catch (error) { 423 | // 忽略输出 424 | } 425 | } 426 | killBotProcess(); 427 | await new Promise((resolve) => setTimeout(resolve, 3000)); 428 | const args = `tunnel --edge-ip-version auto --no-autoupdate --protocol http2 --logfile ${FILE_PATH}/boot.log --loglevel info --url http://localhost:${ARGO_PORT}`; 429 | try { 430 | await exec(`nohup ${botPath} ${args} >/dev/null 2>&1 &`); 431 | console.log(`${botName} is running`); 432 | await new Promise((resolve) => setTimeout(resolve, 3000)); 433 | await extractDomains(); // 重新提取域名 434 | } catch (error) { 435 | console.error(`Error executing command: ${error}`); 436 | } 437 | } 438 | } catch (error) { 439 | console.error('Error reading boot.log:', error); 440 | } 441 | } 442 | 443 | // 获取isp信息 444 | async function getMetaInfo() { 445 | try { 446 | const response1 = await axios.get('https://ipapi.co/json/', { timeout: 3000 }); 447 | if (response1.data && response1.data.country_code && response1.data.org) { 448 | return `${response1.data.country_code}_${response1.data.org}`; 449 | } 450 | } catch (error) { 451 | try { 452 | // 备用 ip-api.com 获取isp 453 | const response2 = await axios.get('http://ip-api.com/json/', { timeout: 3000 }); 454 | if (response2.data && response2.data.status === 'success' && response2.data.countryCode && response2.data.org) { 455 | return `${response2.data.countryCode}_${response2.data.org}`; 456 | } 457 | } catch (error) { 458 | // console.error('Backup API also failed'); 459 | } 460 | } 461 | return 'Unknown'; 462 | } 463 | // 生成 list 和 sub 信息 464 | async function generateLinks(argoDomain) { 465 | const ISP = await getMetaInfo(); 466 | const nodeName = NAME ? `${NAME}-${ISP}` : ISP; 467 | return new Promise((resolve) => { 468 | setTimeout(() => { 469 | const VMESS = { v: '2', ps: `${nodeName}`, add: CFIP, port: CFPORT, id: UUID, aid: '0', scy: 'none', net: 'ws', type: 'none', host: argoDomain, path: '/vmess-argo?ed=2560', tls: 'tls', sni: argoDomain, alpn: '', fp: 'firefox'}; 470 | const subTxt = ` 471 | vless://${UUID}@${CFIP}:${CFPORT}?encryption=none&security=tls&sni=${argoDomain}&fp=firefox&type=ws&host=${argoDomain}&path=%2Fvless-argo%3Fed%3D2560#${nodeName} 472 | 473 | vmess://${Buffer.from(JSON.stringify(VMESS)).toString('base64')} 474 | 475 | trojan://${UUID}@${CFIP}:${CFPORT}?security=tls&sni=${argoDomain}&fp=firefox&type=ws&host=${argoDomain}&path=%2Ftrojan-argo%3Fed%3D2560#${nodeName} 476 | `; 477 | // 打印 sub.txt 内容到控制台 478 | console.log(Buffer.from(subTxt).toString('base64')); 479 | fs.writeFileSync(subPath, Buffer.from(subTxt).toString('base64')); 480 | console.log(`${FILE_PATH}/sub.txt saved successfully`); 481 | uploadNodes(); 482 | // 将内容进行 base64 编码并写入 SUB_PATH 路由 483 | app.get(`/${SUB_PATH}`, (req, res) => { 484 | const encodedContent = Buffer.from(subTxt).toString('base64'); 485 | res.set('Content-Type', 'text/plain; charset=utf-8'); 486 | res.send(encodedContent); 487 | }); 488 | resolve(subTxt); 489 | }, 2000); 490 | }); 491 | } 492 | } 493 | 494 | // 自动上传节点或订阅 495 | async function uploadNodes() { 496 | if (UPLOAD_URL && PROJECT_URL) { 497 | const subscriptionUrl = `${PROJECT_URL}/${SUB_PATH}`; 498 | const jsonData = { 499 | subscription: [subscriptionUrl] 500 | }; 501 | try { 502 | const response = await axios.post(`${UPLOAD_URL}/api/add-subscriptions`, jsonData, { 503 | headers: { 504 | 'Content-Type': 'application/json' 505 | } 506 | }); 507 | 508 | if (response && response.status === 200) { 509 | console.log('Subscription uploaded successfully'); 510 | return response; 511 | } else { 512 | return null; 513 | // console.log('Unknown response status'); 514 | } 515 | } catch (error) { 516 | if (error.response) { 517 | if (error.response.status === 400) { 518 | // console.error('Subscription already exists'); 519 | } 520 | } 521 | } 522 | } else if (UPLOAD_URL) { 523 | if (!fs.existsSync(listPath)) return; 524 | const content = fs.readFileSync(listPath, 'utf-8'); 525 | const nodes = content.split('\n').filter(line => /(vless|vmess|trojan|hysteria2|tuic):\/\//.test(line)); 526 | 527 | if (nodes.length === 0) return; 528 | 529 | const jsonData = JSON.stringify({ nodes }); 530 | 531 | try { 532 | const response = await axios.post(`${UPLOAD_URL}/api/add-nodes`, jsonData, { 533 | headers: { 'Content-Type': 'application/json' } 534 | }); 535 | if (response && response.status === 200) { 536 | console.log('Nodes uploaded successfully'); 537 | return response; 538 | } else { 539 | return null; 540 | } 541 | } catch (error) { 542 | return null; 543 | } 544 | } else { 545 | // console.log('Skipping upload nodes'); 546 | return; 547 | } 548 | } 549 | 550 | // 90s后删除相关文件 551 | function cleanFiles() { 552 | setTimeout(() => { 553 | const filesToDelete = [bootLogPath, configPath, webPath, botPath]; 554 | 555 | if (NEZHA_PORT) { 556 | filesToDelete.push(npmPath); 557 | } else if (NEZHA_SERVER && NEZHA_KEY) { 558 | filesToDelete.push(phpPath); 559 | } 560 | 561 | // Windows系统使用不同的删除命令 562 | if (process.platform === 'win32') { 563 | exec(`del /f /q ${filesToDelete.join(' ')} > nul 2>&1`, (error) => { 564 | console.clear(); 565 | console.log('App is running'); 566 | console.log('Thank you for using this script, enjoy!'); 567 | }); 568 | } else { 569 | exec(`rm -rf ${filesToDelete.join(' ')} >/dev/null 2>&1`, (error) => { 570 | console.clear(); 571 | console.log('App is running'); 572 | console.log('Thank you for using this script, enjoy!'); 573 | }); 574 | } 575 | }, 90000); // 90s 576 | } 577 | cleanFiles(); 578 | 579 | // 自动访问项目URL 580 | async function AddVisitTask() { 581 | if (!AUTO_ACCESS || !PROJECT_URL) { 582 | console.log("Skipping adding automatic access task"); 583 | return; 584 | } 585 | 586 | try { 587 | const response = await axios.post('https://oooo.serv00.net/add-url', { 588 | url: PROJECT_URL 589 | }, { 590 | headers: { 591 | 'Content-Type': 'application/json' 592 | } 593 | }); 594 | // console.log(`${JSON.stringify(response.data)}`); 595 | console.log(`automatic access task added successfully`); 596 | return response; 597 | } catch (error) { 598 | console.error(`Add automatic access task faild: ${error.message}`); 599 | return null; 600 | } 601 | } 602 | 603 | // 主运行逻辑 604 | async function startserver() { 605 | try { 606 | argoType(); 607 | deleteNodes(); 608 | cleanupOldFiles(); 609 | await generateConfig(); 610 | await downloadFilesAndRun(); 611 | await extractDomains(); 612 | await AddVisitTask(); 613 | } catch (error) { 614 | console.error('Error in startserver:', error); 615 | } 616 | } 617 | startserver().catch(error => { 618 | console.error('Unhandled error in startserver:', error); 619 | }); 620 | app.listen(PORT, () => console.log(`http server is running on port:${PORT}!`)); 621 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | --------------------------------------------------------------------------------