Skip to content

Commit 351cf3e

Browse files
rejascrazyscotbugsounetKristjanESPERANTOWallysWellies
authored
Release v2.30 (#278)
* weather.md: update for recent changes (#230) * add updates feature configuration (#234) * Update calendar.md (#236) * updateOnFetch feature Docs (#235) * Minor changes (#238) * Minor changes - wording - Magic Mirror -> MagicMirror - format * sh -> shell * Update compliments docs page (#242) Add documentation for the specialDayUnique config option * Cleanup formatting (#247) * bump prettier * run prettier * UK Met Office Documentation Fix (#253) * Update weather.md Updated documentation for MetOffice update * Update weather.md * add doc for new compliments(#3481) and support custom positions (#3518) (#254) * add doc for new compliments(#3481) and support custom positions (#3518) * fix typo * update compliments, and module position info (#255) * add doc for new compliments(#3481) and support custom positions (#3518) * fix typo * Added docs for new notification `MODULE_DOM_UPDATED` (#262) * Bump send and express (#260) Bumps [send](https://github.com/pillarjs/send) and [express](https://github.com/expressjs/express). These dependencies needed to be updated together. Updates `send` from 0.18.0 to 0.19.0 - [Release notes](https://github.com/pillarjs/send/releases) - [Changelog](https://github.com/pillarjs/send/blob/master/HISTORY.md) - [Commits](pillarjs/send@0.18.0...0.19.0) Updates `express` from 4.20.0 to 4.21.0 - [Release notes](https://github.com/expressjs/express/releases) - [Changelog](https://github.com/expressjs/express/blob/4.21.0/History.md) - [Commits](expressjs/express@4.20.0...4.21.0) --- updated-dependencies: - dependency-name: send dependency-type: indirect - dependency-name: express dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Added docs for new notification - . Fixes #261 --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> * Update Windows section and add Wayland section (#265) According to the changes in PR MagicMirrorOrg/MagicMirror#3594. * add clarification for nextDaysRelative and showEndsOnlyWithDuration, … (#268) * add clarification for nextDaysRelative and showEndsOnlyWithDuration, only apply to full day events * add emphasis for PREVENT on showEndsOnlyWithDuration * electron-rebuild -> @electron/rebuild (#271) electron-rebuild has been deprecated. * update doc for #3630 (#273) * fix typos, add doc for calendar FullDateEnd format usage, add new env for fetch timeout (#277) * fix typos, add doc for calendar FullDateEnd format usage, add new env variable for fetch timeout * bump deps * lint docs * fix typo --------- Co-authored-by: veeck <[email protected]> --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Ross Younger <[email protected]> Co-authored-by: Bugsounet - Cédric <[email protected]> Co-authored-by: Kristjan ESPERANTO <[email protected]> Co-authored-by: WallysWellies <[email protected]> Co-authored-by: jargordon <[email protected]> Co-authored-by: Karsten Hassel <[email protected]> Co-authored-by: sam detweiler <[email protected]> Co-authored-by: Ryan Williams <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: veeck <[email protected]>
1 parent 7a8781e commit 351cf3e

File tree

11 files changed

+498
-333
lines changed

11 files changed

+498
-333
lines changed

configuration/introduction.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ are:
7474
| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
7575
| MM_CONFIG_FILE | This specifies an alternate configuration file for the system. This is useful when running multiple mirrors on the same device. This does not work with the template option below. NOTE: this file **_MUST_** be located in a directory within the MagicMirror directory. Ideally, place any config file in the config subdirectory. |
7676
| MM_PORT | This specifies an alternate TCPIP port, overriding "port" item within the config file. This is useful for testing to see if the product will run using another port. |
77+
| mmFetchTimeout | time in milliseconds for fetch timeout. default (30000) <br><br>this value can be used to adjust the nodejs fetch function timeout value (default 10 seconds) for all node_helper modules that use fetch() |
7778

7879
##### Examples of use:
7980

development/introduction.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,15 @@ other module has the same name).
3232

3333
## Quick start
3434

35-
To rocket launch your module, you can use the [MMM-Template](https://github.com/Dennis-Rosenbaum/MMM-Template) or immediately [MMM-Template](https://github.com/new?template_name=MMM-Template&template_owner=Dennis-Rosenbaum).
36-
Please read the [MMM-Template wiki](https://github.com/Dennis-Rosenbaum/MMM-Template/wiki) for more information.
37-
38-
**Please note!**
39-
This module is an externally developed module and not maintained by the MagicMirrorOrg.
35+
To rocket launch your module, you can use the
36+
[MMM-Template](https://github.com/Dennis-Rosenbaum/MMM-Template) or immediately
37+
[MMM-Template](https://github.com/new?template_name=MMM-Template&template_owner=Dennis-Rosenbaum).
38+
Please read the
39+
[MMM-Template wiki](https://github.com/Dennis-Rosenbaum/MMM-Template/wiki) for
40+
more information.
41+
42+
**Please note!** This module is an externally developed module and not
43+
maintained by the MagicMirrorOrg.
4044

4145
## Module structure
4246

development/node-helper.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,7 +173,7 @@ If you want use `native node modules` within electron you need to recompile them
173173
for electron. To do so you have to install `electron-rebuild`.
174174

175175
```shell
176-
npm install --save-dev electron-rebuild
176+
npm install --save-dev @electron/rebuild
177177
```
178178

179179
and run it after every install (package.json example):

getting-started/installation.md

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,16 @@ installers can be found under:
1414

1515
## Manual Installation
1616

17-
1. Download and install a [required](https://github.com/MagicMirrorOrg/MagicMirror/releases)
18-
_Node.js_ version, see the official documentation:
19-
20-
- [Linux based distributions](https://github.com/nodesource/distributions)
21-
- [Others](https://nodejs.org/en/download)
22-
17+
1. Download and install a
18+
[required](https://github.com/MagicMirrorOrg/MagicMirror/releases) _Node.js_
19+
version, see the official documentation:
20+
- [Linux based distributions](https://github.com/nodesource/distributions)
21+
- [Others](https://nodejs.org/en/download)
2322
2. check if `git` is installed on your machine by executing `git` (should show
2423
usage), otherwise install it
2524
3. Clone the repository:
2625
`git clone https://github.com/MagicMirrorOrg/MagicMirror`
27-
4. Enter the repository: `cd MagicMirror/`
26+
4. Enter the repository: `cd MagicMirror`
2827
5. Install the application: `npm run install-mm`
2928
6. Make a copy of the config sample file:
3029
`cp config/config.js.sample config/config.js`
@@ -79,12 +78,18 @@ team. Use these scripts and methods at your own risk.
7978

8079
## Other Operating Systems
8180

82-
### Windows:
81+
### Windows
82+
83+
::: warning IMPORTANT
84+
MagicMirror² is designed to run on Linux. But with an extra step in the
85+
installation process and a different start command, you can also
86+
run it on Windows. Some third-party modules may not work on Windows.
87+
:::
8388

84-
To get the MagicMirror software running on Windows, you have to do two things in
85-
addition to the [steps](#manual-installation) above:
89+
To get the software running on Windows, you have to do two things in addition to
90+
the [steps](#manual-installation) above:
8691

87-
4a. Install dependencies in the vendor and font directories:
92+
**After step 5:** Install dependencies in the vendor and font directories:
8893

8994
Powershell:
9095

@@ -96,24 +101,9 @@ Command Prompt:
96101
1. `cd fonts && npm install && cd ..`
97102
2. `cd vendor && npm install && cd ..`
98103

99-
Otherwise the screen will stay black when starting the MagicMirror.
104+
Otherwise the screen will stay black when starting the software.
100105

101-
5a. Fix the start script in the `package.json` file:
102-
103-
1. Navigate to the file `package.json`
104-
2. Find where it says
105-
```
106-
"start": "DISPLAY=\"${DISPLAY:=:0}\" ./node_modules/.bin/electron js/electron.js",
107-
"start:dev": "DISPLAY=\"${DISPLAY:=:0}\" ./node_modules/.bin/electron js/electron.js dev",
108-
```
109-
3. and replace it with
110-
```
111-
"start": ".\\node_modules\\.bin\\electron js\\electron.js",
112-
"start:dev": ".\\node_modules\\.bin\\electron js\\electron.js dev",
113-
```
114-
115-
Otherwise the program won't start, but will display this error message:
116-
`"'DISPLAY' is not recognized as an internal or external command, operable program or batch file."`
106+
**Step 7:** In Windows you must use `npm start:windows` instead of `npm start`.
117107

118108
## Usage
119109

@@ -135,7 +125,7 @@ In this case, you can start MagicMirror² in server only mode by manually runnin
135125
`npm run server`. This will start the server, after which you can open the
136126
application in your browser of choice. Detailed description below.
137127

138-
::: warning IMPORTANT
128+
::: warning IMPORTANT
139129
Make sure that you whitelist the interface/ip
140130
(`ipWhitelist`) in the server config where you want the client to connect to,
141131
otherwise it will not be allowed to connect to the server. You also need to set
@@ -159,3 +149,8 @@ connect as a standalone client to this instance, to show the MM from the server.
159149
Then from your RPi, you run it with:
160150
`node clientonly --address 192.168.1.5 --port 8080`. (Specify the ip address and
161151
port number of the server)
152+
153+
### Wayland
154+
155+
If you use Wayland. Run `npm run start:wayland` instead of `npm run start` to
156+
start.

getting-started/requirements.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,5 +30,6 @@ Raspberry Pi OS versions based on Debian "Buster" are also no longer supported.
3030

3131
## Node
3232

33-
Please refer to the [release page](https://github.com/MagicMirrorOrg/MagicMirror/releases)
34-
to see which node version is required.
33+
Please refer to the
34+
[release page](https://github.com/MagicMirrorOrg/MagicMirror/releases) to see
35+
which node version is required.

0 commit comments

Comments
 (0)