├── _worker.js.zip ├── .github └── workflows │ └── zip_flows.yml ├── .gitignore ├── _worker.js ├── README.md └── LICENSE /_worker.js.zip: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/amclubs/am-cf-github2raw/HEAD/_worker.js.zip -------------------------------------------------------------------------------- /.github/workflows/zip_flows.yml: -------------------------------------------------------------------------------- 1 | name: zip_flows # 工作流程的名称 2 | 3 | on: 4 | workflow_dispatch: # 手动触发 5 | push: 6 | paths: 7 | - '_worker.js' # 当 _worker.js 文件发生变动时触发 8 | 9 | permissions: 10 | contents: write 11 | 12 | jobs: 13 | package-and-commit: 14 | runs-on: ubuntu-latest # 运行环境,这里使用最新版本的 Ubuntu 15 | steps: 16 | - name: Checkout Repository # 检出代码 17 | uses: actions/checkout@v2 18 | 19 | - name: Zip the worker file # 将 _worker.js 文件打包成 worker.js.zip 20 | run: zip _worker.js.zip _worker.js 21 | 22 | - name: Commit and push the packaged file # 提交并推送打包后的文件 23 | uses: EndBug/add-and-commit@v7 24 | with: 25 | add: '_worker.js.zip' 26 | message: 'Automatically package and commit _worker.js.zip' 27 | author_name: github-actions[bot] 28 | author_email: actions[bot]@users.noreply.github.com 29 | token: ${{ secrets.GH_TOKEN }} 30 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # Logs 2 | logs 3 | *.log 4 | npm-debug.log* 5 | yarn-debug.log* 6 | yarn-error.log* 7 | lerna-debug.log* 8 | .pnpm-debug.log* 9 | 10 | # Diagnostic reports (https://nodejs.org/api/report.html) 11 | report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json 12 | 13 | # Runtime data 14 | pids 15 | *.pid 16 | *.seed 17 | *.pid.lock 18 | 19 | # Directory for instrumented libs generated by jscoverage/JSCover 20 | lib-cov 21 | 22 | # Coverage directory used by tools like istanbul 23 | coverage 24 | *.lcov 25 | 26 | # nyc test coverage 27 | .nyc_output 28 | 29 | # Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) 30 | .grunt 31 | 32 | # Bower dependency directory (https://bower.io/) 33 | bower_components 34 | 35 | # node-waf configuration 36 | .lock-wscript 37 | 38 | # Compiled binary addons (https://nodejs.org/api/addons.html) 39 | build/Release 40 | 41 | # Dependency directories 42 | node_modules/ 43 | jspm_packages/ 44 | 45 | # Snowpack dependency directory (https://snowpack.dev/) 46 | web_modules/ 47 | 48 | # TypeScript cache 49 | *.tsbuildinfo 50 | 51 | # Optional npm cache directory 52 | .npm 53 | 54 | # Optional eslint cache 55 | .eslintcache 56 | 57 | # Optional stylelint cache 58 | .stylelintcache 59 | 60 | # Microbundle cache 61 | .rpt2_cache/ 62 | .rts2_cache_cjs/ 63 | .rts2_cache_es/ 64 | .rts2_cache_umd/ 65 | 66 | # Optional REPL history 67 | .node_repl_history 68 | 69 | # Output of 'npm pack' 70 | *.tgz 71 | 72 | # Yarn Integrity file 73 | .yarn-integrity 74 | 75 | # dotenv environment variable files 76 | .env 77 | .env.development.local 78 | .env.test.local 79 | .env.production.local 80 | .env.local 81 | 82 | # parcel-bundler cache (https://parceljs.org/) 83 | .cache 84 | .parcel-cache 85 | 86 | # Next.js build output 87 | .next 88 | out 89 | 90 | # Nuxt.js build / generate output 91 | .nuxt 92 | dist 93 | 94 | # Gatsby files 95 | .cache/ 96 | # Comment in the public line in if your project uses Gatsby and not Next.js 97 | # https://nextjs.org/blog/next-9-1#public-directory-support 98 | # public 99 | 100 | # vuepress build output 101 | .vuepress/dist 102 | 103 | # vuepress v2.x temp and cache directory 104 | .temp 105 | .cache 106 | 107 | # Docusaurus cache and generated files 108 | .docusaurus 109 | 110 | # Serverless directories 111 | .serverless/ 112 | 113 | # FuseBox cache 114 | .fusebox/ 115 | 116 | # DynamoDB Local files 117 | .dynamodb/ 118 | 119 | # TernJS port file 120 | .tern-port 121 | 122 | # Stores VSCode versions used for testing VSCode extensions 123 | .vscode-test 124 | 125 | # yarn v2 126 | .yarn/cache 127 | .yarn/unplugged 128 | .yarn/build-state.yml 129 | .yarn/install-state.gz 130 | .pnp.* 131 | 132 | .DS_Store 133 | .vscode 134 | package-lock.json 135 | yarn.lock 136 | 137 | -------------------------------------------------------------------------------- /_worker.js: -------------------------------------------------------------------------------- 1 | /** 2 | * YouTube Channel: https://youtube.com/@am_clubs 3 | * Telegram Group: https://t.me/am_clubs 4 | * GitHub Repository: https://github.com/amclubs 5 | * Personal Blog: https://amclubs.blogspot.com 6 | * Personal Blog: https://amclubss.com 7 | */ 8 | 9 | let token = ""; 10 | 11 | export default { 12 | async fetch(request, env) { 13 | const url = new URL(request.url); 14 | 15 | // Root path returns nginx page 16 | if (url.pathname === '/') { 17 | return new Response(await nginx(), { 18 | headers: { 'Content-Type': 'text/html; charset=UTF-8' }, 19 | }); 20 | } 21 | 22 | const githubRawUrl = constructGithubUrl(url.pathname, env); 23 | token = getToken(url.searchParams, env); 24 | 25 | if (!token) { 26 | return new Response('TOKEN cannot be empty', { status: 400 }); 27 | } 28 | 29 | const headers = new Headers({ Authorization: `token ${token}` }); 30 | 31 | try { 32 | const response = await fetch(githubRawUrl, { headers }); 33 | 34 | if (!response.ok) { 35 | const errorText = env.ERROR || 'Failed to fetch file, please check the path or TOKEN.'; 36 | return new Response(errorText, { status: response.status }); 37 | } 38 | 39 | const content = await response.text(); 40 | return new Response(content, { 41 | status: 200, 42 | headers: { 'Content-Type': 'text/plain; charset=UTF-8' }, 43 | }); 44 | 45 | } catch (error) { 46 | return new Response(`Error fetching from GitHub: ${error.message}`, { status: 500 }); 47 | } 48 | } 49 | }; 50 | 51 | // Construct GitHub raw content URL based on the environment variables and pathname 52 | function constructGithubUrl(pathname, env) { 53 | const baseUrl = 'https://raw.githubusercontent.com'; 54 | 55 | if (pathname.startsWith(baseUrl)) { 56 | return pathname; 57 | } 58 | 59 | let url = `${baseUrl}/${env.GH_NAME || ''}/${env.GH_REPO || ''}/${env.GH_BRANCH || ''}`.replace(/\/+/g, '/'); 60 | 61 | url += pathname; 62 | 63 | return url.replace(/\/+/g, '/'); 64 | } 65 | 66 | // Retrieve token from search params or environment variables 67 | function getToken(searchParams, env) { 68 | const searchToken = searchParams.get('token'); 69 | if (env.TOKEN && env.TOKEN != searchToken ){ 70 | return new Response('please check the token ', { status: 400 }); 71 | } 72 | return env.GH_TOKEN || searchToken || null; 73 | } 74 | 75 | // Simple nginx HTML page 76 | async function nginx() { 77 | return ` 78 | 79 |
80 |If you see this page, the nginx web server is successfully installed and working. Further configuration is required.
88 |For online documentation and support please refer to nginx.org.
89 | Commercial support is available at nginx.com.
Thank you for using nginx.
91 | 92 | `; 93 | } 94 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # [am-cf-github2raw](https://github.com/amclubs/am-cf-github2raw) 2 | 3 | 轻松访问GitHub私有仓库,允许你通过Cloudflare Workers安全地访问GitHub私有仓库中的原始文件,无需直接暴露你的GitHub令牌。 4 | 5 | # 6 | ▶️ **新人[YouTube](https://youtube.com/@am_clubs?sub_confirmation=1)** 需要您的支持,请务必帮我**点赞**、**关注**、**打开小铃铛**,***十分感谢!!!*** ✅ 7 | 🎁请 **follow** 我的[GitHub](https://github.com/amclubs)、给我所有项目一个 **Star** 星星(拜托了)!你的支持是我不断前进的动力! 💖 8 | ✅**解锁更多技能** [加入TG群【am_clubs】](https://t.me/am_clubs)、[YouTube频道【@am_clubs】](https://youtube.com/@am_clubs?sub_confirmation=1)、[【博客(国内)】](https://amclubss.com)、[【博客(国际)】](https://amclubs.blogspot.com) 9 | ✅点击观看教程[CLoudflare免费节点](https://www.youtube.com/playlist?list=PLGVQi7TjHKXbrY0Pk8gm3T7m8MZ-InquF) | [VPS搭建节点](https://www.youtube.com/playlist?list=PLGVQi7TjHKXaVlrHP9Du61CaEThYCQaiY) | [获取免费域名](https://www.youtube.com/playlist?list=PLGVQi7TjHKXZGODTvB8DEervrmHANQ1AR) | [免费VPN](https://www.youtube.com/playlist?list=PLGVQi7TjHKXY7V2JF-ShRSVwGANlZULdk) | [IPTV源](https://www.youtube.com/playlist?list=PLGVQi7TjHKXbkozDYVsDRJhbnNaEOC76w) | [Mac和Win工具](https://www.youtube.com/playlist?list=PLGVQi7TjHKXYBWu65yP8E08HxAu9LbCWm) | [AI分享](https://www.youtube.com/playlist?list=PLGVQi7TjHKXaodkM-mS-2Nwggwc5wRjqY) 10 | 11 | # 12 | - 部署视频教程:[小白教程](https://www.youtube.com/watch?v=f9hDJCqAEGA) 13 | - 视频教程:[所有教程](https://www.youtube.com/playlist?list=PLGVQi7TjHKXbrY0Pk8gm3T7m8MZ-InquF) 14 | 15 | 16 | ## 一、为什么需要这个工具? 17 | 18 | - 你有一些存储在GitHub私有仓库中的重要文件。 19 | - 你想直接通过URL访问这些文件的原始内容(比如配置文件、数据文件等)。 20 | - 但是,你不想在URL中直接暴露你的GitHub令牌,因为这可能会被他人滥用。 21 | 22 | ## 二、如何使用? 23 | 24 | 假设你的Cloudflare Workers项目部署在`raw.amcloud.filegear-sg.me`, 25 | 26 | 而你要访问的私有文件是`https://raw.githubusercontent.com/amclubs/am-cf-github2raw/main/_worker.js`。 27 | 28 | ## 方法1:通过URL参数传递令牌 29 | 30 | 最直接的方法是在URL中添加你的GitHub令牌作为参数: 31 | 32 | ```url 33 | https://raw.amcloud.filegear-sg.me/amclubs/am-cf-github2raw/main/_worker.js?token=你的GitHub令牌 34 | ``` 35 | 36 | 或者,如果你喜欢完整的原始URL: 37 | 38 | ```url 39 | https://raw.amcloud.filegear-sg.me/https://raw.githubusercontent.com/amclubs/am-cf-github2raw/main/_worker.js?token=你的GitHub令牌 40 | ``` 41 | 42 | ## 方法2:在Workers中设置全局令牌 43 | 44 | 如果你经常访问同一个私有仓库,可以在Workers设置中添加一个名为`GH_TOKEN`的变量,值为你的GitHub令牌。这样,你就可以直接访问,无需在URL中每次都包含令牌: 45 | 46 | ```url 47 | https://raw.amcloud.filegear-sg.me/amclubs/am-cf-github2raw/main/_worker.js 48 | ``` 49 | 50 | 或者,如果你喜欢完整的原始URL: 51 | 52 | ```url 53 | https://raw.amcloud.filegear-sg.me/https://raw.githubusercontent.com/amclubs/am-cf-github2raw/main/_worker.js 54 | ``` 55 | 56 | ## 方法3:添加额外的访问控制(推荐) 57 | 58 | 为了更高的安全性,你可以设置两个变量: 59 | 60 | - `GH_TOKEN`:你的GitHub令牌 61 | - `TOKEN`:一个自定义的访问密钥(比如mysecretkey) 62 | 63 | 然后,你的URL会是这样的: 64 | 65 | ```url 66 | https://raw.amcloud.filegear-sg.me/amclubs/am-cf-github2raw/main/_worker.js?token=mysecretkey 67 | ``` 68 | 69 | 或者,如果你喜欢完整的原始URL: 70 | 71 | ```url 72 | https://raw.amcloud.filegear-sg.me/https://raw.githubusercontent.com/amclubs/am-cf-github2raw/main/_worker.js?token=mysecretkey 73 | ``` 74 | 75 | 这种方法提供了双重安全:即使有人猜到了你的自定义密钥,他们仍然无法访问你的GitHub文件,因为GitHub令牌是安全地存储在Workers设置中的。 76 | 77 | ## 方法4:添加`GH_NAME`、`GH_REPO`、`GH_BRANCH`变量**隐藏GitHub路径信息** 78 | 79 | 为了更高的隐私性,你可以设置多个变量: 80 | 81 | - `GH_NAME`:你的GitHub用户名(例如: **amclubs**) 82 | 然后,你的URL会是这样的: 83 | 84 | ```url 85 | https://raw.amcloud.filegear-sg.me/am-cf-github2raw/main/_worker.js?token=sd123123 86 | ``` 87 | 88 | - `GH_REPO`:你的GitHub仓库名(例如: **am-cf-github2raw**,必须设置`GH_NAME`变量为前提) 89 | 然后,你的URL会是这样的: 90 | 91 | ```url 92 | https://raw.amcloud.filegear-sg.me/main/_worker.js?token=sd123123 93 | ``` 94 | 95 | - `GH_BRANCH`:你的GitHub仓库名(例如: **main**,必须设置`GH_NAME`和`GH_REPO`变量为前提) 96 | 然后,你的URL会是这样的: 97 | 98 | ```url 99 | https://raw.amcloud.filegear-sg.me/_worker.js?token=sd123123 100 | ``` 101 | 102 | **如您使用完整的原始URL,则以上变量将不会生效!** 103 | 104 | ```url 105 | https://raw.amcloud.filegear-sg.me/https://raw.githubusercontent.com/amclubs/am-cf-github2raw/main/_worker.js?token=sd123123 106 | ``` 107 | 108 | ## 三、如何设置这些变量? 109 | 110 | 在你的Cloudflare Workers管理面板中: 111 | 112 | 1. 进入你的Workers项目。 113 | 2. 点击**设置**标签。 114 | 3. 滚动到**环境变量**部分。 115 | 4. 添加以下变量: 116 | - 变量:GH_TOKEN,值:你的GitHub个人访问令牌 117 | - 变量:TOKEN(可选),值:你的自定义访问密钥 118 | 119 | GitHub个人访问令牌可以在GitHub设置中(点个人头像,点击Settings)进入"Developer settings" > "Personal access tokens“ > "tokens (classic)"页面生成。 120 | 121 | ## 四、错误处理 122 | 123 | 如果出现问题,你会看到以下错误消息之一: 124 | 125 | - **TOKEN有误**:你提供的自定义访问密钥不正确。 126 | - **TOKEN不能为空**:需要提供GitHub令牌。 127 | - **无法获取文件 检测路径或TOKEN**:文件路径错误或令牌无权访问该文件。 128 | - **路径不能为空**:你没有指定要访问的文件路径。 129 | 130 | # 五、变量说明 131 | 132 | | 变量名 | 示例 | 必填 | 备注 | 133 | | --------- | ----------------------------------------------------------- | ---- | ------------------------------------------------------------ | 134 | | GH_TOKEN | ghp_uc0bZblkbO3gKxhn13t |❌| 您的GitHub令牌 **token** | 135 | | TOKEN | uc0bZblkbO3gKxhn13t |❌| `GH_TOKEN`和`TOKEN`同时存在的时候会作为访问鉴权,单独赋值时的效果与`GH_TOKEN`相同 | 136 | | GH_NAME | amclubs |❌| GitHub用户名 | 137 | | GH_REPO | am-cf-github2raw |❌| GitHub仓库(必须设置`GH_NAME`变量为前提) | 138 | | GH_BRANCH | main |❌| GitHub仓库分支(必须设置`GH_NAME`和`GH_REPO`变量为前提) | 139 | | ERROR | 无法获取文件,检查路径或TOKEN是否正确。 |❌| 自定义错误提示 | 140 | 141 | # 142 |