{"id":20408010,"url":"https://github.com/heapy/ddns-fullstack","last_synced_at":"2026-03-07T02:08:16.602Z","repository":{"id":97726727,"uuid":"583145785","full_name":"Heapy/ddns-fullstack","owner":"Heapy","description":"Personal DDNS client and server with DigitalOcean as backend","archived":false,"fork":false,"pushed_at":"2025-03-11T19:55:00.000Z","size":494,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-06T06:22:19.851Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Heapy.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"patreon":"heapyhop"}},"created_at":"2022-12-28T22:48:37.000Z","updated_at":"2025-03-11T19:55:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"65c15a2e-ccfc-4e41-a1a1-ec41870af419","html_url":"https://github.com/Heapy/ddns-fullstack","commit_stats":{"total_commits":14,"total_committers":1,"mean_commits":14.0,"dds":0.0,"last_synced_commit":"c6485f3bcd02c3abf2a8a4c9ef746f2752f0608a"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Heapy%2Fddns-fullstack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Heapy%2Fddns-fullstack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Heapy%2Fddns-fullstack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Heapy%2Fddns-fullstack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Heapy","download_url":"https://codeload.github.com/Heapy/ddns-fullstack/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248586338,"owners_count":21129021,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-15T05:27:30.403Z","updated_at":"2026-03-07T02:08:11.552Z","avatar_url":"https://github.com/Heapy.png","language":"Kotlin","funding_links":["https://patreon.com/heapyhop"],"categories":[],"sub_categories":[],"readme":"# DDNS FullStack\n\nSimple client-server DDNS setup for personal use.\n\n![Diagram](./docs/Fullstack%20DDNS.png)\n\n## Prerequisites\n\n1. Server with static public IP address or domain name, i.e `ddns.bar.com`\n2. Domain used with DigitalOcean DNS, i.e `bar.com`\n3. DigitalOcean API token (Obtain a token using the API section in DigitalOcean UI)\n4. Home router with public, but dynamic IP (This project is not [a tunneling solution](https://github.com/anderspitman/awesome-tunneling))\n\n## Server Configuration\n\n| Parameter | Default | Required | Description                                                                          |\n|-----------|---------|----------|--------------------------------------------------------------------------------------|\n| MODE      | client  | true     | Describes mode in which application running, set to `server` to run as IP server     |\n| HEADER    | none    | false    | Defines which header will contain IP value. Otherwise IP from request will be taken. |\n| PORT      | 8080    | false    | Port on which application will be listening                                          |\n| HOST      | 0.0.0.0 | false    | Host on which application will be listening                                          |\n\n## Client Configuration\n\n| Parameter               | Default | Required | Description                                                                                |\n|-------------------------|---------|----------|--------------------------------------------------------------------------------------------|\n| MODE                    | client  | false    | Describes mode in which application running, omit or set to `client` to run as DNS updater |\n| SERVER_URL              | none    | true     | URL to endpoint that returns IP                                                            |\n| CHECK_PERIOD            | 5m      | false    | Period of time between checks for IP change                                                |\n| REQUEST_TIMEOUT         | 30s     | false    | Timeout for request to server                                                              |\n| ATTEMPTS_BEFORE_WARNING | 5       | false    | Number of attempts to make before warning about failed request                             |\n\n### Digitalocean DNS\n\n| Parameter                | Default | Required | Description                                           |\n|--------------------------|---------|----------|-------------------------------------------------------|\n| DIGITALOCEAN_TOKEN       | none    | true     | Token to access DigitalOcean API                      |\n| DIGITALOCEAN_DOMAIN_NAME | none    | true     | Domain name to update, example: `bar.com`             |\n| DIGITALOCEAN_SUBDOMAIN   | none    | true     | Subdomain to update, example: `foo` (for foo.bar.com) |\n\n### Cloudflare DNS\n\n| Parameter              | Default | Required | Description                                   |\n|------------------------|---------|----------|-----------------------------------------------|\n| CLOUDFLARE_TOKEN       | none    | true     | Token to access Cloudflare API                |\n| CLOUDFLARE_DOMAIN_NAME | none    | true     | Domain name to update, example: `foo.bar.com` |\n| CLOUDFLARE_ZONE_ID     | none    | true     | Cloudflare Zone Id                            |\n\n### Telegram channel for notifications\n\nSet `TELEGRAM_TOKEN` and `TELEGRAM_CHAT_ID` environment variables to enable notifications about IP changes and warning.\n\n| Parameter        | Default | Required | Description                                                                                                                |\n|------------------|---------|----------|----------------------------------------------------------------------------------------------------------------------------|\n| TELEGRAM_TOKEN   | none    | true     | Token to access Telegram API. Obtain an token using [@BotFather](https://t.me/BotFather)                                   |\n| TELEGRAM_CHAT_ID | none    | true     | Chat ID to send messages to, start bot, and check https://api.telegram.org/bot[TELEGRAM_TOKEN]/getUpdates to obtain chat.  |\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheapy%2Fddns-fullstack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fheapy%2Fddns-fullstack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fheapy%2Fddns-fullstack/lists"}