Update .gitea/workflows/build.yaml

Reviewed-on: timatlee/cloudflare-ddns-docker-updated#40

.gitea/workflows/build.yaml

@@ -0,0 +1,37 @@
+name: Build Docker Image
+
+on:
+  push:
+    branches:
+      - main
+      - testing
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    container: 
+      image: catthehacker/ubuntu:act-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v3
+
+      - name: Login to Docker registry
+        uses: docker/login-action@v3
+        with:
+          registry: git.home.timatlee.com
+          username: ${{ secrets.REGISTRY_USERNAME }}
+          password: ${{ secrets.REGISTRY_PASSWORD }}
+
+      - name: Build and push
+        uses: docker/build-push-action@v6
+        with:
+          context: .
+          push: true
+          tags: git.home.timatlee.com/timatlee/cloudflare-ddns:latest

.gitea/workflows/demo.yaml.donotuse

@@ -0,0 +1,19 @@
+name: Gitea Actions Demo
+run-name: ${{ gitea.actor }} is testing out Gitea Actions 🚀
+on: [push]
+
+jobs:
+  Explore-Gitea-Actions:
+    runs-on: ubuntu-latest
+    steps:
+      - run: echo "🎉 The job was automatically triggered by a ${{ gitea.event_name }} event."
+      - run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by Gitea!"
+      - run: echo "🔎 The name of your branch is ${{ gitea.ref }} and your repository is ${{ gitea.repository }}."
+      - name: Check out repository code
+        uses: actions/checkout@v4
+      - run: echo "💡 The ${{ gitea.repository }} repository has been cloned to the runner."
+      - run: echo "🖥️ The workflow is now ready to test your code on the runner."
+      - name: List files in the repository
+        run: |
+          ls ${{ gitea.workspace }}
+      - run: echo "🍏 This job's status is ${{ job.status }}."

.sops.yaml

@@ -0,0 +1 @@
+[]

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:3.9-slim
+FROM python:3.13-slim
 
 WORKDIR /app
 

README.md

