mirror of
https://github.com/Akarys42/cloudflare-ddns-docker.git
synced 2025-05-12 09:35:16 -06:00
Compare commits
5 Commits
main
...
08589b5074
Author | SHA1 | Date | |
---|---|---|---|
08589b5074 | |||
0743d7fa6d | |||
6ac289ccf1 | |||
fa8d5c1c61 | |||
bbc042a642 |
@ -1,4 +1,4 @@
|
|||||||
FROM python:3.9-slim
|
FROM python:3.12-slim
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
|
42
README.md
42
README.md
@ -10,39 +10,67 @@ to match your local IP address.
|
|||||||
|
|
||||||
# Table of Content
|
# Table of Content
|
||||||
|
|
||||||
- [Installation](#installation)
|
- [Cloudflare DDNS](#cloudflare-ddns)
|
||||||
|
- [Table of Content](#table-of-content)
|
||||||
|
- [Installation](#installation)
|
||||||
- [Using a Pre-built Container](#using-a-pre-built-container)
|
- [Using a Pre-built Container](#using-a-pre-built-container)
|
||||||
- [Building the Container Yourself](#building-the-container-yourself)
|
- [Building the Container Yourself](#building-the-container-yourself)
|
||||||
|
- [Hosting](#hosting)
|
||||||
- [Running on the Host](#running-on-the-host)
|
- [Running on the Host](#running-on-the-host)
|
||||||
- [Configuration](#configuration)
|
- [Configuration](#configuration)
|
||||||
- [Getting a Cloudflare Token](#getting-a-cloudflare-token)
|
- [Getting a Cloudflare Token](#getting-a-cloudflare-token)
|
||||||
- [Supported Options](#supported-options)
|
- [Supported Options](#supported-options)
|
||||||
- [Contributing](#contributing)
|
- [Contributing](#contributing)
|
||||||
|
|
||||||
|
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
While this project is intended to be ran as a Docker container, it can also be ran on the host directly.
|
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
|
### Using a Pre-built Container
|
||||||
|
|
||||||
This project is available on the GitHub Container Registry.
|
This project is available on the GitHub Container Registry.
|
||||||
```
|
```shell
|
||||||
docker pull ghcr.io/akarys42/cloudflare-ddns-docker
|
docker pull git.home.timatlee.com/timatlee/cloudflare-ddns:latest
|
||||||
```
|
```
|
||||||
|
|
||||||
### Building the Container Yourself
|
### Building the Container Yourself
|
||||||
|
|
||||||
There are no special requirements when building this container! Simply use `docker build` in this folder.
|
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
|
### 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
|
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 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`.
|
The project can then by launched by running the `cloudflare_ddns` module, usually using `python -m cloudflare_ddns`.
|
||||||
|
|
||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
This project will accept parameters through environment variables or command line argument.
|
This project will accept parameters through environment variables or command line argument.
|
||||||
|
@ -1,5 +1,4 @@
|
|||||||
## Development docker-compose
|
## Development docker-compose
|
||||||
version: "3.7"
|
|
||||||
services:
|
services:
|
||||||
cloudflare-ddns:
|
cloudflare-ddns:
|
||||||
build:
|
build:
|
||||||
|
5
renovate.json
Normal file
5
renovate.json
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
{
|
||||||
|
"$schema": "https://docs.renovatebot.com/renovate-schema.json",
|
||||||
|
|
||||||
|
"includeForks": true
|
||||||
|
}
|
@ -1,5 +1,5 @@
|
|||||||
flake8~=3.8.4
|
flake8~=3.8.4
|
||||||
flake8-annotations~=2.4.1
|
flake8-annotations~=3.1.1
|
||||||
flake8-bugbear~=20.1.4
|
flake8-bugbear~=20.1.4
|
||||||
flake8-docstrings~=1.5.0
|
flake8-docstrings~=1.5.0
|
||||||
flake8-import-order~=0.18.1
|
flake8-import-order~=0.18.1
|
||||||
|
@ -1,2 +1,8 @@
|
|||||||
requests~=2.25.1
|
certifi==2024.6.2
|
||||||
click8~=8.0.1
|
chardet==4.0.0
|
||||||
|
charset-normalizer==3.3.2
|
||||||
|
click==8.1.0
|
||||||
|
colorama==0.4.6
|
||||||
|
idna==2.10
|
||||||
|
requests==2.32.3
|
||||||
|
urllib3==1.26.18
|
||||||
|
Reference in New Issue
Block a user