Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docker examples #3

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docker examples #3

wants to merge 1 commit into from

Conversation

xeviff
Copy link

@xeviff xeviff commented Sep 22, 2021

Docker command and docker-compose examples to get it work on docker systems
Copy link
Owner

@Akarys42 Akarys42 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for the PR! I have some little nitpick here and there

cloudflare-ddns:
image: ghcr.io/akarys42/cloudflare-ddns-docker
container_name: ddns_client
enviroment:
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should instead be loading a .env file?

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tested using env_file: .env instead of environment: and works as intended. Just add a .env file to the same directory.

ref: env_file | Compose specification | Docker Documentation

-e CF_DDNS_TOKEN="${token}" \
-d ghcr.io/akarys42/cloudflare-ddns-docker
```
(replacing ${token} by your Cloudflare DNS Edit Permission Token)
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd use $TOKEN instead as it is the syntax for a shell variable

@@ -35,6 +35,38 @@ docker pull ghcr.io/akarys42/cloudflare-ddns-docker

There are no special requirements when building this container! Simply use `docker build` in this folder.

#### For docker command
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### For docker command
### Running on Docker

```
(replacing ${token} by your Cloudflare DNS Edit Permission Token)

#### For docker-compose users
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
#### For docker-compose users
### Running on Docker-compose

@Akarys42 Akarys42 linked an issue Sep 23, 2021 that may be closed by this pull request
@xeviff
Copy link
Author

xeviff commented Sep 23, 2021 via email

@Akarys42
Copy link
Owner

All good, I will take care of it. Thank you!

Copy link

@SyntaxEG SyntaxEG left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@xeviff other than the typos, this docker-compose.yml file works great. Thanks, super simple to setup 😊.

@Akarys42 I don't have time right now but I will take a shot at issue #2 sometime this week. thanks for the docker container, it helped get my homelab online easily.

cloudflare-ddns:
image: ghcr.io/akarys42/cloudflare-ddns-docker
container_name: ddns_client
enviroment:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: enviroment should be environment

cloudflare-ddns:
image: ghcr.io/akarys42/cloudflare-ddns-docker
container_name: ddns_client
enviroment:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: enviroment should be environment

cloudflare-ddns:
image: ghcr.io/akarys42/cloudflare-ddns-docker
container_name: ddns_client
enviroment:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tested using env_file: .env instead of environment: and works as intended. Just add a .env file to the same directory.

ref: env_file | Compose specification | Docker Documentation

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Just an example
3 participants