ionos-dynamic-dns/README.md
Julian Lobbes 450090ceb5 feat: add .gitignore, requirements and basic README
- added basic instructions on how to make the API key accessible to the
  scripts
2022-09-02 21:38:40 +02:00

27 lines
617 B
Markdown

# Ionos DNS updates
A set of scripts used to make dynamic DNS updates to the Ionos API.
### Dependencies
Python libraries:
- [requests](https://pypi.org/project/requests/)
- [pyyaml](https://pypi.org/project/PyYAML/)
### Initial setup
Install the [dependencies](#dependencies), preferrably using your system's package manager.
Next, you will need your Ionos API keypair.
Clone the repo and create a file called `apikey.yml` at the project root.
Inside the file, paste your Ionos API-keypair in the following format:
```yaml
---
apikey:
prefix: <your api key prefix>
secret: <your api key secret>
...
```