Update Magic Mirror Server and Client mode documentation #186

briodan · 2023-09-18T18:57:35Z

updating instructions on how to run MagicMirror in server only and client only mode.

updated client mode install instructions

sdetweil · 2023-09-18T20:07:05Z

really there's just one install,
it copies the files and does NPM install

and then you can run any one of the three environments from there
full
or
server only
or
client only

just by changing the command

My script is targeted at running full but again all you have to do is change the command to launch the other environments

briodan · 2023-09-23T20:24:12Z

maybe i went a bit heavy on the documentation, my approach was with the mindset of what would have helped me figure it out without having to look at any other sources or do any googling.

Feel free to edit/amend as needed.

bugsounet · 2023-10-01T11:11:27Z

Can you change the target to the develop branch ?
It's better

Thanks :)

briodan · 2023-10-02T05:18:58Z

Can you change the target to the develop branch ? It's better

Thanks :)

done

getting-started/installation.md

khassel · 2023-10-13T22:44:44Z

getting-started/installation.md

@@ -14,18 +14,18 @@ installers can be found under:

 ## Manual Installation

+These instructions deploy a standalone version of Magic Mirror, 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
+


@rejas last time you lintered the lines to a max. length, will you do this here before/after merge?

after merge I will lint again

khassel · 2023-10-13T22:49:01Z

getting-started/installation.md

+3. Replace
+   `DISPLAY=:0 npm start`
+   with
+   `DISPLAY=:0 npm server`


npm server this will not work, must be npm run server

its running for me with npm server changed it to npm run server and didn't see any difference. but i'll admit i don't fully understand how this works, just documenting what i had to do to get it working :)

Can also say, that npm server does not work for me (or in general as far as i know). Only a few scripts work out of the box, like start and test

Maybe you got some shortcuts somewhere, but please update here to use "start"

getting-started/installation.md

khassel · 2023-10-13T22:55:26Z

getting-started/installation.md

+
+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:
+
+1. Backup mm.sh: `cp installers/mm.sh installers/mm.sh.bak`


@rejas don't know anything about this mm.sh stuff, totally irrelevant when using docker, so is this a standard setup or how should we document it here?
Found in mm.sh this line

# This file is still here to keep PM2 working on older installations.

the mm.sh file is removed on develop so installers/mm.sh will not exist anymore with next release. This file will be part of sam's script repo.

yes, please remove the stuff about mm.sh

* Minor changes - wording - Magic Mirror -> MagicMirror - format * sh -> shell

Add documentation for the specialDayUnique config option

* bump prettier * run prettier

* Update weather.md Updated documentation for MetOffice update * Update weather.md

khassel · 2024-07-10T21:32:56Z

@rejas how are develop and master working in this repo?

develop is behind master so reviewing stuff based on this is waste of time for me. Have we a concept how to handle diverging of these branches?

rejas · 2024-07-11T11:37:00Z

maybe we should merge master regularly back into develop (or everytime master gets some updates) so that this wont happen?

khassel · 2024-07-11T20:42:25Z

maybe we should merge master regularly back into develop (or everytime master gets some updates) so that this wont happen?

we should do it everytime master gets some updates, I did it now (with the expected result of merge conflicts in this PR).

sdetweil · 2024-07-11T21:29:59Z

we also need to remove the comment doesn't work over ssh.. as we fixed that a long time ago

briodan · 2024-07-12T00:19:47Z

resolved the conflicts and removed the ssh comment.

khassel · 2024-07-12T17:44:03Z

resolved the conflicts and removed the ssh comment.

Thanks!

As already mentioned in the comments above: The mm.sh file is removed on develop so installers/mm.sh will not exist anymore with next release. This file will be part of sam's script repo.

So I think the 2 sections beginning with To always start MagicMirror² in xxx mode you need to edit the installers/mm.sh file ... should be removed.

But I'm open to other approaches.

briodan · 2024-07-12T21:07:16Z

So should this really be a PR against develop? The intent of this PR when initially submitted was to document running server and client mode based on the way things worked at the time and I guess still will until the next release.

Since there is new functionality coming up in the future would it make sense to merge this into master to get current state documented, and setup another PR in develop to update the documentation based on new functionality?

Or would it make sense to just close this PR and set up a new one that accounts for functionality changes from scratch.

khassel · 2024-07-12T21:17:10Z

I would go for documentation for next release and omit the mm.sh stuff.

We can stay on develop and if it fits for master too I will "copy" it (in git wording: cherry pick) to master.

rejas · 2024-10-31T10:03:42Z

@briodan can you update your branch and resolve the conflicts so that we can get this PR into our code?

rejas · 2024-11-04T09:25:12Z

getting-started/installation.md

+3. Replace
+   `DISPLAY=:0 npm start`
+   with
+   `DISPLAY=:0 npm server`


Can also say, that npm server does not work for me (or in general as far as i know). Only a few scripts work out of the box, like start and test

Maybe you got some shortcuts somewhere, but please update here to use "start"

rejas · 2024-11-04T09:26:53Z

getting-started/installation.md

+
+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:
+
+1. Backup mm.sh: `cp installers/mm.sh installers/mm.sh.bak`


yes, please remove the stuff about mm.sh

rejas · 2024-11-04T09:27:14Z

getting-started/installation.md

@@ -14,18 +14,18 @@ installers can be found under:

 ## Manual Installation

+These instructions deploy a standalone version of Magic Mirror, 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
+


after merge I will lint again

sdetweil · 2024-11-04T12:16:36Z

there is one install
and 3 execution modes
full , npm start , or npm run start
server, npm run server
client , npm run client

only the start script has a shortcut to not require the word run

installers/mm.sh was removed from the MagicMirror package and taken over by my scripted installer

briodan · 2024-11-04T19:43:06Z

