Update README.md

This commit is contained in:
Tanner Van Teeffelen 2026-06-02 22:07:49 -04:00
parent 6021d6e1b0
commit 1604ce953d

View file

@ -1,3 +1,36 @@
# Hostinger-DDNS
A small piece of software for dynamically updating a DNS record for a Hostinger hosted domain.
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}
```