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]>
MagicMirrorOrg · Jan 1, 2025 · 351cf3e · 351cf3e
1 parent 7a8781e
commit 351cf3e
Show file tree

Hide file tree

Showing 11 changed files with 498 additions and 333 deletions.
diff --git a/configuration/introduction.md b/configuration/introduction.md
@@ -74,6 +74,7 @@ are:
 | ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | 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. |
 | 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.                                                                                                                                                                 |
+| 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()                                                                                                                           |
 
 ##### Examples of use:
 

diff --git a/development/introduction.md b/development/introduction.md
@@ -32,11 +32,15 @@ other module has the same name).
 
 ## Quick start
 
-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). 
-Please read the [MMM-Template wiki](https://github.com/Dennis-Rosenbaum/MMM-Template/wiki) for more information.
-
-**Please note!** 
-This module is an externally developed module and not maintained by the MagicMirrorOrg.
+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).
+Please read the
+[MMM-Template wiki](https://github.com/Dennis-Rosenbaum/MMM-Template/wiki) for
+more information.
+
+**Please note!** This module is an externally developed module and not
+maintained by the MagicMirrorOrg.
 
 ## Module structure
 

diff --git a/development/node-helper.md b/development/node-helper.md
@@ -173,7 +173,7 @@ If you want use `native node modules` within electron you need to recompile them
 for electron. To do so you have to install `electron-rebuild`.
 
 ```shell
-npm install --save-dev electron-rebuild
+npm install --save-dev @electron/rebuild
 ```
 
 and run it after every install (package.json example):

diff --git a/getting-started/installation.md b/getting-started/installation.md
@@ -14,17 +14,16 @@ installers can be found under:
 
 ## Manual Installation
 
-1. Download and install a [required](https://github.com/MagicMirrorOrg/MagicMirror/releases)
-   _Node.js_ version, see the official documentation:
-
-- [Linux based distributions](https://github.com/nodesource/distributions)
-- [Others](https://nodejs.org/en/download)
-
+1. Download and install a
+   [required](https://github.com/MagicMirrorOrg/MagicMirror/releases) _Node.js_
+   version, see the official documentation:
+   - [Linux based distributions](https://github.com/nodesource/distributions)
+   - [Others](https://nodejs.org/en/download)
 2. check if `git` is installed on your machine by executing `git` (should show
    usage), otherwise install it
 3. Clone the repository:
    `git clone https://github.com/MagicMirrorOrg/MagicMirror`
-4. Enter the repository: `cd MagicMirror/`
+4. Enter the repository: `cd MagicMirror`
 5. Install the application: `npm run install-mm`
 6. Make a copy of the config sample file:
    `cp config/config.js.sample config/config.js`
@@ -79,12 +78,18 @@ team. Use these scripts and methods at your own risk.
 
 ## Other Operating Systems
 
-### Windows:
+### 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 MagicMirror software running on Windows, you have to do two things in
-addition to the [steps](#manual-installation) above:
+To get the software running on Windows, you have to do two things in addition to
+the [steps](#manual-installation) above:
 
-4a. Install dependencies in the vendor and font directories:
+**After step 5:** Install dependencies in the vendor and font directories:
 
 Powershell:
 
@@ -96,24 +101,9 @@ Command Prompt:
 1. `cd fonts && npm install && cd ..`
 2. `cd vendor && npm install && cd ..`
 
-Otherwise the screen will stay black when starting the MagicMirror.
+Otherwise the screen will stay black when starting the software.
 
-5a. Fix the start script in the `package.json` file:
-
-1. Navigate to the file `package.json`
-2. Find where it says
-   ```
-   "start": "DISPLAY=\"${DISPLAY:=:0}\" ./node_modules/.bin/electron js/electron.js",
-   "start:dev": "DISPLAY=\"${DISPLAY:=:0}\" ./node_modules/.bin/electron js/electron.js dev",
-   ```
-3. and replace it with
-   ```
-   "start": ".\\node_modules\\.bin\\electron js\\electron.js",
-   "start:dev": ".\\node_modules\\.bin\\electron js\\electron.js dev",
-   ```
-
-Otherwise the program won't start, but will display this error message:
-`"'DISPLAY' is not recognized as an internal or external command, operable program or batch file."`
+**Step 7:** In Windows you must use `npm start:windows` instead of `npm start`.
 
 ## Usage
 
@@ -135,7 +125,7 @@ In this case, you can start MagicMirror² in server only mode by manually runnin
 `npm run server`. This will start the server, after which you can open the
 application in your browser of choice. Detailed description below.
 
-::: warning IMPORTANT 
+::: warning IMPORTANT
 Make sure that you whitelist the interface/ip
 (`ipWhitelist`) in the server config where you want the client to connect to,
 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.
 Then from your RPi, you run it with:
 `node clientonly --address 192.168.1.5 --port 8080`. (Specify the ip address and
 port number of the server)
+
+### Wayland
+
+If you use Wayland. Run `npm run start:wayland` instead of `npm run start` to
+start.
diff --git a/getting-started/requirements.md b/getting-started/requirements.md
@@ -30,5 +30,6 @@ Raspberry Pi OS versions based on Debian "Buster" are also no longer supported.
 
 ## Node
 
-Please refer to the [release page](https://github.com/MagicMirrorOrg/MagicMirror/releases)
-to see which node version is required.
+Please refer to the
+[release page](https://github.com/MagicMirrorOrg/MagicMirror/releases) to see
+which node version is required.