Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion configuration/autostart.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Add the following lines:

```shell
cd ./MagicMirror
DISPLAY=:0 npm start
DISPLAY=:0 npm run start
```

Save and close, using the commands `CTRL-O` and `CTRL-X`. Now make sure the
Expand Down
12 changes: 6 additions & 6 deletions configuration/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,23 +84,23 @@ By default, you would use config.js with a bash script (mm.sh):

```bash
cd ~/MagicMirror
npm start
npm run start
```

To use the 2nd configuration file, use a bash script like this (mm2.sh):

```bash
cd ~/MagicMirror
export MM_CONFIG_FILE=config/config2.js
npm start
npm run start
```

To change the port:

```bash
cd ~/MagicMirror
export MM_PORT=8081
npm start
npm run start
```

You can run `npm run config:check` on your 2nd configuration file by typing the
Expand Down Expand Up @@ -182,7 +182,7 @@ cd ~/MagicMirror
export MY_ADDRESS=localhost
export MY_PORT=8080
export MY_HTTPS=false
npm start
npm run start
```

### Using `electronOptions`
Expand Down Expand Up @@ -217,15 +217,15 @@ Starting Script 1 (mm.sh):

```bash
cd ~/MagicMirror
npm start
npm run start
```

Starting Script 2 (mm2.sh):

```bash
cd ~/MagicMirror
export MM_CONFIG_FILE=config/config2.js
npm start
npm run start
```

Configuration file 1 (config.js):
Expand Down
8 changes: 1 addition & 7 deletions cspell.config.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,13 +33,7 @@
"yourprovider"
],
"ignorePaths": [
"node_modules/**",
"modules/**",
"vendor/node_modules/**",
"translations/**",
"tests/mocks/**",
"tests/e2e/modules/clock_es_spec.js",
"fonts/roboto.css"
"node_modules/**"
],
"dictionaries": ["node"]
}
12 changes: 6 additions & 6 deletions development/core-module-file.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,15 +127,15 @@ The getScripts method is called to request any additional scripts that need to
be loaded. This method should therefore return an array with strings. If you
want to return a full path to a file in the module folder, use the
`this.file('filename.js')` method. In all cases the loader will only load a file
once. It even checks if the file is available in the default vendor folder.
once. It even checks the files defined in `js/vendor.js`.

**Example:**

```javascript
getScripts: function() {
return [
'script.js', // will try to load it from the vendor folder, otherwise it will load is from the module folder.
'moment.js', // this file is available in the vendor folder, so it doesn't need to be available in the module folder.
'script.js', // will try to load it from the files defined in `js/vendor.js`, otherwise it will load it from the module folder.
'moment.js', // this file is defined in `js/vendor.js`, so it doesn't need to be available in the module folder.
this.file('another_file.js'), // this file will be loaded straight from the module folder.
'https://code.jquery.com/jquery-2.2.3.min.js', // this file will be loaded from the jquery servers.
]
Expand All @@ -154,15 +154,15 @@ The getStyles method is called to request any additional stylesheets that need
to be loaded. This method should therefore return an array with strings. If you
want to return a full path to a file in the module folder, use the
`this.file('filename.css')` method. In all cases the loader will only load a
file once. It even checks if the file is available in the default vendor folder.
file once. It even checks the files defined in `js/vendor.js`.

**Example:**

```javascript
getStyles: function() {
return [
'script.css', // will try to load it from the vendor folder, otherwise it will load is from the module folder.
'font-awesome.css', // this file is available in the vendor folder, so it doesn't need to be available in the module folder.
'script.css', // will try to load it from the files defined in `js/vendor.js`, otherwise it will load it from the module folder.
'font-awesome.css', // this file is defined in `js/vendor.js`, so it doesn't need to be available in the module folder.
this.file('another_file.css'), // this file will be loaded straight from the module folder.
'https://maxcdn.bootstrapcdn.com/bootstrap/3.3.6/css/bootstrap.min.css', // this file will be loaded from the bootstrap cdn servers.
]
Expand Down
47 changes: 14 additions & 33 deletions getting-started/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,43 +78,12 @@ team. Use these scripts and methods at your own risk.
- We also publish the latest version of MagicMirror to the
[npm-registry](https://www.npmjs.com/package/magicmirror).

## Other Operating Systems

### Windows

::: warning IMPORTANT

MagicMirror² is designed to run on Linux. But with an extra step in the
installation process and a different start command, you can also run it on
Windows. Some third-party modules may not work on Windows.

:::

To get the software running on Windows, you have to do two things in addition to
the [steps](#manual-installation) above:

**After step 5:** Install dependencies in the vendor and font directories:

Powershell:

1. `cd fonts; npm install; cd ..`
2. `cd vendor; npm install; cd ..`

Command Prompt:

1. `cd fonts && npm install && cd ..`
2. `cd vendor && npm install && cd ..`

Otherwise the screen will stay black when starting the software.

**Step 7:** In Windows you must use `npm start:windows` instead of `npm start`.

## Usage

Note the following:

- `npm start` does **not** work via SSH. But you can use
`DISPLAY=:0 nohup npm start &` instead. \
- `npm run start` does **not** work via SSH. But you can use
`DISPLAY=:0 nohup npm run start &` instead. \
This starts the mirror on the remote display.
- If you want to debug on your Raspberry Pi you can use `npm run start:dev`
which will start MM with _Dev Tools_ enabled.
Expand Down Expand Up @@ -160,3 +129,15 @@ port number of the server)

If you use Wayland. Run `npm run start:wayland` instead of `npm run start` to
start.

### Windows

::: warning IMPORTANT

MagicMirror² is designed to run on Linux. But with a different start command,
you can also run it on Windows. Some third-party modules may not work on Windows.

:::

In Windows you must use `npm run start:windows` instead of
`npm run start`.
4 changes: 2 additions & 2 deletions modules/compliments.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,11 +31,11 @@ modules: [
The following properties can be configured:

| Option | Description |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --- |
| --------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `updateInterval` | How often does the compliment have to change? (Milliseconds) <br><br> **Possible values:** `1000` - `86400000` <br> **Default value:** `30000` (30 seconds) |
| `fadeSpeed` | Speed of the update animation. (Milliseconds) <br><br> **Possible values:**`0` - `5000` <br> **Default value:** `4000` (4 seconds) |
| `compliments` | The list of compliments. <br><br> **Possible values:** An object with four arrays: `morning`, `afternoon`, `evening` and `anytime`. See _compliment configuration_ below. <br> **Default value:** See _compliment configuration_ below. |
| `remoteFile` | External file from which to load the compliments <br><br> **Possible values:** Path or URL (starting with `http://` or `https://`) to a JSON file containing compliments, configured as per the value of the _compliments configuration_ (see below). An json object {} with at least one of the arrays: `morning`, `afternoon`, `evening`, `anytime`, `datetype` and/or `crontype`. - `compliments.json` <br> **Default value:** `null` (Do not load from file) | |
| `remoteFile` | External file from which to load the compliments <br><br> **Possible values:** Path or URL (starting with `http://` or `https://`) to a JSON file containing compliments, configured as per the value of the _compliments configuration_ (see below). An json object {} with at least one of the arrays: `morning`, `afternoon`, `evening`, `anytime`, `datetype` and/or `crontype`. - `compliments.json` <br> **Default value:** `null` (Do not load from file) |
| `remoteFileRefreshInterval` | How often to reload the remote file, if remoteFile is specified. in ms <br> **Default value:** 0 <br> **Minimum value:** 15 minutes (15\*60\*60\*1000) |
| `classes` | Override the CSS classes of the div showing the compliments <br><br> **Default value:** `thin xlarge bright` |
| `morningStartTime` | Time in hours (in 24 format), after which the mode of "morning" will begin <br> **Possible values:** `0` - `24` <br><br> **Default value:** `3` |
Expand Down
Loading