Skip to content

Commit

Permalink
Add changes to changelog. Change documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
javierbrea committed Mar 2, 2019
1 parent 0661b4e commit 83c0ad5
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 6 deletions.
15 changes: 15 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,21 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
### Fixed
### Removed

## [1.0.0-beta.2] - 2019-03-02
### Added
- Add web ui
- Add socket.io server
- Emit events to socket authenticated users connected using sockets
- Add page and ability filters to logs api
- Add logs/stats api

### Fixed
- Add "anonymous" role to swagger. Now anomnymous user has anonymous role.
- Fix logs capped collection max size

### Changed
- Use validator library for emails and uri validations

## [1.0.0-beta.1] - 2019-01-08
### Added
- Add DELETE method to servicePluginConfigs api
Expand Down
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,11 +34,11 @@ Controller server for Domapic domotic systems.
Connect all your Domapic Modules and control them with a single application. <!-- and program them to interact automatically using the provided web interface
Install Domapic plugins to connect Domapic with other domotic systems or online services. -->

__NOTE: The next schema includes some Domapic pieces that are still not released. The web ui for the Controller, Domapic Cloud, mobile apps and Alexa plugins will be available soon.__
__NOTE: The next schema includes some Domapic pieces that are still not released. The Domapic Cloud plugin, mobile apps and Alexa plugin will be available soon.__

![Domapic system example][domapic-example-image]

> Above, an example of two modules in a [Domapic System][website-url]. Now, the relay can be controlled using the web or mobile applications, or interacting with ["Alexa"][alexa-url] or ["HomeKit"][homekit-url]. Automatisms can be configured in the [Domapic Controller Web UI][domapic-controller-url] to make the [_Phillips Hue_][hue-url] bulb be switched off automatically when the relay bulb is switched on, for example.
> Above, an example of two modules in a [Domapic System][website-url]. Now, the relay can be controlled using the web or mobile applications, or interacting with ["Alexa"][alexa-url] or ["HomeKit"][homekit-url]. _Automatisms can be configured in the [Domapic Controller Web UI][domapic-controller-url] to make the [_Phillips Hue_][hue-url] bulb be switched off automatically when the relay bulb is switched on, for example. (Automatisms feature is still in development)_
## Prerequisites

Expand All @@ -62,9 +62,11 @@ npm i domapic-controller -g --production
domapic-controller start
```

The controller process will be started at background (using [PM2][pm2-url] as manager). Now you can browse to [http://localhost:3000](http://localhost:3000) to check that the server has started successfully. A __Swagger UI__ describing the server api will be available at that url.
The controller process will be started at background (using [PM2][pm2-url] as manager). Now you can browse to [http://localhost:3000](http://localhost:3000) to check that the server has started successfully.

![Swagger example][swagger-example-image]
The Domapic Controller Web User interface will be available at that url. If you are loading the web interface from localhost, login is not necessary because authentication is disabled by default for the 172.0.0.1 IP. If not, use the "admin" user with "admin" password. Remember to add your own administrator user and delete the default one.

![Swagger example][domapic-controller-ui-example-image]

> Note that, with basic options, server will be started over `http` protocol, and security will be disabled for localhost requests. Read about all [options](#options) and [security](#security) to start the controller with stricter security options.
Expand Down Expand Up @@ -161,7 +163,9 @@ Follow the next steps to securize your Controller before exposing it to the inte

* __Setup an administrator user:__

> The Controller is distributed with a default administrator user, which name is "admin", and password is "admin". Delete it and setup your own administrator user:
> The Controller is distributed with a default administrator user, which name is "admin", and password is "admin". Delete it and setup your own administrator user.

You can use both the web user interface or the command line interface in order to remove the user:

```
domapic-controller user remove admin
Expand All @@ -188,7 +192,7 @@ Follow the next steps to securize your Controller before exposing it to the inte

[domapic-logo-image]: http://domapic.com/assets/domapic-logo.png
[domapic-example-image]: http://domapic.com/assets/domapic-schema-example_01.png
[swagger-example-image]: http://domapic.com/assets/swagger-example.jpg
[domapic-controller-ui-example-image]: http://domapic.com/assets/domapic-controller-ui-screenshots.jpg

[coveralls-image]: https://coveralls.io/repos/github/domapic/domapic-controller/badge.svg
[coveralls-url]: https://coveralls.io/github/domapic/domapic-controller
Expand Down

0 comments on commit 83c0ad5

Please sign in to comment.