Skip to content
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

Add missing options to console logging config #59

Merged
merged 1 commit into from
May 28, 2024
Merged

Add missing options to console logging config #59

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
5 changes: 4 additions & 1 deletion docs/nodecg-configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,15 +15,18 @@ NodeCG is configured via a `cfg/nodecg.js`, `cfg/nodecg.yaml`, or `cfg/nodecg.js
- `logging` _Object_ Contains other configuration properties.
- `console` _Object_ Contains properties for console logging.
- `enabled` _Boolean_ Whether to enable console logging. [DEFAULT: `true`]
- `level` _String_ Lowest importance of messages which should be logged. Must be `"verbose"`, `"debug"`, `"info"`, `"warn"` or `"error"` [DEFAULT: `"info"`]
- `timestamps` _Boolean_ Whether to add timestamps to the console logging. [DEFAULT: `true`]
- `replicants` _Boolean_ Whether to enable logging of the Replicants subsystem. Very spammy. [DEFAULT: `false`]
- `replicants` _Boolean_ Whether to enable logging of the Replicants subsystem. Very spammy. [DEFAULT: `false`]
- `timestamps` _Boolean_ Whether to add timestamps to the console logging. [DEFAULT: `true`]
- `level` _String_ Lowest importance of messages which should be logged. Must be `"verbose"`, `"debug"`, `"info"`, `"warn"` or `"error"` [DEFAULT: `"info"`]
- `file` _Object_ Contains properties for file logging.
- `enabled` _Boolean_ Whether to enable file logging. [DEFAULT: `false`]
- `replicants` _Boolean_ Whether to enable logging of the Replicants subsystem. Very spammy. [DEFAULT: `false`]
- `timestamps` _Boolean_ Whether to add timestamps to the file logging. [DEFAULT: `true`]
- `path` _String_ The filepath to log to. [DEFAULT: `"logs/nodecg.log"`]
- `level` _String_ Lowest importance of messages which should be logged. Must be `"verbose"`, `"debug"`, `"info"`, `"warn"` or `"error"` [DEFAULT: `"info"`]
- `path` _String_ The filepath to log to. [DEFAULT: `"logs/nodecg.log"`]
- `bundles` _Object_ Contains configuration for bundles.
- `enabled` _Array of strings_ A whitelist array of bundle names that will be the only ones loaded at startup. Cannot be used with `bundles.disabled`. [DEFAULT: `null` -> this bundle whitelist feature is disabled -> load all bundles]
- `disabled` _Array of strings_ A blacklist array of bundle names that will not be loaded at startup. Cannot be used with `bundles.enabled`. [DEFAULT: `null` -> no bundle blacklisted from loading / all bundles are loaded]
Expand Down
Loading