Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tilfin/gc-ddns

Dynamic DNS API Service for Google Cloud
https://github.com/tilfin/gc-ddns

dynamic-dns-solution google-cloud

Last synced: about 2 months ago
JSON representation

Dynamic DNS API Service for Google Cloud

Awesome Lists containing this project

README

        

gc-ddns
=======

Dynamic DNS API Service for Google Cloud

This is a hub service to connect dynamic IP address endpoint as a home network at any time.
Your DNS record on Google Cloud is updated by posting this service from Home PC periodically.

## Environment

Node.js 4.3 or Later

## Configuration
Edit _config/local.yml_

```
config:
app:
apiKey:
googleCloud:
project:
authKeyJsonFile:
dns:
zone:
domain:
```

- _authKeyJsonFile_ is provided by authentication page at Google Cloud Console.

## Setup and Start API service

```
$ git clone [email protected]:tilfin/gc-ddns.git
$ cd gc-ddns
$ npm install
$ node app.js
```

## How to update A/AAAA record

### Linux/OS X

```
$ curl -X POST \
-d 'host=&ip=&key=&ttl=' \
http://localhost:8080/records
```

### Windows PowerShell

```
PS > Invoke-RestMethod http://localhost:8080/records `
-Method POST `
-Body "host=&ip=&key=&ttl=" `
```

- Service port is config.app.port (default 8080)
- Default TTL is config.ttl
- Specify request source host IP address if _ip_ is not specified
- Recommend to access API Service via HTTPS (using nginx as a reverse proxy)