From 1604ce953d10d8d23b1202751912388443770d9b Mon Sep 17 00:00:00 2001 From: TVanteeffelen Date: Tue, 2 Jun 2026 22:07:49 -0400 Subject: [PATCH] Update README.md --- README.md | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d8afd11..8c1a825 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,36 @@ # Hostinger-DDNS -A small piece of software for dynamically updating a DNS record for a Hostinger hosted domain. \ No newline at end of file +A small piece of software for dynamically updating a DNS record for a Hostinger hosted domain. + +--- + +## Environment Variables + +The following environment variables must be defined in your `.env` file: + +- **DOMAIN** + The domain you want to check and/or modify. + +- **SUBDOMAIN** + The subdomain you want to check and/or modify. + +- **DNS_RECORD_TYPE** + The type of record you want to change. + +- **TOKEN** + Your Hostinger token. + +--- + +## Docker Compose example + +``` +services: + hostinger-ddns: + build: . + container_name: hostinger-ddns + restart: unless-stopped + environment: + DOMAIN: ${DOMAIN} + HOSTINGER_TOKEN: ${HOSTINGER_TOKEN} +``` \ No newline at end of file