Skip to content

Latest commit

 

History

History
54 lines (36 loc) · 3.84 KB

installation.md

File metadata and controls

54 lines (36 loc) · 3.84 KB
Raw

Azure set-up

  1. Sign in to the Azure portal and create an App Registration for the daemon. Give it a descriptive name (I used ddns-daemon) and leave all other settings at their default values, then click Register.

    This process wil generate a unique Application (client) ID and a Directory (tenant) ID, which should be displayed on the resulting blade. Save these values for later, you'll need them to successfully configure your daemon.

    In addition to these values, you'll need an App secret to complete the setup process.

  2. From the left-hand menu, click the Certificates & secrets menu option.

  3. On the resulting screen, open the Client secrets tab, then select + New client secret.

    My recommendation is to set the Description field to a value that will indiciate the physical location of the installation of your daemon, but you should pick one that is meaningful to you in the event you need to invalidate it in the future. Set an appropriate Expiration (as of this writing, the longest secret expiration period you can select is 2 years from the current date).

    Once you've got all that, click the Add button. The new client secret should be displayed in the table - copy this for use later when configuring your daemon.

You've now created your service principal, but now you need to grant it access to make changes to your Azure DNS configuration.

  1. Open the DNS Zone resource you're looking to target with the script in the Azure Portal, then navigate to its Access control blade. In the Access control blade, click + Add → Add role assignment.

  2. Pick the DNS Zone Contributor role, then select the Next button.

    Note: For those operating with a more strict security posture, you might want to evaluate the permissions that this role provides and instead create a custom role with a "least-privilege"-conformant role. If that applies to you, consider adding a custom role to your subscription based on the JSON provided in dns-record-contributor.json and selecting that role instead.

  3. On the resulting screen, click the + Select members link; from the resulting blade, search for and select the service principal you created in Step 1. Click the Review + assign button.

  4. Using the authentication information generated in steps 1 and 3 above, complete the empty fields in the example.env file. Re-name the file to .env. Finally, provide values for each of the other configuration parameters as necessary in your installation.

  5. Run node ./dns-daemon.js --dry-run to test your configuration and ensure that you don't get any unexpected errors with your current configuration. Rinse and repeat until the output matches your expectation.

Docker Compose

Create a docker-compose.yml file in the form below, being sure to add the environment variables as labeled:

version: "3"
services:
    azure-dynamic-dns:
        image: esqew/azure-dynamic-dns
        container_name: azure-dynamic-dns
    environment:
        - AZURE_SUBSCRIPTION_ID=
        - TENANT_ID=
        - CLIENT_ID=
        - CLIENT_SECRET=
        - CRON_REFRESH_INTERVAL=0 * * * *
        - RESOURCE_GROUP_NAME=
        - ZONE_NAME=
        - RELATIVE_RECORD_SET_NAME=
        - RECORD_TYPE=

Docker Run

Alternatively to the Docker Compose configuration above, you can use docker run to get the same effect:

docker run -e AZURE_SUBSCRIPTION_ID="" -e TENANT_ID="" -e CLIENT_ID="" -e CLIENT_SECRET="" -e CRON_REFRESH_INTERVAL="0 * * * *" -e RESOURCE_GROUP_NAME="" -e ZONE_NAME="" -e RELATIVE_RECORD_SET="" -e RECORD_TYPE="" esqew/azure-dynamic-dns

... being sure to replace the blank strings with the appropriate environment variable values.