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
|
||||
|
||||
|
42
README.md
42
README.md
@ -10,39 +10,67 @@ to match your local IP address.
|
||||
|
||||
# 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)
|
||||
- [Building the Container Yourself](#building-the-container-yourself)
|
||||
- [Hosting](#hosting)
|
||||
- [Running on the Host](#running-on-the-host)
|
||||
- [Configuration](#configuration)
|
||||
- [Configuration](#configuration)
|
||||
- [Getting a Cloudflare Token](#getting-a-cloudflare-token)
|
||||
- [Supported Options](#supported-options)
|
||||
- [Contributing](#contributing)
|
||||
- [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.
|
||||
```
|
||||
docker pull ghcr.io/akarys42/cloudflare-ddns-docker
|
||||
```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 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
|
||||
|
||||
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.
|
||||
|
@ -1,5 +1,4 @@
|
||||
## Development docker-compose
|
||||
version: "3.7"
|
||||
services:
|
||||
cloudflare-ddns:
|
||||
build:
|
||||
|
BIN
requirements.txt
BIN
requirements.txt
Binary file not shown.
Reference in New Issue
Block a user