├── .github └── workflows │ ├── buildService.yml │ └── releaseService.yml ├── .gitignore ├── Dockerfile ├── LICENSE ├── Makefile ├── README.md ├── docker_entrypoint.sh ├── icon.png ├── instructions.md ├── manifest.yaml └── scripts ├── bundle.ts ├── deps.ts ├── embassy.ts └── procedures ├── getConfig.ts ├── migrations.ts ├── properties.ts └── setConfig.ts /.github/workflows/buildService.yml: -------------------------------------------------------------------------------- 1 | name: Build Service 2 | 3 | on: 4 | workflow_dispatch: 5 | pull_request: 6 | paths-ignore: ['*.md'] 7 | branches: ['main', 'master'] 8 | push: 9 | paths-ignore: ['*.md'] 10 | branches: ['main', 'master'] 11 | 12 | jobs: 13 | BuildPackage: 14 | runs-on: ubuntu-latest 15 | steps: 16 | - name: Prepare StartOS SDK 17 | uses: Start9Labs/sdk@v1 18 | 19 | - name: Checkout services repository 20 | uses: actions/checkout@v4 21 | 22 | - name: Build the service package 23 | id: build 24 | run: | 25 | git submodule update --init --recursive 26 | start-sdk init 27 | make 28 | PACKAGE_ID=$(yq -oy ".id" manifest.*) 29 | echo "package_id=$PACKAGE_ID" >> $GITHUB_ENV 30 | printf "\n SHA256SUM: $(sha256sum ${PACKAGE_ID}.s9pk) \n" 31 | shell: bash 32 | 33 | # - name: Upload .s9pk 34 | # uses: actions/upload-artifact@v4 35 | # with: 36 | # name: ${{ env.package_id }}.s9pk 37 | # path: ./${{ env.package_id }}.s9pk -------------------------------------------------------------------------------- /.github/workflows/releaseService.yml: -------------------------------------------------------------------------------- 1 | name: Release Service 2 | 3 | on: 4 | push: 5 | tags: 6 | - 'v*.*' 7 | 8 | jobs: 9 | ReleasePackage: 10 | runs-on: ubuntu-latest 11 | permissions: 12 | contents: write 13 | steps: 14 | - name: Prepare StartOS SDK 15 | uses: Start9Labs/sdk@v1 16 | 17 | - name: Checkout services repository 18 | uses: actions/checkout@v4 19 | 20 | - name: Build the service package 21 | run: | 22 | git submodule update --init --recursive 23 | start-sdk init 24 | make 25 | 26 | - name: Setting package ID and title from the manifest 27 | id: package 28 | run: | 29 | echo "package_id=$(yq -oy ".id" manifest.*)" >> $GITHUB_ENV 30 | echo "package_title=$(yq -oy ".title" manifest.*)" >> $GITHUB_ENV 31 | shell: bash 32 | 33 | - name: Generate sha256 checksum 34 | run: | 35 | PACKAGE_ID=${{ env.package_id }} 36 | printf "\n SHA256SUM: $(sha256sum ${PACKAGE_ID}.s9pk) \n" 37 | sha256sum ${PACKAGE_ID}.s9pk > ${PACKAGE_ID}.s9pk.sha256 38 | shell: bash 39 | 40 | - name: Generate changelog 41 | run: | 42 | PACKAGE_ID=${{ env.package_id }} 43 | echo "## What's Changed" > change-log.txt 44 | yq -oy '.release-notes' manifest.* >> change-log.txt 45 | echo "## SHA256 Hash" >> change-log.txt 46 | echo '```' >> change-log.txt 47 | sha256sum ${PACKAGE_ID}.s9pk >> change-log.txt 48 | echo '```' >> change-log.txt 49 | shell: bash 50 | 51 | - name: Create GitHub Release 52 | uses: softprops/action-gh-release@v2 53 | with: 54 | tag_name: ${{ github.ref_name }} 55 | name: ${{ env.package_title }} ${{ github.ref_name }} 56 | prerelease: true 57 | body_path: change-log.txt 58 | files: | 59 | ./${{ env.package_id }}.s9pk 60 | ./${{ env.package_id }}.s9pk.sha256 61 | 62 | - name: Publish to Registry 63 | env: 64 | S9USER: ${{ secrets.S9USER }} 65 | S9PASS: ${{ secrets.S9PASS }} 66 | S9REGISTRY: ${{ secrets.S9REGISTRY }} 67 | run: | 68 | if [[ -z "$S9USER" || -z "$S9PASS" || -z "$S9REGISTRY" ]]; then 69 | echo "Publish skipped: missing registry credentials." 70 | else 71 | start-sdk publish https://$S9USER:$S9PASS@$S9REGISTRY ${{ env.package_id }}.s9pk 72 | fi -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.s9pk 2 | .vscode/ 3 | .DS_Store 4 | scripts/*.js 5 | docker-images 6 | tmp 7 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | # cloudflared container version is defined in Makefile 2 | ARG CLOUDFLARED_IMAGE 3 | 4 | # used to copy cloudflared binary 5 | FROM $CLOUDFLARED_IMAGE as cloudflared 6 | 7 | # run on debian bookworm slim 8 | FROM debian:12-slim 9 | 10 | ARG PLATFORM 11 | 12 | RUN \ 13 | apt-get update && \ 14 | DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends -y \ 15 | ca-certificates && \ 16 | apt-get autoclean && \ 17 | rm -rf \ 18 | /var/lib/apt/lists/* \ 19 | /var/tmp/* \ 20 | /tmp/* 21 | 22 | # add local files 23 | COPY --chmod=0755 ./docker_entrypoint.sh /usr/local/bin/docker_entrypoint.sh 24 | COPY --chmod=0755 ./tmp/yq_linux_${PLATFORM} /usr/local/bin/yq 25 | COPY --chmod=0755 --from=cloudflared /usr/local/bin/cloudflared /usr/local/bin/cloudflared 26 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | CLOUDFLARED_IMAGE := cloudflare/cloudflared:2025.5.0 2 | # sha256 hashes can be found in https://github.com/mikefarah/yq/releases/download/v4.40.7/checksums-bsd 3 | YQ_VERSION := 4.40.7 4 | YQ_SHA_AMD64 := 4f13ee9303a49f7e8f61e7d9c87402e07cc920ae8dfaaa8c10d7ea1b8f9f48ed 5 | YQ_SHA_ARM64 := a84f2c8f105b70cd348c3bf14048aeb1665c2e7314cbe9aaff15479f268b8412 6 | 7 | PKG_ID := $(shell yq e ".id" manifest.yaml) 8 | PKG_VERSION := $(shell yq e ".version" manifest.yaml) 9 | TS_FILES := $(shell find ./ -name \*.ts) 10 | 11 | .DELETE_ON_ERROR: 12 | 13 | all: verify 14 | 15 | arm: 16 | @rm -f docker-images/aarch64.tar 17 | @ARCH=aarch64 $(MAKE) 18 | 19 | x86: 20 | @rm -f docker-images/x86_64.tar 21 | @ARCH=x86_64 $(MAKE) 22 | 23 | verify: $(PKG_ID).s9pk 24 | @start-sdk verify s9pk $(PKG_ID).s9pk 25 | @echo " Done!" 26 | @echo " Filesize: $(shell du -h $(PKG_ID).s9pk) is ready" 27 | 28 | install: 29 | @if [ ! -f ~/.embassy/config.yaml ]; then echo "You must define \"host: http://server-name.local\" in ~/.embassy/config.yaml config file first."; exit 1; fi 30 | @echo "\nInstalling to $$(grep -v '^#' ~/.embassy/config.yaml | cut -d'/' -f3) ...\n" 31 | @[ -f $(PKG_ID).s9pk ] || ( $(MAKE) && echo "\nInstalling to $$(grep -v '^#' ~/.embassy/config.yaml | cut -d'/' -f3) ...\n" ) 32 | @start-cli package install $(PKG_ID).s9pk 33 | 34 | clean: 35 | rm -rf docker-images 36 | rm -f $(PKG_ID).s9pk 37 | rm -f scripts/*.js 38 | 39 | scripts/embassy.js: $(TS_FILES) 40 | deno run --allow-read --allow-write --allow-env --allow-net scripts/bundle.ts 41 | 42 | docker-images/aarch64.tar: manifest.yaml Dockerfile docker_entrypoint.sh tmp/yq_linux_arm64 43 | ifeq ($(ARCH),x86_64) 44 | else 45 | mkdir -p docker-images 46 | docker buildx build --tag start9/$(PKG_ID)/main:$(PKG_VERSION) \ 47 | --build-arg PLATFORM=arm64 \ 48 | --build-arg CLOUDFLARED_IMAGE=$(CLOUDFLARED_IMAGE) \ 49 | --platform=linux/arm64 -o type=docker,dest=docker-images/aarch64.tar . 50 | endif 51 | 52 | docker-images/x86_64.tar: manifest.yaml Dockerfile docker_entrypoint.sh tmp/yq_linux_amd64 53 | ifeq ($(ARCH),aarch64) 54 | else 55 | mkdir -p docker-images 56 | docker buildx build --tag start9/$(PKG_ID)/main:$(PKG_VERSION) \ 57 | --build-arg PLATFORM=amd64 \ 58 | --build-arg CLOUDFLARED_IMAGE=$(CLOUDFLARED_IMAGE) \ 59 | --platform=linux/amd64 -o type=docker,dest=docker-images/x86_64.tar . 60 | endif 61 | 62 | tmp/yq_linux_amd64: 63 | mkdir -p tmp 64 | wget -qO ./tmp/yq_linux_amd64 https://github.com/mikefarah/yq/releases/download/v$(YQ_VERSION)/yq_linux_amd64 65 | echo "$(YQ_SHA_AMD64) ./tmp/yq_linux_amd64" | sha256sum --check || exit 1 66 | 67 | tmp/yq_linux_arm64: 68 | mkdir -p tmp 69 | wget -qO ./tmp/yq_linux_arm64 https://github.com/mikefarah/yq/releases/download/v$(YQ_VERSION)/yq_linux_arm64 70 | echo "$(YQ_SHA_ARM64) ./tmp/yq_linux_arm64" | sha256sum --check || exit 1 71 | 72 | $(PKG_ID).s9pk: manifest.yaml instructions.md icon.png LICENSE scripts/embassy.js docker-images/aarch64.tar docker-images/x86_64.tar 73 | ifeq ($(ARCH),aarch64) 74 | @echo "start-sdk: Preparing aarch64 package ..." 75 | else ifeq ($(ARCH),x86_64) 76 | @echo "start-sdk: Preparing x86_64 package ..." 77 | else 78 | @echo "start-sdk: Preparing Universal Package ..." 79 | endif 80 | @start-sdk pack 81 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | Project Logo 3 |

