Skip to content

Commit

Permalink
Release 2.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ezeholz authored Nov 16, 2020
1 parent 41c07d1 commit 4aef4cc
Show file tree
Hide file tree
Showing 24 changed files with 2,236 additions and 3,116 deletions.
6 changes: 6 additions & 0 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
Thank you for contributing.
We're trying to keep the module up to date and we're adding new features everytime.
Your contribution help us so much in a lot of ways.

We ask you to keep contributing, and feel free to open as many issues and PR as you need.
Also, we encourage you to stick into the templates prepared for every issue, because that could give us a rough idea of what's going wrong.
75 changes: 75 additions & 0 deletions .github/ISSUE_TEMPLATE/Bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,75 @@
---
name: Bug Report
about: Think you found a bug? Let us know!
title: ''
labels: bug, to check
assignees: ''

---

<!--
If you publish this issue, you accept that you made your own tests, and this is 100% a bug.
You should have the steps to being able to reproduce this bug, for us to check if it's truly a bug.
Also, you accept that, if this issue it's invalid in any way, will be discarded without receiving any response about it.
If you're not sure if it's a bug, please fill the question template.
You can now erase this warning, and complete the steps below. Cheers :D
-->

## Bug Report

|Questions||
|---|---|
|**MagicMirror version?**| |
|**How do you install MM?**| |
|**MMM-Remote-Control version?**| |
|**How do you install Remote Control?**| |
|**Did you try using just Remote Control alone with MM?**| |
|**If you did, were you able to reproduce the bug?**| |

### Description

<!-- Short explanation of what you were going to do, what did you want to accomplish? -->

### Expected behavior

<!-- What should actually happen? -->

### Current behavior

<!-- What happened instead? -->

### Possible solution

<!-- You can suggest a reason for the bug, if know about it. -->

```js
// Put fix over here, if you know how to fix it.
```

### Steps to reproduce

<!-- Please give details about how do you reach that behavior -->

### Log

```text
Paste the log you're getting, and possibly the error, over here.
Please, be sure that none of your personal information, such as IP or passwords are exposed.
```

### config.js

```js
/* Paste here your config.js file.
Make sure that none of your personal data is present, specially check for:
- IPs from MM instance, or the ones that are whitelisted. Please, replace them with *** so we're totally sure that you have set them.
- API keys, Tokens from different modules, URL to private calendars.
- Directions or Personal data. */
```
### Additional info

<!-- Everything else that you think could be useful for us. ;D -->
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/Feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Feature Request
about: Could be a nice addition? Feel free to post!
title: ''
labels: feature, to check
assignees: ''

---

<!--
So you have a nice feature you want in the module? Nice! Feel free to let us know.
Please, make sure that your feature it's not in the PRs waiting to merge, or inside the develop branch.
You can now erase this warning, and complete the steps below. Cheers :D
-->

## Feature Request

### Description

<!--- Tell us more about your desire feature. Why do you feel that this should be implemented? --->

### Changelog

<!--- Could you know which files are needed to change in order to make it work? --->

### Requirements

<!--- Do you know what's gonna need your feature to get implemented? --->

### Additional info

<!-- Everything else that you think could be useful for us. ;D -->
56 changes: 56 additions & 0 deletions .github/ISSUE_TEMPLATE/Question.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
---
name: Question
about: You don't know how to do it? Ask the community!
title: ''
labels: question
assignees: ''

---

<!--
Keep in mind that poorly formulated questions could lead to your question never answer, and the issue closed.
Feel free to explain the problem you're having, and the community will help you.
You can now erase this warning, and complete the steps below. Cheers :D
-->

## I have a problem

|Questions||
|---|---|
|**MagicMirror version?**| |
|**How do you install MM?**| |
|**MMM-Remote-Control version?**| |
|**How do you install Remote Control?**| |
|**Did you try using just Remote Control alone with MM?**| |
|**If you did, were you able to reproduce the bug?**| |

### Description

<!-- Explain what's going on. What do you need help for? -->

### Steps to reproduce

<!-- Please give details about how do you reach the problem you're having -->

### Log

```text
Paste the log you're getting, and possibly the error, over here.
Please, be sure that none of your personal information, such as IP or passwords are exposed.
```

### config.js

```js
/* Paste here your config.js file.
Make sure that none of your personal data is present, specially check for:
- IPs from MM instance, or the ones that are whitelisted. Please, replace them with *** so we're totally sure that you have set them.
- API keys, Tokens from different modules, URL to private calendars.
- Directions or Personal data. */
```
### Additional info

