forked from Mirrors/cloudflare-ddns-docker
Updated to current python ver. Learning how to make a container.
This commit is contained in:
@ -1,4 +1,4 @@
|
|||||||
FROM python:3.9-slim
|
FROM python:3.12-slim
|
||||||
|
|
||||||
WORKDIR /app
|
WORKDIR /app
|
||||||
|
|
||||||
|
36
README.md
36
README.md
@ -10,9 +10,12 @@ to match your local IP address.
|
|||||||
|
|
||||||
# Table of Content
|
# Table of Content
|
||||||
|
|
||||||
|
- [Cloudflare DDNS](#cloudflare-ddns)
|
||||||
|
- [Table of Content](#table-of-content)
|
||||||
- [Installation](#installation)
|
- [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)
|
||||||
@ -24,25 +27,50 @@ to match your local IP address.
|
|||||||
|
|
||||||
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:
|
||||||
|
BIN
requirements.txt
BIN
requirements.txt
Binary file not shown.
Reference in New Issue
Block a user