|
1 |
| -<p align="center"> |
2 |
| - <img title="Laravel Zero" height="100" src="https://raw.githubusercontent.com/laravel-zero/docs/master/images/logo/laravel-zero-readme.png" /> |
3 |
| -</p> |
| 1 | +# doddns |
4 | 2 |
|
5 |
| -<p align="center"> |
6 |
| - <a href="https://travis-ci.org/laravel-zero/framework"><img src="https://img.shields.io/travis/laravel-zero/framework/stable.svg" alt="Build Status"></img></a> |
7 |
| - <a href="https://scrutinizer-ci.com/g/laravel-zero/framework"><img src="https://img.shields.io/scrutinizer/g/laravel-zero/framework.svg" alt="Quality Score"></img></a> |
8 |
| - <a href="https://packagist.org/packages/laravel-zero/framework"><img src="https://poser.pugx.org/laravel-zero/framework/d/total.svg" alt="Total Downloads"></a> |
9 |
| - <a href="https://packagist.org/packages/laravel-zero/framework"><img src="https://poser.pugx.org/laravel-zero/framework/v/stable.svg" alt="Latest Stable Version"></a> |
10 |
| - <a href="https://packagist.org/packages/laravel-zero/framework"><img src="https://poser.pugx.org/laravel-zero/framework/license.svg" alt="License"></a> |
11 |
| -</p> |
| 3 | +A small PHP thigny to use one's domain added to Digital Ocean as a dynamic dns service make with [Laravel Zero](https://github.com/laravel-zero/laravel-zero). |
12 | 4 |
|
13 |
| -<h4> <center>This is a <bold>community project</bold> and not an official Laravel one </center></h4> |
| 5 | +## What is needed |
14 | 6 |
|
15 |
| -Laravel Zero was created by, and is maintained by [Nuno Maduro](https://github.com/nunomaduro), and is a micro-framework that provides an elegant starting point for your console application. It is an **unofficial** and customized version of Laravel optimized for building command-line applications. |
| 7 | +- A Digital Ocean [Personal Access Token](https://www.digitalocean.com/docs/api/create-personal-access-token/). |
| 8 | +- Some domains added to your account. |
| 9 | +- A `cname` or `A` records added to a domain for us to update. |
16 | 10 |
|
17 |
| -- Built on top of the [Laravel](https://laravel.com) components. |
18 |
| -- Optional installation of Laravel [Eloquent](http://laravel-zero.com/#/?id=database), Laravel [Logging](http://laravel-zero.com/#/?id=log) and many others. |
19 |
| -- Supports interactive [menus](http://laravel-zero.com/#/?id=interactive-menus) and [desktop notifications](http://laravel-zero.com/#/?id=desktop-notifications) on Linux, Windows & MacOS. |
20 |
| -- Ships with a [Scheduler](http://laravel-zero.com/#/?id=scheduler) and a [Standalone Compiler](http://laravel-zero.com/#/?id=build-a-standalone-application). |
21 |
| -- Integration with [Collision](https://github.com/nunomaduro/collision) - Beautiful error reporting |
| 11 | +## How to use |
22 | 12 |
|
23 |
| ------- |
| 13 | +Depending on your mood, you can either [download the compiled version](https://github.com/jpmurray/doddns/raw/master/builds/doddns) or [build it yourself](https://laravel-zero.com/#/usage?id=building-a-standalone-application), then add it to your `$PATH` and run the setup command... And you're good to go! |
24 | 14 |
|
25 |
| -## Documentation |
| 15 | +### Cron |
| 16 | +If you want doddns to autoupdate with your current IP address, you should add an ntry to your cron tab like so: `* * * * * php /path-to-doddns/doddns schedule:run >> /dev/null 2>&1`. |
26 | 17 |
|
27 |
| -For full documentation, visit [laravel-zero.com](http://laravel-zero.com/). |
| 18 | +After that, doddns will try to update every hours by itself. |
28 | 19 |
|
29 |
| -## Support the development |
30 |
| -**Do you like this project? Support it by donating** |
| 20 | +### Available commands |
31 | 21 |
|
32 |
| -- PayPal: [Donate](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=66BYDWAT92N6L) |
33 |
| -- Patreon: [Donate](https://www.patreon.com/nunomaduro) |
| 22 | +You can then use the `doddns` command to see a list of possible actions: |
34 | 23 |
|
35 |
| -## License |
36 |
| - |
37 |
| -Laravel Zero is an open-source software licensed under the [MIT license](https://github.com/laravel-zero/laravel-zero/blob/stable/LICENSE.md). |
| 24 | +- `doddns setup`: will create local database and asks for DO personal acces token. |
| 25 | +- `doddns set-token {token}`: will set your DO personal access token, overwriting any existing value. |
| 26 | +- `doddns records:list`: list any added record that doddns tries to update. |
| 27 | +- `doddns records:add`: add a record to update to the database from exiting DO domains. |
| 28 | +- `doddns records:remove`: removes a record from doddns' database. |
| 29 | +- `doddns records:update`: updates records in database with actual IP. |
0 commit comments