<!-- Everything else that you think could be useful for us. ;D -->
35 changes: 35 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/Bug_fixes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
---
name: Bug Fixes
about: Think you could fix a bug? PR now!
title: ''
labels: bug, to check
assignees: ''

---

<!--
If you publish this PR, you accept that you made your own tests, and that the program not only works, but also fixes the issue.
You should have the steps to being able to reproduce this bug, for us to check if it's truly a bug.
Please commit your contribution into the develop branch. Will be change if you don't do it.
Also, you accept that, if this Pull Request it's invalid in any way, will be discarded without receiving any response about it.
If you're not sure if it's a bug, please fill the question template on the issues templates.
You can now erase this warning, and complete the steps below. Cheers :D
-->

## Bug Fix

Fixes #
Fixes #
Fixes #

<!--- You should link every issue that's fixed with this PR --->

### Steps to reproduce

<!-- Please give details about how do you reach that behavior -->

### Additional info

<!-- Everything else that you think could be useful for us. ;D -->
34 changes: 34 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE/Feature_addition.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
name: Feature Addition
about: Could be a nice addition? Feel free to develop!
title: ''
labels: feature, to check
assignees: ''

---

<!--
So you have a nice feature you want in the module? Nice! Feel free to let us know.
Please, make sure that your feature it's not inside the develop branch already.
Please commit your contribution into the develop branch. Will be change if you don't do it.
You can now erase this warning, and complete the steps below. Cheers :D
-->

## Feature Addition

### Description

<!--- Tell us more about your desire feature. Why do you feel that this should be implemented? --->

### Changelog

<!--- Could you know which files are needed to change in order to make it work? --->

### Requirements

<!--- Do you know what's gonna need your feature to get implemented? --->

### Additional info

<!-- Everything else that you think could be useful for us. ;D -->
17 changes: 17 additions & 0 deletions .github/stale.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
# Number of days of inactivity before an issue becomes stale
daysUntilStale: 60
# Number of days of inactivity before a stale issue is closed
daysUntilClose: 7
# Issues with these labels will never be considered stale
exemptLabels:
- working
- help wanted
# Label to use when marking an issue as stale
staleLabel: stale
# Comment to post when marking an issue as stale. Set to `false` to disable
markComment: >
This issue has been automatically marked as stale because it has not had
recent activity. It will be closed if no further activity occurs. Thank you
for your contributions.
# Comment to post when closing a stale issue. Set to `false` to disable
closeComment: false
22 changes: 20 additions & 2 deletions API/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ The MMM-Remote-Control Module for MagicMirror² implements a RESTful(-ish) API t

This expansion was developed by [shbatm](https://github.com/shbatm) using [juzim's MMM-Api](https://github.com/juzim/MMM-Api) and of-course, [jopyth's MMM-Remote-Control](https://github.com/jopyth/MMM-Remote-Control).

Modified by [ezeholz](https://github.com/ezeholz) in the 2.2.0+, in the efford of making a more simplified version for everyone to use it.

## Overview

This extension exposes the `/api` URL from your MagicMirror² installation. Just like using the regular MMM-Remote-Control module, make sure your configuration listens on more than just `localhost`.
Expand Down Expand Up @@ -80,6 +82,22 @@ $ curl -X POST http://magicmirrorip:8080/api/module/alert/showalert \

***For convenience, the remainder of the examples omit the API Key***

## Secure Endpoints
Since 2.2.0, and in a way to prevent malicious actions on your mirror, a new config was added. This config allow you to, in case you don't use an apikey or never use the API at all, prevent some endpoints to work without an apikey.
As usual, this option can be disabled, but this will expose your Mirror to potentials hackers, so it's up to you to turn it off.

```js
{
module: 'MMM-Remote-Control'
config: {
secureEndpoints: true
}
},
```

By default, secureEndpoints it's true, defending commands like shutdown or install modules when no apikey it's present.
Setting secureEndpoints to false allow every endpoint to be reachable externally, even without an apikey. (Just like the old times)

## Methods

There are three general categories of API commands:
Expand All @@ -98,9 +116,9 @@ There are three general categories of API commands:

The majority of MMM-Remote-Control's abilities are extended to the API (this is a fundamental reason for "extending" this module instead of creating a new one for the API).

[Review the API documentation on Postman here](https://documenter.getpostman.com/view/6167403/Rzfni66c)
Review the API documentation online [here](https://ezeholz.github.io/MMM-Remote-Control/)

The Postman [collection file](API/postman_collection.json) is also included in the repo if you want to load it and test calls on your machine.
Or check it in your own installation using http://ip-of-your-mirror:8080/api/docs

### 2. External APIs (Guessed)

Expand Down
Loading

0 comments on commit 4aef4cc

Please sign in to comment.