1
0
mirror of https://github.com/node-red/node-red.git synced 2023-10-10 13:36:53 +02:00

Clarify auth settings in default settings.js

This commit is contained in:
Nick O'Leary 2015-12-10 13:20:39 +00:00
parent 98f9353338
commit 5d334e9619

View File

@ -63,43 +63,40 @@ module.exports = {
// If set to false, this is disabled. // If set to false, this is disabled.
//httpAdminRoot: '/admin', //httpAdminRoot: '/admin',
// You can protect the user interface with a userid and password by using the following property.
// The password must be an md5 hash eg.. 5f4dcc3b5aa765d61d8327deb882cf99 ('password')
//httpAdminAuth: {user:"user",pass:"5f4dcc3b5aa765d61d8327deb882cf99"},
// Some nodes, such as HTTP In, can be used to listen for incoming http requests. // Some nodes, such as HTTP In, can be used to listen for incoming http requests.
// By default, these are served relative to '/'. The following property // By default, these are served relative to '/'. The following property
// can be used to specifiy a different root path. If set to false, this is // can be used to specifiy a different root path. If set to false, this is
// disabled. // disabled.
//httpNodeRoot: '/red-nodes', //httpNodeRoot: '/red-nodes',
// To password protect the node-defined HTTP endpoints, the following property // The following property can be used in place of 'httpAdminRoot' and 'httpNodeRoot',
// can be used. // to apply the same root to both parts.
// The password must be an md5 hash eg.. 5f4dcc3b5aa765d61d8327deb882cf99 ('password') //httpRoot: '/red',
//httpNodeAuth: {user:"user",pass:"5f4dcc3b5aa765d61d8327deb882cf99"},
// When httpAdminRoot is used to move the UI to a different root path, the // When httpAdminRoot is used to move the UI to a different root path, the
// following property can be used to identify a directory of static content // following property can be used to identify a directory of static content
// that should be served at http://localhost:1880/. // that should be served at http://localhost:1880/.
//httpStatic: '/home/nol/node-red-dashboard/', //httpStatic: '/home/nol/node-red-dashboard/',
// To password protect the static content, the following property can be used. // Securing Node-RED
// -----------------
// To password protect the Node-RED editor and admin API, the following
// property can be used. See http://nodered.org/docs/security.html for details.
//adminAuth: {
// type: "credentials",
// users: [{
// username: "admin",
// password: "$2a$08$zZWtXTja0fB1pzD4sHCMyOCMYz2Z6dNbM6tl8sJogENOMcxWV9DN.",
// permissions: "*"
// }]
//},
// To password protect the node-defined HTTP endpoints (httpNodeRoot), or
// the static content (httpStatic), the following properties can be used.
// The password must be an md5 hash eg.. 5f4dcc3b5aa765d61d8327deb882cf99 ('password') // The password must be an md5 hash eg.. 5f4dcc3b5aa765d61d8327deb882cf99 ('password')
//httpNodeAuth: {user:"user",pass:"5f4dcc3b5aa765d61d8327deb882cf99"},
//httpStaticAuth: {user:"user",pass:"5f4dcc3b5aa765d61d8327deb882cf99"}, //httpStaticAuth: {user:"user",pass:"5f4dcc3b5aa765d61d8327deb882cf99"},
// The following property can be used in place of 'httpAdminRoot' and 'httpNodeRoot',
// to apply the same root to both parts.
//httpRoot: '/red',
// The following property can be used in place of 'httpAdminAuth' and 'httpNodeAuth',
// to apply the same authentication to both parts.
//httpAuth: {user:"user",pass:"5f4dcc3b5aa765d61d8327deb882cf99"},
// The following property can be used to disable the editor. The admin API
// is not affected by this option. To disable both the editor and the admin
// API, use either the httpRoot or httpAdminRoot properties
//disableEditor: false,
// The following property can be used to enable HTTPS // The following property can be used to enable HTTPS
// See http://nodejs.org/api/https.html#https_https_createserver_options_requestlistener // See http://nodejs.org/api/https.html#https_https_createserver_options_requestlistener
// for details on its contents. // for details on its contents.
@ -111,6 +108,11 @@ module.exports = {
// cert: fs.readFileSync('certificate.pem') // cert: fs.readFileSync('certificate.pem')
//}, //},
// The following property can be used to disable the editor. The admin API
// is not affected by this option. To disable both the editor and the admin
// API, use either the httpRoot or httpAdminRoot properties
//disableEditor: false,
// The following property can be used to configure cross-origin resource sharing // The following property can be used to configure cross-origin resource sharing
// in the HTTP nodes. // in the HTTP nodes.
// See https://github.com/troygoode/node-cors#configuration-options for // See https://github.com/troygoode/node-cors#configuration-options for
@ -170,7 +172,9 @@ module.exports = {
level: "info", level: "info",
// Whether or not to include metric events in the log output // Whether or not to include metric events in the log output
metrics: false metrics: false,
// Whether or not to include audit events in the log output
audit: false
} }
} }
} }