https://github.com/ItayXD/MMM-Admin-Interface
An interface to manage the magic mirror
https://github.com/ItayXD/MMM-Admin-Interface
Last synced: 9 months ago
JSON representation
An interface to manage the magic mirror
- Host: GitHub
- URL: https://github.com/ItayXD/MMM-Admin-Interface
- Owner: ItayXD
- License: gpl-3.0
- Created: 2016-12-17T16:46:51.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2018-07-07T22:07:25.000Z (almost 8 years ago)
- Last Synced: 2025-01-05T02:02:19.200Z (over 1 year ago)
- Language: JavaScript
- Size: 102 KB
- Stars: 45
- Watchers: 4
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-mmm - **MMM-Admin-Interface**
README
# Magic-Mirror-Module-Admin-Interface
This an extension for the [MagicMirror²](https://github.com/MichMich/MagicMirror). This module provides an interface to manage the magic mirror and edit the configuration from your web browser.
## Installation
1. Navigate into your MagicMirror's `modules` folder and run:
```
git clone https://github.com/ItayXD/MMM-Admin-Interface.git
```
1. Install the dependencies:
```
cd MMM-Admin-Interface && npm install --only=production
```
1. Add the module to you `config.js`:
```
{
"module": "MMM-Admin-Interface"
},
```
1. Whitelist the devices you want to access the mirror's settings from.
If you want to whitelist all devices on your local network add:
```
ipWhitelist: [""127.0.0.1", "::ffff:127.0.0.1", "::1", 192.168.X.1/24 , ::ffff:192.168.X.1/24"],
```
Make sure you replace `X` with the correct number! you can find it by running `ifconfig` in your mirror.
## Usage
1. Go to `:8080/MMM-Admin-Interface/`
1. Edit away!
## Sending settings schema for other modules (DEVS)
You can send your module's config schema via notification, and it will be loaded.
```javascript
let calender_schema = {
"properties": {"modules": {"items": {"config": {"properties": {
"calendars": {
"format": "tabs",
"options": {
"disable_array_delete_all_rows": true,
"disable_array_delete_last_row": true
},
"type": "array",
"items": {
"type": "object",
"headerTemplate": "Calender {{ i1 }}",
"properties": {
"symbol": {
"type": "string"
},
"url": {
"type": "string"
}
}
}
}}}}}}
}
this.sendNotification ( "schema", calender_schema );
```
You can learn more on writing a settings schema for you module at [JSON Editor](https://github.com/jdorn/json-editor).
## Changlelog
### 0.1
- Cleaning up all console.log dev calls
- Improved front-end
- Improved README
### 0.0.2
- Reading and writing directly to config.js
- Accept settings schemas from other modules via notification
### 0.0.1 Initial commit