This PR was written over a year ago to document how client and server mode were working at the time, with the Q4 release that changed the way things work for MM I don't know how much of this PR is still valid and I don't have the cycle to test it.

I updated my branch to latest, but beyond that I'll let others take this forward and update the documentation if still required.

rejas · 2024-11-05T11:22:37Z

I updated my branch to latest, but beyond that I'll let others take this forward and update the documentation if still required.

Thanks for your work, Ill take it upon me to finish the PR. Alas, you seem to have worked on your master branch and I cannot push to that it seems :-(

briodan added 12 commits September 15, 2023 14:41

Update installation.md

70acd0c

updated client mode install instructions

Update installation.md

956cc9e

Update installation.md

f158683

Update installation.md

68522f3

Update installation.md

457bdf5

Update installation.md

d6cd8c7

Update installation.md

2502639

Update installation.md

2445414

Update installation.md

51810c9

Update installation.md

0b20703

Update installation.md

14fec29

Update installation.md

1d92044

briodan changed the base branch from master to develop October 2, 2023 05:18

rejas added 2 commits October 4, 2023 11:33

Merge branch 'develop' into master

433214a

Merge branch 'develop' into master

ab6f81c

rejas requested changes Oct 13, 2023

View reviewed changes

getting-started/installation.md Outdated Show resolved Hide resolved

Update installation.md

0bc1e54

briodan requested a review from rejas October 13, 2023 20:37

rejas requested review from sdetweil and khassel October 13, 2023 20:47

rejas approved these changes Oct 13, 2023

View reviewed changes

khassel reviewed Oct 13, 2023

View reviewed changes

briodan and others added 4 commits October 13, 2023 18:59

Update installation.md

1429733

weather.md: update for recent changes (MagicMirrorOrg#230)

7e8f28f

add updates feature configuration (MagicMirrorOrg#234)

154a843

Update calendar.md (MagicMirrorOrg#236)

a78bd1f

bugsounet and others added 9 commits March 23, 2024 10:34

updateOnFetch feature Docs (MagicMirrorOrg#235)

2ce3c94

Minor changes (MagicMirrorOrg#238)

4e451f8

* Minor changes - wording - Magic Mirror -> MagicMirror - format * sh -> shell

Merge branch 'mm-master' into mm-develop

43103c3

Merge branch 'mm-master' into mm-develop

942936f

Update compliments docs page (MagicMirrorOrg#242)

6b6eb2d

Add documentation for the specialDayUnique config option

Cleanup formatting (MagicMirrorOrg#247)

87ff347

* bump prettier * run prettier

Merge branch 'mm-master' into mm-develop

f642eb1

Merge branch 'develop' into master

82004ba

UK Met Office Documentation Fix (MagicMirrorOrg#253)

61f70b7

* Update weather.md Updated documentation for MetOffice update * Update weather.md

rejas requested a review from khassel July 8, 2024 21:23

Merge branch 'master' into develop

89b6259

Merge branch 'develop' into master

7f29d9b

rejas assigned briodan Oct 31, 2024

Merge remote-tracking branch 'upstream/master'

98b72b3

rejas changed the base branch from develop to master November 4, 2024 06:45

rejas requested changes Nov 4, 2024

View reviewed changes

rejas mentioned this pull request Nov 16, 2024

client mode instructions unclear MagicMirrorOrg/MagicMirror#3196

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Magic Mirror Server and Client mode documentation #186

Update Magic Mirror Server and Client mode documentation #186

briodan commented Sep 18, 2023 •

edited by rejas

Loading

sdetweil commented Sep 18, 2023 •

edited

Loading

briodan commented Sep 23, 2023

bugsounet commented Oct 1, 2023

briodan commented Oct 2, 2023

khassel Oct 13, 2023

rejas Nov 4, 2024

khassel Oct 13, 2023

briodan Oct 14, 2023

rejas Nov 4, 2024

khassel Oct 13, 2023

khassel Jul 11, 2024

rejas Nov 4, 2024

khassel commented Jul 10, 2024

rejas commented Jul 11, 2024

khassel commented Jul 11, 2024

sdetweil commented Jul 11, 2024

briodan commented Jul 12, 2024

khassel commented Jul 12, 2024

briodan commented Jul 12, 2024

khassel commented Jul 12, 2024

rejas commented Oct 31, 2024

rejas Nov 4, 2024

rejas Nov 4, 2024

rejas Nov 4, 2024

sdetweil commented Nov 4, 2024

briodan commented Nov 4, 2024

rejas commented Nov 5, 2024

		@@ -14,18 +14,18 @@ installers can be found under:

		## Manual Installation

		These instructions deploy a standalone version of Magic Mirror, 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


		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:

		1. Backup mm.sh: `cp installers/mm.sh installers/mm.sh.bak`

Update Magic Mirror Server and Client mode documentation #186

Are you sure you want to change the base?

Update Magic Mirror Server and Client mode documentation #186

Conversation

briodan commented Sep 18, 2023 • edited by rejas Loading

sdetweil commented Sep 18, 2023 • edited Loading

briodan commented Sep 23, 2023

bugsounet commented Oct 1, 2023

briodan commented Oct 2, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

khassel commented Jul 10, 2024

rejas commented Jul 11, 2024

khassel commented Jul 11, 2024

sdetweil commented Jul 11, 2024

briodan commented Jul 12, 2024

khassel commented Jul 12, 2024

briodan commented Jul 12, 2024

khassel commented Jul 12, 2024

rejas commented Oct 31, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sdetweil commented Nov 4, 2024

briodan commented Nov 4, 2024

rejas commented Nov 5, 2024

briodan commented Sep 18, 2023 •

edited by rejas

Loading

sdetweil commented Sep 18, 2023 •

edited

Loading