Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/connormckelvey/cloudflare-spectrum-ddns
Use DDNS to Update a Cloudflare Spectrum Application's IP Address
https://github.com/connormckelvey/cloudflare-spectrum-ddns
cloudflare docker golang minecraft spectrum ssh
Last synced: about 2 months ago
JSON representation
Use DDNS to Update a Cloudflare Spectrum Application's IP Address
- Host: GitHub
- URL: https://github.com/connormckelvey/cloudflare-spectrum-ddns
- Owner: connormckelvey
- License: mit
- Created: 2021-12-07T23:11:13.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2021-12-12T18:33:59.000Z (about 3 years ago)
- Last Synced: 2024-11-06T05:23:23.921Z (3 months ago)
- Topics: cloudflare, docker, golang, minecraft, spectrum, ssh
- Language: Go
- Homepage:
- Size: 22.5 KB
- Stars: 2
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cloudflare Spectrum DDNS [](https://github.com/connormckelvey/cloudflare-spectrum-ddns/actions/workflows/main.yml)
### NOTICE - PROJECT IS A WORK IN PROGRESS
Cloudflare Spectrum's functionality is limited to specifying IP addresses for SSH and Minecraft applications (at least for the Pro subscription). This is a problem for homelabbers, self-hosters, or anyone else that has a dynamic IP address.
This project serves to fill a need left by this limited functionality by providing tooling to:
1. Determine your current public IP address
2. Update your Cloudflare Spectrum application's IP address upon change.
## Deployment
This project has been designed to allow the aforementioned tooling to be consumed in a variety of ways.
- Run manually as a one-off command
- Run as a native or Kubernetes cronjob
- Dockerized in vanilla Docker, Docker Compose, or Kubernetes (see docker installation below)
- As a library see the `pkg` directory for the public `IPChecker`, `IPPoller` and `SpectrumClient` utilities.
## Requirements
- Existing DDNS solution (Dyn.com, NoIP.com, etc)
- Docker or Linux (should work on macOS and Windows but has not been tested)
## Installation
### Native (golang binary)
```
go get github.com/connormckelvey/cloudflare-spectrum-ddns/cmd/update-spectrum-ip
```
### Docker
```
docker pull connormckelvey/cloudflare-spectrum-ddns
```
## Configuration
Configuration can be done through environment variables or command-line flags. The only exceptions are:
- `CLOUDFLARE_API_KEY` and `CLOUDFLARE_API_EMAIL` which can only be set via environment variables
- `-poll` and `-debug` which can only be set with command-line flags.
**NOTE** Flags have a higher priority than environment variables and take precedence.
### Dotenv (.env) Files
The update-spectrum-dns binary will automatically load a `.env` file from the current working directory.
### Definitions
|Environment Variable|Flag|Description|Example
|---|---|---|---|
|`CLOUDFLARE_API_KEY`|x|User API Key for Cloudflare Account|`98eb470b2b60482e259d28648895d9e1`|
|`CLOUDFLARE_API_EMAIL`|x|Email address associated with API Key|`[email protected]`|
|`CLOUDFLARE_ZONE_NAME`|`-zone`|Cloudflare Zone or "Site" name hosting the Spectrum application|`example.com`|
|`SPECTRUM_APP_DOMAIN`|`-app-domain`|Domain name to be used for Spectrum App|`minecraft.example.com`|
|`SPECTRUM_APP_PROTOCOL`|`-app-protocol`|Protocol for the Spectrum application (`ssh` or `minecraft`)| `minecraft`
|`DDNS_DOMAIN`|`-ddns-domain`|Domain (from DDNS service) used to get latest IP address|`example.noip.com`|
|`DNS_SERVER`|`-dns-server`|DNS Server used to query DDNSDomain|8.8.8.8|
|x|`-poll`|Check and apply updates continuously, omit this to only run once (cron)|`-poll`|
|x|`-debug`|Enable verbose logging|`-debug`|
## Usage
### Native (golang binary and .env)
```
echo CLOUDFLARE_API_KEY=xxx >> .env
echo CLOUDFLARE_API_EMAIL=xxx >> .env
```
(optionally define more environment variables in the .env file instead of using the command line flags below.)
```
update-spectrum-ip \
-zone example.com \
-app-domain minecraft.example.com \
-ddns-domain example.noip.com \
-dns-server 1.1.1.1 \
-poll \
-debug
```
### Docker
```
echo CLOUDFLARE_API_KEY=xxx >> .env
echo CLOUDFLARE_API_EMAIL=xxx >> .env
```
(optionally define more environment variables in the .env file instead of using the command line flags below.)
```
docker run --env-file .env connormckelvey/cloudflare-spectrum-ddns
-zone example.com \
-app-domain minecraft.example.com \
-ddns-domain example.noip.com \
-dns-server 1.1.1.1 \
-poll \
-debug
```
*OR*
```
docker run -v "/path/to/.env:/app/.env" cloudflare-spectrum-ddns:dev \
-zone example.com \
-app-domain minecraft.example.com \
-ddns-domain example.noip.com \
-dns-server 1.1.1.1 \
-poll \
-debug
```
### Docker Compose (.env)
*docker-compose.yml*
```
version: '3'
services:
update-spectrum-ip:
image: connormckelvey/cloudflare-spectrum-ddns:latest
command:
- -poll
- -debug
env_file: .env
restart: unless-stopped
```
```
docker-compose up -d
```
### Kubernetes
If you are reading this, you already know how to translate a docker-compose.yml into a Deployment/Cronjob manifest and create a helm chart. When you do, please feel free to open a pull request!
## TODO
- Unit Tests
- Integration tests
- Docker tests
- Github actions CI tests and builds
- Tag based releases