> 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/installation.md).

# Installation

## How to install

Using composer, you will need to run the following command to install DODDNS into the global space:

```
composer global require jpmurray/doddns
```

For DODDNS to work correctly you will have to make sure composer is added to your system's `$PATH`. You can test it by typing `doddns` in your terminal of choice: if it is installed correctly, you should be seeing commands usage instructions.

Next, you will have to add your DigitalOcean API token with the `token:add` command and then select which record you want to update with the `record:select` command.

Once it's done, you're good to go!

## Schedule IP updates

If you want DODDNS to update your selected domain record automatically with your current IP address, you will have to add entry to your cron tab like so: `* * * * * php /path-to-doddns/doddns schedule:run >> /dev/null 2>&1`.

After that, DODDNS will try to update every hours by itself.

## Updating DODDNS

**Version 3.0.0 and after**

Version 3.0.0 changed a lot in term of workflow. If you install DODDNS from before `3.0.0`, it is suggested that you remove the `doddns` folder entirely from the `.config` folder located in your home directory then start back from scratch so everything is clean.

**Before 3.0.0**

If you've pulled or downloaded a new version, be sure to run `doddns setup` and choose the upgrade option to make sure your local database is up to date! You can also forgo the menu to upgrade directly using `doddns setup -U`.