Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ibizaman/godaddyip
Maintains A and CNAME records matching current ip in Godaddy.
https://github.com/ibizaman/godaddyip
arecord cname godaddy-ddns python3
Last synced: 2 months ago
JSON representation
Maintains A and CNAME records matching current ip in Godaddy.
- Host: GitHub
- URL: https://github.com/ibizaman/godaddyip
- Owner: ibizaman
- Created: 2018-06-04T05:47:32.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-05-23T14:45:22.000Z (8 months ago)
- Last Synced: 2024-09-25T16:50:05.947Z (3 months ago)
- Topics: arecord, cname, godaddy-ddns, python3
- Language: Python
- Size: 21.5 KB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Godaddy IP
Maintains A and CNAME records matching current ip in Godaddy.
## Install
```
pip install godaddyip
```
This installs a script called `godaddyip`.
## Example use case
With the following configuration file, the daemon will maintain one A
record named `my.domain.com` to the ip of the server the daemon is
running on. It will also maintain two CNAME records
`www.my.domain.com` and `mail.my.domain.com` to `my.domain.com`.
```yaml
arecord: my
key: mygodaddykey
secret: mygodaddysecret
domain: domain.com
cnames:
- www
- mail
```
## Configuration
Configuration files are searched in one of the following
locations. Last configuration file found takes precendence.
* `/etc/godaddyip/godaddyip.yaml`
* `~/.config/godaddyip/godaddyip.yaml`
* `./config/godaddyip.yaml`
You can override the above list of searched paths by giving the
`--config_files=path[,path,...]` argument.
Adding or removing rules to a configuration file is done by using the
`configure` argument:
```
godaddyip arecord ARECORD
godaddyip key KEY
godaddyip secret SECRET
godaddyip domain DOMAIN
godaddyip add-cname CNAME
godaddyip del-cname CNAME
```
## Run
Running the daemon is done by using the `run` argument:
```
godaddyip run [--config_files CONFIG_FILES]
```
Example output:
```
$ python -m godaddyip run --config_files test.yaml
Current ip: "100.99.98.97"
Previous ip: "None"
Sleeping for 5 minutes.
Current ip: "100.99.98.97"
Previous ip: "100.99.98.97"
Same ip as previous one, nothing to do
Sleeping for 5 minutes.
```
## Using systemd
The daemon can start when the system starts by creating a systemd unit
file like the following one in
`/etc/systemd/system/godaddyip.service`.
```
[Unit]
Description=Godaddy ip service
After=network.target
[Service]
User=godaddyip
Group=godaddyip
ExecStart=/usr/bin/godaddyip run
ExecReload=/bin/kill -s usr1 $MAINPID
[Install]
WantedBy=default.target
```
I advice running the daemon with a non-root user. A system user can be
created with `useradd --system godaddyip`.
# Unit tests
To run unit tests locally do the following:
- `python3 -m venv --upgrade-deps /tmp/tg`
- `/tmp/tg/bin/python godaddyip/tests.py -v`