4 | 5 | # Cloudflare Tunnel client for StartOS 6 | 7 | Cloudflare Tunnel for StartOS 8 | 9 | ## Dependencies 10 | 11 | Install the system dependencies below to build this project by following the instructions in the provided links. You can also find detailed steps to setup your environment in the service packaging [documentation](https://docs.start9.com/latest/developer-docs/packaging#development-environment). 12 | 13 | - [docker](https://docs.docker.com/get-docker) 14 | - [docker-buildx](https://docs.docker.com/buildx/working-with-buildx/) 15 | - [yq](https://mikefarah.gitbook.io/yq) 16 | - [deno](https://deno.land/) 17 | - [make](https://www.gnu.org/software/make/) 18 | - [start-sdk](https://github.com/Start9Labs/start-os/tree/sdk) 19 | 20 | ## Cloning 21 | 22 | Clone the repository locally. 23 | 24 | ``` 25 | git clone git@github.com:remcoros/cloudflared-startos.git 26 | cd cloudflared-startos 27 | ``` 28 | 29 | ## Building 30 | 31 | To build the **Cloudflare Tunnel** service as a universal package, run the following command: 32 | 33 | ``` 34 | make 35 | ``` 36 | 37 | ## Installing (on StartOS) 38 | 39 | Before installation, define `host: https://server-name.local` in your `~/.embassy/config.yaml` config file then run the following commands to determine successful install: 40 | 41 | > Change server-name.local to your Start9 server address 42 | 43 | ``` 44 | start-cli auth login 45 | #Enter your StartOS password 46 | make install 47 | ``` 48 | 49 | **Tip:** You can also install the cloudflared.s9pk by sideloading it under the **StartOS > System > Sideload a Service** section. 50 | 51 | ## Verify Install 52 | 53 | Go to your StartOS Services page, select **Cloudflare Tunnel**, configure and start the service. 54 | 55 | **Done!** 56 | -------------------------------------------------------------------------------- /docker_entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | echo 4 | echo "Initialising Cloudflare Tunnel for StartOS..." 5 | echo 6 | 7 | export TUNNEL_TOKEN="$(yq e '.token' /root/data/start9/config.yaml)" 8 | 9 | /usr/local/bin/cloudflared --no-autoupdate --management-diagnostics=false tunnel run 10 | -------------------------------------------------------------------------------- /icon.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/remcoros/cloudflared-startos/020fcf24be225323bed7e36ec9178440bab3d667/icon.png -------------------------------------------------------------------------------- /instructions.md: -------------------------------------------------------------------------------- 1 | # Cloudflare Tunnel for StartOS Instructions 2 | 3 | ``` 4 | ----- WARNING ----- 5 | 6 | This is for advanced users who know what they are doing. 7 | 8 | Exposing your server on the internet brings a lot of responsibility and can expose your server/service to all kind of attacks. 9 | 10 | Don't be reckless! 11 | 12 | ----- WARNING ----- 13 | ``` 14 | 15 | Here are some basic instructions. We won't go into detail because this should NOT be newb friendly. You have to REALLY KNOW WHAT YOU ARE DOING!! 16 | 17 | * You need a cloudflare account 18 | * Setup a website, with domain, dns and flexible ssl 19 | * Create a tunnel in cloudflare 'Zero Trust' 20 | * Copy the generated token and paste it in StartOS Cloudflare Tunnel service configuration 21 | * Start the Cloudflare Tunnel service in StartOS 22 | * In cloudflare tunnel dashboard, add public hostnames and route them directly to a StartOS service. For example: 23 | 24 | ``` 25 | Subdomain: btcpay 26 | Domain: mydomain.xyz 27 | Path: (empty) 28 | 29 | Service Type: HTTP 30 | URL: btcpayserver.embassy:80 31 | ``` 32 | 33 | If you have setup the website, domain (mydomain.xyz), DNS, a SSL certificate and tunnel correctly, the BTCPay server is now exposed through a cloudflare tunnel on 'https://btcpay.mydomain.xyz' 34 | -------------------------------------------------------------------------------- /manifest.yaml: -------------------------------------------------------------------------------- 1 | id: cloudflared 2 | title: "Cloudflare Tunnel" 3 | version: 2025.5.0 4 | release-notes: | 5 | * Update to cloudflared 2025.5.0 - See [full changelog](https://github.com/cloudflare/cloudflared/blob/2025.5.0/RELEASE_NOTES) 6 | license: Apache 2.0 7 | wrapper-repo: "https://github.com/remcoros/cloudflared-startos" 8 | upstream-repo: "https://github.com/cloudflare/cloudflared" 9 | support-site: "https://github.com/cloudflare/cloudflared/issues" 10 | marketing-site: "https://cloudflare.com/" 11 | donation-url: "https://cloudflare.com/" 12 | build: ["make"] 13 | description: 14 | short: Cloudflare Tunnel client 15 | long: | 16 | With the Cloudflare Tunnel client you can proxy traffic from the Cloudflare network to your StartOS server. 17 | assets: 18 | license: LICENSE 19 | icon: icon.png 20 | instructions: instructions.md 21 | main: 22 | type: docker 23 | image: main 24 | entrypoint: "docker_entrypoint.sh" 25 | args: [] 26 | mounts: 27 | main: /root/data 28 | gpu-acceleration: false 29 | hardware-requirements: 30 | arch: 31 | - x86_64 32 | - aarch64 33 | health-checks: {} 34 | config: 35 | get: 36 | type: script 37 | set: 38 | type: script 39 | properties: 40 | type: script 41 | volumes: 42 | main: 43 | type: data 44 | interfaces: {} 45 | dependencies: {} 46 | backup: 47 | create: 48 | type: docker 49 | image: compat 50 | system: true 51 | entrypoint: compat 52 | args: 53 | - duplicity 54 | - create 55 | - /mnt/backup 56 | - /root/data 57 | mounts: 58 | BACKUP: "/mnt/backup" 59 | main: "/root/data" 60 | restore: 61 | type: docker 62 | image: compat 63 | system: true 64 | entrypoint: compat 65 | args: 66 | - duplicity 67 | - restore 68 | - /mnt/backup 69 | - /root/data 70 | mounts: 71 | BACKUP: "/mnt/backup" 72 | main: "/root/data" 73 | migrations: 74 | from: 75 | "*": 76 | type: script 77 | args: ["from"] 78 | to: 79 | "*": 80 | type: script 81 | args: ["to"] 82 | -------------------------------------------------------------------------------- /scripts/bundle.ts: -------------------------------------------------------------------------------- 1 | import { bundle } from "https://deno.land/x/emit@0.40.0/mod.ts"; 2 | const result = await bundle("scripts/embassy.ts"); 3 | await Deno.writeTextFile("scripts/embassy.js", result.code); 4 | -------------------------------------------------------------------------------- /scripts/deps.ts: -------------------------------------------------------------------------------- 1 | export * from "https://deno.land/x/embassyd_sdk@v0.3.3.0.11/mod.ts"; 2 | -------------------------------------------------------------------------------- /scripts/embassy.ts: -------------------------------------------------------------------------------- 1 | export { getConfig } from "./procedures/getConfig.ts"; 2 | export { setConfig } from "./procedures/setConfig.ts"; 3 | export { properties } from "./procedures/properties.ts"; 4 | export { migration } from "./procedures/migrations.ts"; 5 | -------------------------------------------------------------------------------- /scripts/procedures/getConfig.ts: -------------------------------------------------------------------------------- 1 | import { compat, types as T } from "../deps.ts"; 2 | 3 | export const getConfig: T.ExpectedExports.getConfig = compat.getConfig({ 4 | token: { 5 | type: "string", 6 | name: "Token", 7 | description: "The Cloudflare Tunnel Token.", 8 | nullable: false, 9 | masked: true, 10 | copyable: true, 11 | }, 12 | }); 13 | -------------------------------------------------------------------------------- /scripts/procedures/migrations.ts: -------------------------------------------------------------------------------- 1 | import { compat, types as T } from "../deps.ts"; 2 | 3 | export const migration: T.ExpectedExports.migration = compat.migrations 4 | .fromMapping({}, "2025.5.0" ); 5 | -------------------------------------------------------------------------------- /scripts/procedures/properties.ts: -------------------------------------------------------------------------------- 1 | import { compat, types as T } from "../deps.ts"; 2 | 3 | export const properties: T.ExpectedExports.properties = compat.properties; 4 | -------------------------------------------------------------------------------- /scripts/procedures/setConfig.ts: -------------------------------------------------------------------------------- 1 | import { compat } from "../deps.ts"; 2 | 3 | export const setConfig = compat.setConfig; 4 | --------------------------------------------------------------------------------