Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/domapic/cloud-domapic-plugin
Plugin for connecting Controllers to Domapic Cloud
https://github.com/domapic/cloud-domapic-plugin
api-key cloud domapic domapic-controller domapic-plugin domotic dynamic-ip framework home-automation iot iot-platform jwt oauth opensource plugin raspberry-pi remote-control webhooks
Last synced: about 1 month ago
JSON representation
Plugin for connecting Controllers to Domapic Cloud
- Host: GitHub
- URL: https://github.com/domapic/cloud-domapic-plugin
- Owner: domapic
- License: mit
- Created: 2019-04-28T15:54:42.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2019-05-02T14:34:18.000Z (over 5 years ago)
- Last Synced: 2024-10-14T09:28:03.980Z (3 months ago)
- Topics: api-key, cloud, domapic, domapic-controller, domapic-plugin, domotic, dynamic-ip, framework, home-automation, iot, iot-platform, jwt, oauth, opensource, plugin, raspberry-pi, remote-control, webhooks
- Language: JavaScript
- Homepage: https://www.domapic.com
- Size: 318 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Cloud Domapic Plugin
> Domapic Plugin that connects Domapic Controller with [Domapic Cloud service][domapic-cloud-url], making possible to control it remotely through the online app.
[![Build status][travisci-image]][travisci-url] [![js-standard-style][standard-image]][standard-url]
[![NPM dependencies][npm-dependencies-image]][npm-dependencies-url] [![Last commit][last-commit-image]][last-commit-url]
[![NPM downloads][npm-downloads-image]][npm-downloads-url] [![License][license-image]][license-url]
## Intro
The Cloud Domapic Plugin sends information about your Controller current public IP to the [Domapic Cloud Service][domapic-cloud-url] and maintains it up to date. It also retrieves information about your registered users, allowing them to login through the online app using Google Oauth.
It does not send passwords or any other sensible information about Controller users. It creates a new api key token for each registered user, and send this one among with the user email. Users can register by their self in the Domapic Cloud Service or sign in using Google Oauth, and then the Controller will appear in their list of authorized Servers. The specific permissions for the user in the Controller will be kept.
Once your Controller is synced with the Domapic Cloud Service using this plugin, each time you add a new user he will receive an email notification from Domapic Cloud, informing him about how to access.
## Installation
```bash
npm i cloud-domapic-plugin -g
```
## Usage
```bash
cloud-domapic-plugin start --controller=http://localhost:3000 --controllerApiKey=your-controller-api-key --cloudApiKey=your-cloud.domapic.com-api-key --save
```
The plugin will be started in background using [pm2][pm2-url].
To display logs, type:
```bash
cloud-domapic-plugin logs #--lines=300
```
> For further info about all available commands, please read the [domapic service][domapic-service-url] documentation.
## Options
The plugin, apart of all common [domapic services options][domapic-service-options-url], provides custom options for configuring the connection with Domapic Cloud and your Controller's public url:
* `cloudApiKey` - Domapic Cloud server apiKey. You'll get it when you add your Controller to the Domapic Cloud application.
* `customPort` - If your Controller is accessed from the internet through a different port than in the local area network, use this option to specify it.
* `customUrl` - If you have a custom domain for accessing your Controller, you can define here the full url, including port. Is specified, the plugin will send this value instead of the public IP.
[coveralls-image]: https://coveralls.io/repos/github/domapic/cloud-domapic-plugin/badge.svg
[coveralls-url]: https://coveralls.io/github/domapic/cloud-domapic-plugin
[travisci-image]: https://travis-ci.com/domapic/cloud-domapic-plugin.svg?branch=master
[travisci-url]: https://travis-ci.com/domapic/cloud-domapic-plugin
[last-commit-image]: https://img.shields.io/github/last-commit/domapic/cloud-domapic-plugin.svg
[last-commit-url]: https://github.com/domapic/cloud-domapic-plugin/commits
[license-image]: https://img.shields.io/npm/l/cloud-domapic-plugin.svg
[license-url]: https://github.com/domapic/cloud-domapic-plugin/blob/master/LICENSE
[npm-downloads-image]: https://img.shields.io/npm/dm/cloud-domapic-plugin.svg
[npm-downloads-url]: https://www.npmjs.com/package/cloud-domapic-plugin
[npm-dependencies-image]: https://img.shields.io/david/domapic/cloud-domapic-plugin.svg
[npm-dependencies-url]: https://david-dm.org/domapic/cloud-domapic-plugin
[quality-gate-image]: https://sonarcloud.io/api/project_badges/measure?project=cloud-domapic-plugin&metric=alert_status
[quality-gate-url]: https://sonarcloud.io/dashboard?id=cloud-domapic-plugin
[release-image]: https://img.shields.io/github/release-date/domapic/cloud-domapic-plugin.svg
[release-url]: https://github.com/domapic/cloud-domapic-plugin/releases
[standard-image]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
[standard-url]: http://standardjs.com/
[domapic-cloud-url]: https://cloud.domapic.com/
[domapic-service-options-url]: https://github.com/domapic/domapic-service#options
[domapic-service-url]: https://github.com/domapic/domapic-service
[pm2-url]: http://pm2.keymetrics.io/