Skip to content

Commit

Permalink
disabled useless workflow, update description on dockerhub
Browse files Browse the repository at this point in the history
  • Loading branch information
digrouz committed Feb 5, 2024
1 parent 454f28e commit edfca05
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 27 deletions.
14 changes: 13 additions & 1 deletion .github/workflows/dockerhub.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ on:
workflow_dispatch:

jobs:
docker:
dockerHubImages:
runs-on: ubuntu-latest
steps:
-
Expand Down Expand Up @@ -41,3 +41,15 @@ jobs:
file: Dockerfile_alpine
push: true
tags: ${{ secrets.DOCKERHUB_USERNAME }}/ddclient:alpine
dockerHubDescription:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@main

- name: Docker Hub Description
uses: peter-evans/dockerhub-description@main
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
repository: ${{ secrets.DOCKERHUB_USERNAME }}/ddclient
short-description: ${{ github.event.repository.description }}
25 changes: 0 additions & 25 deletions .github/workflows/update-alpine.yml

This file was deleted.

7 changes: 6 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ https://sourceforge.net/p/ddclient/wiki/Home/
-e UID=<UID default:12345> \
-e GID=<GID default:12345> \
-e AUTOUPGRADE=<0|1 default:0> \
-e TZ=<timezone default:Europe/Brussels> \
-e DOCKMAIL=<mail address> \
-e DOCKRELAY=<smtp relay> \
-e DOCKMAILDOMAIN=<originating mail domain> \
Expand All @@ -47,6 +48,10 @@ This variable is not mandatory and specifies the group id that will be set to ru

This variable is not mandatory and specifies if the container has to launch software update at startup or not. Valid values are `0` and `1`. It has default value `0`.

### `TZ`

This variable is not mandatory and specifies the timezone to be configured within the container. It has default value `Europe/Brussels`.

### `DOCKRELAY`

This variable is not mandatory and specifies the smtp relay that will be used to send email. Do not specify any if mail notifications are not required.
Expand All @@ -60,7 +65,7 @@ This variable is not mandatory and specifies the mail that has to be used to sen
This variable is not mandatory and specifies the address where the mail appears to come from for user authentication. Do not specify any if mail notifications are not required.

## Notes

* This container is built using [s6-overlay](https://github.com/just-containers/s6-overlay)
* The docker entrypoint can upgrade operating system at each startup. To enable this feature, just add `-e AUTOUPGRADE=1` at container creation.

## Issues
Expand Down

0 comments on commit edfca05

Please sign in to comment.