> For the complete documentation index, see [llms.txt](https://atomescrochus.gitbook.io/doddns/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://atomescrochus.gitbook.io/doddns/master.md).

# Welcome to DODDNS

Welcome to the DODDNS documentation

## What is DODDNS

It is a small utility to use Digital Ocean as a Dynamic DNS (DDNS) service, built with [Laravel Zero](https://github.com/laravel-zero/laravel-zero). It'll regularly check your current IP address and update a selected Digital Ocean domain record with it, if the address changed.

## Requirements

* PHP >= 7.1.3 and Composer installed.
* A Digital Ocean [Personal Access Token](https://www.digitalocean.com/docs/api/create-personal-access-token/). that has the `read` and `write` permission.
* At least one domain name added to your account.
* At least a `cname` or an `A` record added to a domain that DODDNS will try to update.