Skip to content

docs(introduction): clarify usage of functions in config.js for browser availability #385

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sdetweil merged 2 commits into from
Jun 27, 2026
Merged

docs(introduction): clarify usage of functions in config.js for browser availability #385

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
39b8a75
docs(introduction): clarify usage of functions in config.js for brows…
KristjanESPERANTO Jun 27, 2026
495c767
docs(introduction): add export statement for config in config.js example
KristjanESPERANTO Jun 27, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions configuration/introduction.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,9 @@
},
],
};

/*************** DO NOT EDIT THE LINE BELOW ***************/
if (typeof module !== "undefined") {module.exports = config;}
```

See [module configuration](/modules/configuration) for more information and
Expand Down Expand Up @@ -96,6 +99,11 @@ debugging:
server security header behavior.
- `hideConfigSecrets` is documented in detail in [Secrets](./secrets).

When you use functions in `config.js`, keep them inside the exported `config`
object if they need to be available in the browser. MagicMirror² serves the
browser copy of the configuration from the `config` object, so free-standing
helper functions outside that object are not included there.

#### Bash Environment variables

There are two environment variables that override part or all of config.js. They
Expand Down