MagicMirror-Documentation icon indicating copy to clipboard operation
MagicMirror-Documentation copied to clipboard

Published 20 hours ago • verified publisher icon MichMich

Update Magic Mirror Server and Client mode documentation

Open briodan opened this issue 2 years ago • 16 comments

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

fixes #3196

briodan avatar Sep 18 '23 18:09 briodan

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

sdetweil avatar Sep 18 '23 20:09 sdetweil

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.

briodan avatar Sep 23 '23 20:09 briodan

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

Thanks :)

bugsounet avatar Oct 01 '23 11:10 bugsounet

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

Thanks :)

done

briodan avatar Oct 02 '23 05:10 briodan

@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?

khassel avatar Jul 10 '24 21:07 khassel

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

rejas avatar Jul 11 '24 11:07 rejas

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).

khassel avatar Jul 11 '24 20:07 khassel

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

sdetweil avatar Jul 11 '24 21:07 sdetweil

resolved the conflicts and removed the ssh comment.

briodan avatar Jul 12 '24 00:07 briodan

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.

khassel avatar Jul 12 '24 17:07 khassel

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.

briodan avatar Jul 12 '24 21:07 briodan

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.

khassel avatar Jul 12 '24 21:07 khassel