https://github.com/d1ceward/scaleway-ddns
Simple Scaleway dynamic DNS service using API
https://github.com/d1ceward/scaleway-ddns
api crystal ddns scaleway
Last synced: 2 months ago
JSON representation
Simple Scaleway dynamic DNS service using API
- Host: GitHub
- URL: https://github.com/d1ceward/scaleway-ddns
- Owner: d1ceward
- License: mit
- Created: 2022-08-18T01:52:38.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2025-02-09T00:13:47.000Z (4 months ago)
- Last Synced: 2025-02-09T01:23:22.078Z (4 months ago)
- Topics: api, crystal, ddns, scaleway
- Language: Crystal
- Homepage: https://d1ceward.github.io/scaleway-ddns/
- Size: 190 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# scaleway-ddns (v1.11.0)
[](https://hub.docker.com/r/d1ceward/scaleway-ddns)
[](https://github.com/d1ceward/scaleway-ddns/issues)
[](https://github.com/d1ceward/scaleway-ddns/blob/master/LICENSE)
Simple Scaleway dynamic DNS service by API written in Crystal.
:rocket: Suggestions for new improvements are welcome in the issue tracker.
## Installation and Usage
### Docker
With `docker run` command :
```shell
docker run -d \
-e SCW_SECRET_KEY="super-secret-from-scaleway" \
-e IDLE_MINUTES="10" \
-e DOMAIN_LIST="myfirstdomain.com,anotherone.com" \
d1ceward/scaleway-ddns:latest
```
With docker-compose file :
```yaml
---
services:
scaleway_ddns:
image: d1ceward/scaleway-ddns:latest
restart: unless-stopped
environment:
- SCW_SECRET_KEY=super-secret-from-scaleway
- IDLE_MINUTES=10
- DOMAIN_LIST=myfirstdomain.com,anotherone.com
```
### Linux
Download the executable file :
```shell
wget --no-verbose -O scaleway-ddns https://github.com/d1ceward/scaleway-ddns/releases/download/v1.11.0/scaleway-ddns-linux-amd64
```
Modify the executable's permissions :
```shell
chmod +x scaleway-ddns
```
Execution example :
```shell
scaleway-ddns run
```
Documentation available here : https://d1ceward.github.io/scaleway-ddns/
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/d1ceward/scaleway-ddns. By contributing you agree to abide by the Code of Merit.
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Development building and running
1. Install corresponding version of Crystal lang (cf: `.crystal-version` file)
2. Install Crystal dependencies with `shards install`
3. Build with `shards build`
The newly created binary should be at `bin/scaleway-ddns`
### Running tests
```shell
crystal spec
```
## Contributors
- [d1ceward](https://github.com/d1ceward) - creator and maintainer