Merge pull request #1 from azrod/devel

ADD new doc and Breaking change config file format

.github/workflows/dev.yaml

@@ -0,0 +1,25 @@
+---
+name: build on push dev
+
+on:
+  push:
+    branches:
+      - "devel"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Set image tag
+        run: |
+          TAG="dev"
+          echo "TAG=${TAG}" >> $GITHUB_ENV
+      - name: create and push an image
+        run: >
+          buildah unshare bash ./build.sh
+          ${{ env.TAG }}
+          ${{ secrets.REGISTRY_USERNAME }}
+          ${{ secrets.REGISTRY_PASSWORD }}

.github/workflows/release.yml

@@ -0,0 +1,38 @@
+---
+name: build on release
+
+on:
+  release:
+    types: # This configuration does not affect the page_build event above
+      - created
+
+jobs:
+  page:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: actions/setup-python@v2
+        with:
+          python-version: 3.x
+      - run: pip install mkdocs-material
+
+      - run: mkdocs gh-deploy --force
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        with:
+          fetch-depth: 0
+      - name: Get latest release version number
+        id: get_version
+        uses: battila7/get-version-action@v2
+      - name: Set image tag
+        run: |
+          TAG="${{ steps.get_version.outputs.version }}"
+          echo "TAG=${TAG}" >> $GITHUB_ENV
+      - name: create and push an image
+        run: >
+          buildah unshare bash ./build.sh
+          ${{ env.TAG }}
+          ${{ secrets.REGISTRY_USERNAME }}
+          ${{ secrets.REGISTRY_PASSWORD }}

README.md

@@ -2,6 +2,12 @@
 
 UpdateIP is a automatic update of a DNS record based on the External IP address
 
+Actual supported DNS providers:
+
+* Amazon Route 53
+* Cloudflare
+* OVH (Warning: Is not tested)
+
 ## How to setup
 
 ### **From Docker Run**
@@ -48,36 +54,37 @@ metrics:
   host: 0.0.0.0 # Default: 0.0.0.0
   path: /metrics # Default: /metrics
 
-aws_account:
-  enable: true
-  secret:
-    access_key_id: "xxx"
-    secret_access_key: "xxx"
-    region: "eu-west-1"
-  record:
-    name: "subdomain.domain.com"
-    ttl: 60
-    domain: "domain.com"
-
-ovh_account:
-  enable: true
-  secret:
-    application_key: "xxx"
-    application_secret: "xxx"
-    consumer_key: "xxx"
-    region: "eu-west-1"
-  record:
-    name: "subdomain.domain.com"
-    ttl: 60
-    zone: "domain.com"
-
-cloudflare_account:
-  enable: true
-  secret:
-    api_key: "xxx"
-    email: "xxx"
-  record:
-    name: "subdomain.domain.com"
-    ttl: 60
-    domain: "domain.com"
+providers:
+  aws_account:
+    enable: true
+    secret:
+      access_key_id: "xxx"
+      secret_access_key: "xxx"
+      region: "eu-west-1"
+    record:
+      name: "subdomain.domain.com"
+      ttl: 60
+      domain: "domain.com"
+
+  ovh_account:
+    enable: true
+    secret:
+      application_key: "xxx"
+      application_secret: "xxx"
+      consumer_key: "xxx"
+      region: "eu-west-1"
+    record:
+      name: "subdomain.domain.com"
+      ttl: 60
+      zone: "domain.com"
+
+  cloudflare_account:
+    enable: true
+    secret:
+      api_key: "xxx"
+      email: "xxx"
+    record:
+      name: "subdomain.domain.com"
+      ttl: 60
+      domain: "domain.com"
 ```