Added README.md and some small changes
This commit is contained in:
53
README.md
Normal file
53
README.md
Normal file
@@ -0,0 +1,53 @@
|
||||
# DDNS
|
||||
|
||||
_DDNS_ is a dynamic DNS helper for Digital Ocean users to utilize their DO account as a Dynamic DNS resolver.
|
||||
|
||||
## Installation
|
||||
|
||||
Copy the ```ddns.py``` file to e.g. ```/usr/local/bin``` folder and run ```chmod +x``` to make it executable. You can remove the .py filending if you wish.
|
||||
|
||||
Run ```pip3 install -r requirements.txt``` to install all requirements the app needs.
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
For instructions run ```bash
|
||||
ddns -h
|
||||
```
|
||||
|
||||
The program is best suited to be executed with e.g cron or any other system that can run at intervals. To run the app every 6 hours with cron add the following line to your crontab
|
||||
|
||||
```bash
|
||||
0 */6 * * * /usr/local/bin/ddns
|
||||
```
|
||||
|
||||
## Contributing
|
||||
|
||||
Pull requests are welcome. For major changes, please open an issue first
|
||||
to discuss what you would like to change.
|
||||
|
||||
## License
|
||||
|
||||
MIT License
|
||||
|
||||
Copyright (c) [2023] [Rune Olsen]
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
SOFTWARE.
|
||||
|
||||
[MIT](https://choosealicense.com/licenses/mit/)
|
Reference in New Issue
Block a user