Initial Commit

Author: dchidell

Dockerfile

@@ -0,0 +1,11 @@
+FROM python:alpine as base
+
+FROM base as build
+COPY requirements.txt .
+RUN pip install --prefix=/install -r requirements.txt
+
+FROM base
+COPY --from=build /install /usr/local
+ADD *.py ./
+ENTRYPOINT ["python3"]
+CMD ["-u","app.py"]

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 David Chidell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -1,2 +1,65 @@
 # traefik-cloudflare-updater
-Updates CloudFlare with traefik configuration
+
+Instead of using a wildcard DNS record, create records dynamically using this.
+
+Only works with traefikv2 configuration, look at the above repo for v1 support.
+
+When you run the container, it'll update all the DNS records it can find, afterward it will sit and wait for any new traefik enabled containers to start and then updtae them. If this container restarts, it'll re-update everything.
+
+Idea taken from the following GitHub repo: https://github.com/tiredofit/docker-traefik-cloudflare-companion
+
+
+ ## Why write this, and not use the above repo?
+
+I didn't like the following things (just my preference):
+* No updating of existing records
+* No exclusions
+* Python 2
+* Stuff not needed for the operation of this service within the container
+* Bash and python mix
+
+What I did like:
+* The general idea, wildcard domains are not nice
+* The fact it's at least in python
+* The elegant usage of docker events to update new containers
+  
+## Usage
+Example `docker-compose.yml` service:
+
+```yml
+dnsupdater:
+image: dchidell/traefik-cloudflare-updater
+restart: unless-stopped
+volumes:
+- /var/run/docker.sock:/var/run/docker.sock:ro
+environment:
+- [email protected]
+- CF_TOKEN=1234567890
+- TARGET_DOMAIN=example.com
+- DOMAIN1=mydomain1.com
+- DOMAIN1_ZONE_ID=1234567890
+- DOMAIN2=mydomain2.com
+- DOMAIN2_ZONE_ID=1234567890
+- EXCLUDED_DOMAINS=static.mydomain1.com,test.mydomain2.com
+```
+
+
+### Mandatory ENV vars:
+
+`TARGET_DOMAIN` - a CNAME will be created pointing to this target
+
+`CF_EMAIL` - CloudFlare API Email
+
+`CF_TOKEN` - CloudFlare API Token
+
+`DOMAIN#` - Multiple of these per domain, e.g. `DOMAIN1=example.com`, `DOMAIN2=example.net` ... `DOMAINn=example.org`
+
+`DOMAIN#_ZONE_ID` - CloudFlare zone ID for domain index.
+
+
+
+### Optional ENV vars:
+
+`DOMAIN#_PROXIED` - Whether to use CloudFlare proxy. Should be 'TRUE' or 'FALSE' (not 1 or 0) (defaults to TRUE)
+
+`EXCLUDED_DOMAINS` - Comma separated domains to be excluded from updating (i.e. if you want to statically define something) e.g. `EXCLUDED_DOMAINS=sub.domain.com,sub2.domain.com`

TraefikUpdater.py

@@ -0,0 +1,99 @@
+import os
+import re
+import time
+import docker
+import CloudFlare
+
+__author__ = "David Chidell"
+
+class TraefikUpdater:
+    def __init__(self):
+        self.target_domain = os.environ['TARGET_DOMAIN']
+        excluded = os.environ.get('EXCLUDED_DOMAINS')
+        if excluded is None:
+            self.excluded_domains = []
+        else:
+            self.excluded_domains = excluded.split(',')
+
+        self.tld_info = {}
+        self.get_domain_vars()
+
+        self.host_pattern = re.compile('\`([a-zA-Z0-9\.]+)\`')
+
+        self.cf = CloudFlare.CloudFlare(email=os.environ['CF_EMAIL'] , token=os.environ['CF_TOKEN'])
+        self.dkr = docker.from_env()
+
+    def enter_update_loop(self):
+        print(f'Listening for new containers...')
+        t = int(time.time())
+        for event in self.dkr.events(since=t, filters={'status': 'start'}, decode=True):
+            if event.get('status') == 'start':
+                try:
+                    container = self.dkr.containers.get(event.get('id'))
+                except docker.errors.NotFound as e:
+                    pass
+                else:
+                    if container.labels.get("traefik.enable",'False').upper() == "TRUE":
+                        print(f'New container online: {container.name}, processing...')
+                        self.process_container(container)
+        
+    def process_containers(self):
+        containers = self.dkr.containers.list(filters={"status":"running","label":"traefik.enable=true"})
+        print(f'Found {len(containers)} existing containers to process')
+        for container in containers:
+            self.process_container(container)
+        print(f'Finished bulk updating containers!')
+
+    def process_container(self,container):
+        for label, value in container.labels.items():
+            if 'rule' in label and 'Host' in value:
+                domains = self.host_pattern.findall(value)
+                print(f'Found domains: {domains} for container: {container.name}')
+                for domain in domains:
+                    self.update_domain(domain)
+                                     
+    def update_domain(self,domain):
+        dom_split = domain.split('.')
+        if len(dom_split) >= 3:
+            tld = '.'.join(dom_split[1:])
+        else:
+            tld = domain
+
+        if self.tld_info.get(tld) is None:
+            print(f'TLD {tld} not in updatable list')
+            return False
+
+        dom_info = self.tld_info[tld]
+        common_dict = {i: dom_info[i] for i in ('type', 'content', 'proxied')}
+        post_dict = {**{'name':domain},**common_dict}
+        try:
+            get_records = self.cf.zones.dns_records.get(dom_info['zone'], params={'name':domain})
+            if len(get_records) == 0:
+                post_record = self.cf.zones.dns_records.post(dom_info['zone'], data=post_dict)
+                print(f'New record created: {domain}')
+            else:
+                for record in get_records:
+                    post_record = self.cf.zones.dns_records.put(dom_info['zone'], record['id'], data=post_dict)
+                    print(f'Existing record updated: {domain}')
+
+        except CloudFlare.exceptions.CloudFlareAPIError as e:
+            print(f'API call failed: {str(e)}')
+            return False
+        return True
+
+    def get_domain_vars(self):
+        tld_count = 0
+        self.tld_info = {}
+        while True:
+            tld_count += 1
+            try:
+                domain = os.environ[f'DOMAIN{tld_count}']
+                zone = os.environ[f'DOMAIN{tld_count}_ZONE_ID']
+                try:
+                    proxied = os.environ.get(f'DOMAIN{tld_count}_PROXIED',"TRUE").upper() == 'TRUE'
+                except KeyError:
+                    proxied = false
+                self.tld_info[domain] = {"zone":zone, "proxied":proxied, "type":"CNAME", "content":self.target_domain}
+            except KeyError:
+                break
+        print(f'Found {tld_count-1} TLDs! {self.tld_info}')

app.py

@@ -0,0 +1,14 @@
+#!/usr/bin/python
+
+import os
+from TraefikUpdater import TraefikUpdater
+
+def main():
+    updater = TraefikUpdater()
+    updater.process_containers()
+
+    # This blocks
+    updater.enter_update_loop()
+
+if __name__ == "__main__":
+    main()

requirements.txt

@@ -0,0 +1,2 @@
+docker
+cloudflare