docs: add apikey.yml
example and explanation
This commit is contained in:
parent
7b8cd520ef
commit
cf06da54e7
3 changed files with 13 additions and 2 deletions
2
.gitignore
vendored
2
.gitignore
vendored
|
@ -1,3 +1,5 @@
|
|||
.venv
|
||||
**/__pycache__
|
||||
|
||||
apikey.yml
|
||||
domains.json
|
||||
|
|
|
@ -13,8 +13,8 @@ Python libraries:
|
|||
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:
|
||||
Clone the repo and edit the file `apikey.yml`.
|
||||
Inside the file, paste the respective value of your Ionos API-keypair, following this format:
|
||||
|
||||
```yaml
|
||||
---
|
||||
|
@ -26,6 +26,8 @@ apikey:
|
|||
...
|
||||
```
|
||||
|
||||
This file **must be kept secret**.
|
||||
|
||||
### Adding target domains
|
||||
|
||||
Add every domain you want to send an update for to the file `domains.json`.
|
||||
|
|
7
apikey.yml
Normal file
7
apikey.yml
Normal file
|
@ -0,0 +1,7 @@
|
|||
---
|
||||
|
||||
apikey:
|
||||
prefix: <your api key prefix>
|
||||
secret: <your api key secret>
|
||||
|
||||
...
|
Loading…
Add table
Reference in a new issue