Skip to content

Conversation

briodan
Copy link
Contributor

@briodan briodan commented Sep 18, 2023

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

fixes #3196

@sdetweil
Copy link
Contributor

sdetweil commented Sep 18, 2023

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
Copy link
Contributor Author

briodan commented Sep 23, 2023

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
Copy link
Contributor

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

Thanks :)

@briodan briodan changed the base branch from master to develop October 2, 2023 05:18
@briodan
Copy link
Contributor Author

briodan commented Oct 2, 2023

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

Thanks :)

done

@briodan briodan requested a review from rejas October 13, 2023 20:37
@rejas rejas requested review from sdetweil and khassel October 13, 2023 20:47
* Update weather.md

Updated documentation for MetOffice update

* Update weather.md
@rejas rejas requested a review from khassel July 8, 2024 21:23
@khassel
Copy link
Collaborator

khassel commented Jul 10, 2024

@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
Copy link
Collaborator

rejas commented Jul 11, 2024

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

@khassel
Copy link
Collaborator

khassel commented Jul 11, 2024

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
Copy link
Contributor

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

@briodan
Copy link
Contributor Author

briodan commented Jul 12, 2024

resolved the conflicts and removed the ssh comment.

@khassel
Copy link
Collaborator

khassel commented Jul 12, 2024

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
Copy link
Contributor Author

briodan commented Jul 12, 2024

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
Copy link
Collaborator

khassel commented Jul 12, 2024

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
Copy link
Collaborator

rejas commented Oct 31, 2024

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

@rejas rejas changed the base branch from develop to master November 4, 2024 06:45
@sdetweil
Copy link
Contributor

sdetweil commented Nov 4, 2024

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
Copy link
Contributor Author

briodan commented Nov 4, 2024

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
Copy link
Collaborator

rejas commented Nov 5, 2024

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 :-(

@KristjanESPERANTO KristjanESPERANTO merged commit e331134 into MagicMirrorOrg:master Aug 29, 2025
KristjanESPERANTO pushed a commit to KristjanESPERANTO/MagicMirror-Documentation that referenced this pull request Sep 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

client mode instructions unclear
9 participants