Updated README

This commit is contained in:
timothymiller 2020-08-05 03:45:48 -04:00
parent de9cf97708
commit 568b7b5ce3

View File

@ -45,7 +45,7 @@ Alternatively, you can use the traditional API keys by setting appropriate value
## :fax: Hosting multiple domains on the same IP? ## :fax: Hosting multiple domains on the same IP?
You can save yourself some trouble when hosting multiple domains pointing to the same IP address (in the case of Traefik) by defining one A & AAAA record 'ddns.example.com' pointing to the IP of the server that will be updated by this DDNS script. For each subdomain, create a CNAME record pointing to 'ddns.example.com'. Now you don't have to manually modify the script config every time you add a new subdomain to your site! You can save yourself some trouble when hosting multiple domains pointing to the same IP address (in the case of Traefik) by defining one A & AAAA record 'ddns.example.com' pointing to the IP of the server that will be updated by this DDNS script. For each subdomain, create a CNAME record pointing to 'ddns.example.com'. Now you don't have to manually modify the script config every time you add a new subdomain to your site!
## Deploy to Docker ## :whale: Deploy to Docker
Create a config.json file with your production credentials and run the build-docker-image script. Create a config.json file with your production credentials and run the build-docker-image script.
@ -55,15 +55,11 @@ chmod +x ./build-docker-image.sh
docker run -d timothymiller/cloudflare_ddns:latest docker run -d timothymiller/cloudflare_ddns:latest
``` ```
## (Legacy) :running: Running ### :running: (legacy) Running
This script requires Python 3.5+, which comes preinstalled on the latest version of Raspbian. Download/clone this repo and give permission to the project's bash script by running `chmod +x ./start-sync.sh`. Now you can execute `./start-sync.sh`, which will set up a virtualenv, pull in any dependencies, and fire the script. This script requires Python 3.5+, which comes preinstalled on the latest version of Raspbian. Download/clone this repo and give permission to the project's bash script by running `chmod +x ./start-sync.sh`. Now you can execute `./start-sync.sh`, which will set up a virtualenv, pull in any dependencies, and fire the script.
## :alarm_clock: Scheduling ## :penguin: (legacy) Linux + cron instructions (all distros)
This script was written with the intention of cron managing it.
## :penguin: Linux instructions (all distros)
1. Upload the cloudflare-ddns folder to your home directory /home/your_username_here/ 1. Upload the cloudflare-ddns folder to your home directory /home/your_username_here/