Skip to content

Commit d12cecb

Browse files
author
veeck
committed
run linter
1 parent 6f27891 commit d12cecb

File tree

1 file changed

+32
-21
lines changed

1 file changed

+32
-21
lines changed

getting-started/installation.md

Lines changed: 32 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,10 @@ installers can be found under:
1414

1515
## Manual Installation
1616

17-
These instructions deploy a standalone version of MagicMirror², for [Server Only](/getting-started/installation.html#server-only) and [Client Only](/getting-started/installation.html#client-only) installs please read the install specific instructions below
17+
These instructions deploy a standalone version of MagicMirror², for
18+
[Server Only](/getting-started/installation.html#server-only) and
19+
[Client Only](/getting-started/installation.html#client-only) installs please
20+
read the install specific instructions below
1821

1922
1. Download and install a
2023
[required](https://github.com/MagicMirrorOrg/MagicMirror/releases) _Node.js_
@@ -91,27 +94,35 @@ Note the following:
9194

9295
### Server Only
9396

94-
In some cases, you want to start the application without an actual app window. To do so after
95-
installation you can start MagicMirror² in server only mode by manually running the following command within the MagicMirror directory
96-
`node --run server`
97+
In some cases, you want to start the application without an actual app window.
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`
97101

98102
::: warning IMPORTANT
99103

100-
please read the information below on fully setting up MagicMirror² for running in server only mode otherwise you wont be able to connect to your MagicMirror² server from a remote device
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
101107

102-
:::
108+
:::
103109

104110
In order to run MagicMirror² in server mode you need to:
111+
105112
- Allow Remote Connections to MagicMirror²
106113
- Start MagicMirror² in Server mode on boot
107114

108115
#### Allow Remote Connections to MagicMirror²
109116

110-
By default MagicMirror² does not allow other remote devices to connect, this is controlled by settings inside the `config/config.js` file by interface and ip
111-
- change address to `0.0.0.0` this will allow MagicMirror² to listen on all network interfaces
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
112122
- change `ipWhitelist` to the list of IP's you want to allow to connect
113123

114-
Sample Configuration below [and link to full configuration options](/configuration/introduction.html#introduction)
124+
Sample Configuration below
125+
[and link to full configuration options](/configuration/introduction.html#introduction)
115126

116127
```js
117128
let config = {
@@ -124,32 +135,32 @@ let config = {
124135

125136
#### Start MagicMirror² in Server mode on boot
126137

127-
To always start MagicMirror² in server only mode you need to edit the `installers/mm.sh` file otherwise it will start in full mode after a reboot:
138+
To always start MagicMirror² in server only mode you need to edit the
139+
`installers/mm.sh` file otherwise it will start in full mode after a reboot:
128140

129141
1. Backup mm.sh: `cp installers/mm.sh installers/mm.sh.bak`
130142
2. Edit mm.sh: `nano mm.sh` (you can use your favorite editor)
131-
3. Replace
132-
`DISPLAY=:0 npm start`
133-
with
134-
`DISPLAY=:0 npm server`
143+
3. Replace `DISPLAY=:0 npm start` with `DISPLAY=:0 npm server`
135144
4. Reboot
136145

137146
### Client Only
138147

139148
This is when you already have a server running remotely and want your RPi to
140-
connect as a standalone client to this instance, to show the MagicMirror² from the server.
149+
connect as a standalone client to this instance, to show the MagicMirror² from
150+
the server.
141151

142-
You can start MagicMirror² in client mode by manually running the following command with the MagicMirror directory:
152+
You can start MagicMirror² in client mode by manually running the following
153+
command with the MagicMirror directory:
143154
`node clientonly --address 192.168.1.5 --port 8080`
144155

145-
To always start MagicMirror² in client mode you need to edit `installers/mm.sh` file otherwise it will start in full mode after a reboot:
156+
To always start MagicMirror² in client mode you need to edit `installers/mm.sh`
157+
file otherwise it will start in full mode after a reboot:
146158

147159
1. Backup mm.sh: `cp installers/mm.sh installers/mm.sh.bak`
148160
2. Edit mm.sh: `nano mm.sh` (you can use your favorite editor)
149-
3. Replace
150-
`DISPLAY=:0 npm start`
151-
with
152-
`DISPLAY=:0 node clientonly --address 192.168.1.5 --port 8080` (Specify the ip address and port number of the server)
161+
3. Replace `DISPLAY=:0 npm start` with
162+
`DISPLAY=:0 node clientonly --address 192.168.1.5 --port 8080` (Specify the
163+
ip address and port number of the server)
153164
4. Reboot
154165

155166
### Wayland

0 commit comments

Comments
 (0)