@@ -14,21 +14,25 @@ installers can be found under:
1414
1515## Manual Installation
1616
17+ These instructions deploy a standalone version of MagicMirror², for
18+ [ Server Only] ( /getting-started/installation.md#server-only ) and
19+ [ Client Only] ( /getting-started/installation.md#client-only ) installs please read
20+ the install specific instructions below
21+
17221 . Download and install a
1823 [ required] ( https://github.com/MagicMirrorOrg/MagicMirror/releases ) _ Node.js_
1924 version, see the official documentation:
2025 - [ Linux based distributions] ( https://github.com/nodesource/distributions )
2126 - [ Others] ( https://nodejs.org/en/download )
22- 2 . check if ` git ` is installed on your machine by executing ` git ` (should show
27+ 2 . Check if ` git ` is installed on your machine by executing ` git ` (should show
2328 usage), otherwise install it
24293 . Clone the repository:
2530 ` git clone https://github.com/MagicMirrorOrg/MagicMirror `
26314 . Enter the repository: ` cd MagicMirror `
27325 . Install the application: ` node --run install-mm `
28336 . Make a copy of the config sample file:
2934 ` cp config/config.js.sample config/config.js `
30- 7 . Start the application: ` node --run start ` \
31- For ** Server Only** use: ` node --run server `
35+ 7 . Start the application: ` node --run start `
3236
3337::: warning NOTE
3438
@@ -82,9 +86,6 @@ team. Use these scripts and methods at your own risk.
8286
8387Note the following:
8488
85- - ` node --run start ` does ** not** work via SSH. But you can use
86- ` DISPLAY=:0 nohup node --run start & ` instead. \
87- This starts the mirror on the remote display.
8889- If you want to debug on your Raspberry Pi you can use ` node --run start:dev `
8990 which will start MM with _ Dev Tools_ enabled.
9091- To access the toolbar menu when in mirror mode, hit ` ALT ` key.
@@ -94,20 +95,35 @@ Note the following:
9495### Server Only
9596
9697In some cases, you want to start the application without an actual app window.
97- In this case, you can start MagicMirror² in server only mode by manually running
98- ` node --run server ` . This will start the server, after which you can open the
99- application in your browser of choice. Detailed description below.
98+ To do so after installation you can start MagicMirror² in server only mode by
99+ manually running the following command within the MagicMirror directory
100+ ` node --run server `
100101
101102::: warning IMPORTANT
102103
103- Make sure that you whitelist the interface/ip (` ipWhitelist ` ) in the server
104- config where you want the client to connect to, otherwise it will not be allowed
105- to connect to the server. You also need to set the local host ` address ` field to
106- ` 0.0.0.0 ` in order for the RPi to listen on all interfaces and not only
107- ` localhost ` (default).
104+ Please read the information below on fully setting up MagicMirror² for running
105+ in server only mode otherwise you wont be able to connect to your MagicMirror²
106+ server from a remote device.
108107
109108:::
110109
110+ In order to run MagicMirror² in server mode you need to:
111+
112+ - Allow Remote Connections to MagicMirror²
113+ - Start MagicMirror² in Server mode on boot
114+
115+ #### Allow Remote Connections to MagicMirror²
116+
117+ By default MagicMirror² does not allow other remote devices to connect, this is
118+ controlled by settings inside the ` config/config.js ` file by interface and ip:
119+
120+ - Change address to ` 0.0.0.0 ` this will allow MagicMirror² to listen on all
121+ network interfaces
122+ - Change ` ipWhitelist ` to the list of IP's you want to allow to connect
123+
124+ Sample Configuration below
125+ [ and link to full configuration options] ( /configuration/introduction.md#introduction )
126+
111127``` js
112128let config = {
113129 address: " 0.0.0.0" , // default is "localhost"
@@ -120,10 +136,12 @@ let config = {
120136### Client Only
121137
122138This is when you already have a server running remotely and want your RPi to
123- connect as a standalone client to this instance, to show the MM from the server.
124- Then from your RPi, you run it with:
125- ` node clientonly --address 192.168.1.5 --port 8080 ` . (Specify the ip address and
126- port number of the server)
139+ connect as a standalone client to this instance, to show the MagicMirror² from
140+ the server.
141+
142+ You can start MagicMirror² in client mode by manually running the following
143+ command with the MagicMirror directory:
144+ ` node clientonly --address 192.168.1.5 --port 8080 `
127145
128146### Wayland
129147
0 commit comments