kenmirrors/MagicMirror
1
0
Fork 0
mirror of https://github.com/MichMich/MagicMirror.git synced 2025-06-27 03:39:55 +00:00
Code Issues Projects Releases Wiki Activity

Update config sample and collab doc (#3039)

Browse Source 
removing some old example and add info about the mastermerge label

---------

Co-authored-by: veeck <michael@veeck.de>
This commit is contained in:
Veeck 2023-02-17 19:49:36 +01:00 committed by GitHub
parent 65aa1b0ddc
commit 81244d961e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 6 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGELOG.md
View File

@ -27,7 +27,7 @@ _This release is scheduled to be released on 2023-04-01._
### Updated ### Updated
- Use develop as target branch for dependabot - Use develop as target branch for dependabot
- Update issue template and contributing doc - Update issue template, contributing doc and sample config
- The weather modules clearly separates precipitation amount and probability (risk of rain/snow) - The weather modules clearly separates precipitation amount and probability (risk of rain/snow)
- This requires all providers that only supports probability to change the config from `showPrecipitationAmount` to `showPrecipitationProbability`. - This requires all providers that only supports probability to change the config from `showPrecipitationAmount` to `showPrecipitationProbability`.
- Update tests for weather and calendar module - Update tests for weather and calendar module

1
Collaboration.md
View File

@ -6,6 +6,7 @@ This document describes how collaborators of this repository should work togethe
- never merge without someone having approved (approving and merging from same person is allowed) - never merge without someone having approved (approving and merging from same person is allowed)
- wait for all approvals requested (or the author decides something different in the comments) - wait for all approvals requested (or the author decides something different in the comments)
- never merge to `master`, except for releases (because of update notification) - never merge to `master`, except for releases (because of update notification)
- merges to master should be tagged with the "mastermerge" label so that the test runs through
## Issues ## Issues

13
config/config.js.sample
View File

@ -12,15 +12,15 @@
* see https://docs.magicmirror.builders/configuration/introduction.html#enviromnent-variables * see https://docs.magicmirror.builders/configuration/introduction.html#enviromnent-variables
*/ */
let config = { let config = {
address: "localhost", // Address to listen on, can be: address: "localhost", // Address to listen on, can be:
// - "localhost", "127.0.0.1", "::1" to listen on loopback interface // - "localhost", "127.0.0.1", "::1" to listen on loopback interface
// - another specific IPv4/6 to listen on a specific interface // - another specific IPv4/6 to listen on a specific interface
// - "0.0.0.0", "::" to listen on any interface // - "0.0.0.0", "::" to listen on any interface
// Default, when address config is left out or empty, is "localhost" // Default, when address config is left out or empty, is "localhost"
port: 8080, port: 8080,
basePath: "/", // The URL path where MagicMirror² is hosted. If you are using a Reverse proxy basePath: "/", // The URL path where MagicMirror² is hosted. If you are using a Reverse proxy
// you must set the sub path here. basePath must end with a / // you must set the sub path here. basePath must end with a /
ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"], // Set [] to allow all IP addresses ipWhitelist: ["127.0.0.1", "::ffff:127.0.0.1", "::1"], // Set [] to allow all IP addresses
// or add a specific IPv4 of 192.168.1.5 : // or add a specific IPv4 of 192.168.1.5 :
// ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.1.5"], // ["127.0.0.1", "::ffff:127.0.0.1", "::1", "::ffff:192.168.1.5"],
// or IPv4 range of 192.168.3.0 --> 192.168.3.15 use CIDR format : // or IPv4 range of 192.168.3.0 --> 192.168.3.15 use CIDR format :
@ -35,11 +35,6 @@ let config = {
logLevel: ["INFO", "LOG", "WARN", "ERROR"], // Add "DEBUG" for even more logging logLevel: ["INFO", "LOG", "WARN", "ERROR"], // Add "DEBUG" for even more logging
timeFormat: 24, timeFormat: 24,
units: "metric", units: "metric",
// serverOnly: true/false/"local" ,
// local for armv6l processors, default
// starts serveronly and then starts chrome browser
// false, default for all NON-armv6l devices
// true, force serveronly mode, because you want to.. no UI on this device
modules: [ modules: [
{ {