@@ -1,2 +1,103 @@
-# cloudflare-ddns-docker
-A Docker service updating your CloudFlare DNS records periodically. 
+# Cloudflare DDNS
+
+![Linting](https://github.com/Akarys42/cloudflare-ddns-docker/workflows/Linting/badge.svg)
+![Push Container](https://github.com/Akarys42/cloudflare-ddns-docker/workflows/Push%20Container/badge.svg)
+[![License](https://img.shields.io/badge/license-MIT-green)](LICENSE)
+
+
+Cloudflare DDNS is a configurable Docker service updating your CloudFlare DNS records periodically
+to match your local IP address.
+
+# Table of Content
+
+- [Cloudflare DDNS](#cloudflare-ddns)
+- [Table of Content](#table-of-content)
+  - [Installation](#installation)
+    - [Using a Pre-built Container](#using-a-pre-built-container)
+    - [Building the Container Yourself](#building-the-container-yourself)
+      - [Hosting](#hosting)
+    - [Running on the Host](#running-on-the-host)
+  - [Configuration](#configuration)
+    - [Getting a Cloudflare Token](#getting-a-cloudflare-token)
+    - [Supported Options](#supported-options)
+  - [Contributing](#contributing)
+
+
+## Installation
+
+While this project is intended to be ran as a Docker container, it can also be ran on the host directly.
+
+This container runs until terminated. It is not a cron job.
+
+### Using a Pre-built Container
+
+This project is available on the GitHub Container Registry.
+```shell
+docker pull git.home.timatlee.com/timatlee/cloudflare-ddns:latest
+```
+
+### Building the Container Yourself
+
+There are no special requirements when building this container. Simply build with:
+
+```shell
+docker build -t git.home.timatlee.com/timatlee/cloudflare-ddns:latest .
+docker push git.home.timatlee.com/timatlee/cloudflare-ddns:latest
+```
+
+#### Hosting
+
+I am hosting this in my own Gitea repository. We can push this with:
+
+```shell
+docker login git.home.timatlee.com
+username: timatlee
+password: // Gitea PAT token
+```
+
+### Running on the Host
+
+Python > 3.12 is required. This likely requires a virtualenv.
+
+```shell
+python -m venv .env
+.env\scripts\activate.ps1
+pip install -r requirements.txt
+python -m cloudflare_ddns --token ... -d .. domain.example.com
+```
+
+In order to run this project on the host, you'll need Python > 3.8, and an environment containing
+the dependencies listed in [`requirements.txt`](requirements.txt).
+
+The project can then by launched by running the `cloudflare_ddns` module, usually using `python -m cloudflare_ddns`.
+
+## Configuration
+
+This project will accept parameters through environment variables or command line argument.
+Feel free to select the method fitting your setup the best!
+
+### Getting a Cloudflare Token
+
+The first step will be to create an API token with the following scopes:
+- `Zone:Read`
+- `DNS:Edit`
+
+### Supported Options
+
+We currently support following settings:
+
+| Parameter Name             | Short Command Line Option | Long Command Line Option | Environment Variable | Description                                                                                 |
+|----------------------------|---------------------------|--------------------------|----------------------|---------------------------------------------------------------------------------------------|
+| Token [mandatory]          | `-k`                      | `--token`                | `CF_DDNS_TOKEN`      | Your Cloudflare token created in the previous step.                                         |
+| Delay [default: 5 minutes] | `-d`                      | `--delay`                | `CF_DDNS_DELAY`      | The time to wait between each update. It is parsed per [`strftime`](https://strftime.org/). |
+
+The domains to update will have to either be passed as command line arguments after the options
+or with a space separated `CF_DDNS_DOMAINS` environment variable.
+
+Each domain can be preceded by the record type, either A or AAAA, followed by a colon.
+Otherwise any found A or AAAA record pointing to this domain found will be used.
+
+## Contributing
+
+Any help would be greatly appreciated!
+Feel free to check our [open issues](https://github.com/Akarys42/cloudflare-ddns-docker/issues) and send us a Pull Request!

cloudflare_ddns/__main__.py

@@ -1,13 +1,14 @@
 import logging
 from os import environ
 from typing import Tuple
+from dotenv import load_dotenv
 
 import click
 from cloudflare_ddns.app import ApplicationJob
 from cloudflare_ddns.constants import BASE_ENV_VAR, DEFAULT_DELAY, DOMAINS_ENV_VAR
 
 log = logging.getLogger("ddns")
-
+load_dotenv()  
 
 @click.command()
 @click.option(
@@ -22,6 +23,7 @@ log = logging.getLogger("ddns")
     prompt="Enter your Cloudflare Token",
     hide_input=True,
     show_envvar=True,
+    envvar='CF_DDNS_TOKEN',
     help="Your Cloudflare Bearer token."
 )
 @click.option('-v', '--verbose', is_flag=True, default=False, help="Show debug logging.")

cloudflare_ddns/app.py

@@ -1,6 +1,7 @@
 import logging
 import threading
 from dataclasses import dataclass
+from signal import SIGINT, SIGTERM, signal
 from typing import List
 
 import requests
@@ -46,9 +47,14 @@ class ApplicationJob(threading.Thread):
         self.raw_domains = raw_domains
         self.raw_delay = raw_delay
 
+        self.session = requests.session()
+
     def launch(self) -> None:
         """Launch the application by validating arguments and starting the thread."""
         self.validate_arguments()
+        log.debug("Registering exit hooks.")
+        signal(SIGINT, self.exit)
+        signal(SIGTERM, self.exit)
         log.debug("Starting job.")
         self.start()
 
@@ -87,9 +93,9 @@ class ApplicationJob(threading.Thread):
         for record in self.domains:
             log.debug(f"Updating record for {record.domain}.")
 
-            check_status(requests.patch(
+            check_status(self.session.patch(
                 PATCH_DNS.format(zone_identifier=record.zone, identifier=record.id),
-                json={"content": get_ip(record.record_type == 'AAAA')},
+                json={"content": get_ip(record.record_type == 'AAAA', self.session)},
                 auth=self.auth
             ))
 
@@ -99,8 +105,8 @@ class ApplicationJob(threading.Thread):
         """Parse the domain in `raw_domains` and populate the `domains` array with `Domain` objects."""
         found_domains = {}
 
-        for zone_json in check_status(requests.get(LIST_ZONES, auth=self.auth)).json()["result"]:
-            for record_json in check_status(requests.get(
+        for zone_json in check_status(self.session.get(LIST_ZONES, auth=self.auth)).json()["result"]:
+            for record_json in check_status(self.session.get(
                     LIST_DNS.format(zone_identifier=zone_json["id"]),
                     auth=self.auth
             )).json()["result"]:
@@ -108,7 +114,7 @@ class ApplicationJob(threading.Thread):
                     domain = Domain(
                         record_json["name"],
                         record_json["type"],
-                        record_json["zone_id"],
+                        zone_json["id"],
                         record_json["id"]
                     )
                     found_domains[f'{record_json["name"]}-{record_json["type"]}'] = domain
@@ -186,8 +192,14 @@ class ApplicationJob(threading.Thread):
 
     def validate_bearer(self) -> None:
         """Utility method to validate a CF bearer token."""
-        r = requests.get(VERIFY_TOKEN, auth=self.auth)
+        r = self.session.get(VERIFY_TOKEN, auth=self.auth)
 
         if not r.json()["success"]:
             error_message = ' / '.join(error["message"] for error in r.json()["errors"])
             raise ValueError(error_message)
+
+    def exit(self, *_) -> None:
+        """Gracefully exit the application."""
+        log.info("Exiting application.")
+        self.stop_signal.set()
+        self.join()

cloudflare_ddns/utils.py

@@ -54,9 +54,9 @@ class BearerAuth(AuthBase):
         return r
 
 
-def get_ip(ipv6: bool) -> str:
+def get_ip(ipv6: bool, session: requests.Session) -> str:
     """Return the host public IP as detected by ipify.org."""
-    r = check_status(requests.get(IP_API_URL_IPV4 if not ipv6 else IP_API_URL_IPV6))
+    r = check_status(session.get(IP_API_URL_IPV4 if not ipv6 else IP_API_URL_IPV6))
     return r.text
 
 

docker-compose.yaml

@@ -1,5 +1,4 @@
 ## Development docker-compose
-version: "3.7"
 services:
   cloudflare-ddns:
     build:

renovate.json

@@ -0,0 +1,9 @@
+{
+      "$schema": "https://docs.renovatebot.com/renovate-schema.json",
+      
+      "forkProcessing": "enabled",
+
+      "ignorePaths": [
+            ".github"
+      ]
+}

requirements-dev.txt

@@ -1,9 +1,9 @@
-flake8~=3.8.4
-flake8-annotations~=2.4.1
-flake8-bugbear~=20.1.4
-flake8-docstrings~=1.5.0
+flake8~=7.1.0
+flake8-annotations~=3.1.1
+flake8-bugbear~=24.12.12
+flake8-docstrings~=1.7.0
 flake8-import-order~=0.18.1
 flake8-string-format~=0.3.0
-flake8-tidy-imports~=4.1.0
+flake8-tidy-imports~=4.11.0
 flake8-todo~=0.7
-pep8-naming~=0.11.1
+pep8-naming~=0.14.1

requirements.txt

@@ -1,2 +1,9 @@
-requests~=2.25.1
-click8~=8.0.1
+certifi==2025.1.31
+chardet==5.2.0
+charset-normalizer==3.4.1
+click==8.1.8
+colorama==0.4.6
+idna==3.10
+python-dotenv==1.1.0
+requests==2.32.3
+urllib3==2.3.0