From 176a6c36d869899b9c20f3444e8acebad0a60686 Mon Sep 17 00:00:00 2001 From: Marcel Klehr Date: Wed, 27 Feb 2013 20:39:38 +0100 Subject: [PATCH 1/2] Document the endless possibilities of log4js --- settings.json.template | 60 +++++++++++++++++++++++++++++++++++------- 1 file changed, 50 insertions(+), 10 deletions(-) diff --git a/settings.json.template b/settings.json.template index 28f0192e3..3865737f6 100644 --- a/settings.json.template +++ b/settings.json.template @@ -51,13 +51,6 @@ }, */ - //Logging configuration. See log4js documentation for further information - // https://github.com/nomiddlename/log4js-node - "logconfig" : - { "appenders": [ - { "type": "console" } - ] }, - //the default text of a pad "defaultPadText" : "Welcome to Etherpad Lite!\n\nThis pad text is synchronized as you type, so that everyone viewing this page sees the same text. This allows you to collaborate seamlessly on documents!\n\nGet involved with Etherpad at http:\/\/etherpad.org\n", @@ -101,9 +94,56 @@ }, */ - /* The log level we are using, can be: DEBUG, INFO, WARN, ERROR */ - "loglevel": "INFO", - // restrict socket.io transport methods "socketTransportProtocols" : ["xhr-polling", "jsonp-polling", "htmlfile"] + + /* The log level we are using, can be: DEBUG, INFO, WARN, ERROR */ + "loglevel": "INFO", + + //Logging configuration. See log4js documentation for further information + // https://github.com/nomiddlename/log4js-node + // You can add as many appenders as you want here: + "logconfig" : + { "appenders": [ + { "type": "console" + //, "category": "access"// only logs pad access + } +/* + , { "type": "file" + , "filename": "your-log-file-here.log" + , "maxLogSize": 1024 + , "backups": 3 // how many log files there're gonna be at max + //, "category": "test" // only log a specific category + }*/ +/* + , { "type": "logLevelFilter" + , "level": "warn" // filters out all log messages that have a lower level than "error" + , "appender": + { "type": "file" + , "filename": "your-log-file-here.log" + , "maxLogSize": 1024 + , "backups": 1 // how many log files there're gonna be at max + } + }*/ + /* + , { "type": "logLevelFilter" + , "level": "error" // filters out all log messages that have a lower level than "error" + , "appender": + { "type": "smtp" + , "subject": "An error occured in your EPL instance!" + , "recipients": "bar@blurdybloop.com, baz@blurdybloop.com" + , "sendInterval": 60*5 // in secs -- will buffer log messages; set to 0 to send a mail for every message + , "transport": "SMTP" // More available transports are documented here: https://github.com/andris9/Nodemailer#possible-transport-methods + , "SMTP": { + "host": "smtp.gmail.com", + "secureConnection": true, + "port": 465, + "auth": { + "user": "foo@bar.com", + "pass": "bar_foo" + } + } + } + }*/ + ] }, } From 5c03c039d1e4e5ea95dd903107fa982c0917d311 Mon Sep 17 00:00:00 2001 From: Marcel Klehr Date: Sun, 3 Mar 2013 16:39:34 +0100 Subject: [PATCH 2/2] [settings.json.template] Shrink things together a bit and consistently indent comments --- settings.json.template | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/settings.json.template b/settings.json.template index 3865737f6..8996fa49e 100644 --- a/settings.json.template +++ b/settings.json.template @@ -108,24 +108,20 @@ { "type": "console" //, "category": "access"// only logs pad access } -/* + /* , { "type": "file" , "filename": "your-log-file-here.log" , "maxLogSize": 1024 , "backups": 3 // how many log files there're gonna be at max //, "category": "test" // only log a specific category }*/ -/* + /* , { "type": "logLevelFilter" , "level": "warn" // filters out all log messages that have a lower level than "error" , "appender": - { "type": "file" - , "filename": "your-log-file-here.log" - , "maxLogSize": 1024 - , "backups": 1 // how many log files there're gonna be at max - } + { /* Use whatever appender you want here */ } }*/ - /* + /* , { "type": "logLevelFilter" , "level": "error" // filters out all log messages that have a lower level than "error" , "appender": @@ -133,13 +129,11 @@ , "subject": "An error occured in your EPL instance!" , "recipients": "bar@blurdybloop.com, baz@blurdybloop.com" , "sendInterval": 60*5 // in secs -- will buffer log messages; set to 0 to send a mail for every message - , "transport": "SMTP" // More available transports are documented here: https://github.com/andris9/Nodemailer#possible-transport-methods - , "SMTP": { - "host": "smtp.gmail.com", + , "transport": "SMTP", "SMTP": { // see https://github.com/andris9/Nodemailer#possible-transport-methods + "host": "smtp.example.com", "port": 465, "secureConnection": true, - "port": 465, "auth": { - "user": "foo@bar.com", + "user": "foo@example.com", "pass": "bar_foo" } }