hardlounge/defaults/config.js

325 lines
5.7 KiB
JavaScript
Raw Normal View History

2014-09-13 16:41:11 +00:00
module.exports = {
2014-09-14 17:50:00 +00:00
//
// Set the server mode.
// Public servers does not require authentication.
//
// Set to 'false' to enable users.
//
// @type boolean
2016-02-09 14:07:50 +00:00
// @default true
2014-09-15 21:54:01 +00:00
//
2014-09-13 16:41:11 +00:00
public: true,
2014-09-15 21:54:01 +00:00
2014-09-14 17:50:00 +00:00
//
// IP address or hostname for the web server to listen on.
// Setting this to "0.0.0.0" will listen on all interfaces.
2014-09-14 17:50:00 +00:00
//
// @type string
// @default "0.0.0.0"
//
2014-09-13 16:41:11 +00:00
host: "0.0.0.0",
2014-09-15 21:54:01 +00:00
2014-09-14 17:50:00 +00:00
//
// Set the port to listen on.
//
// @type int
// @default 9000
//
port: 9000,
2014-10-11 06:17:41 +00:00
//
// Set the local IP to bind to for outgoing connections. Leave to undefined
// to let the operating system pick its preferred one.
2014-10-11 06:17:41 +00:00
//
// @type string
2016-02-09 14:07:50 +00:00
// @default undefined
2014-10-11 06:17:41 +00:00
//
bind: undefined,
2016-04-03 05:12:49 +00:00
//
// Sets whether the server is behind a reverse proxy and should honor the
// X-Forwarded-For header or not.
//
// @type boolean
// @default false
//
reverseProxy: false,
2014-09-14 17:50:00 +00:00
//
// Set the default theme.
//
// @type string
// @default "themes/example.css"
//
2014-09-13 16:41:11 +00:00
theme: "themes/example.css",
2014-09-14 17:50:00 +00:00
//
2014-09-24 22:23:54 +00:00
// Autoload users
//
// When this setting is enabled, your 'users/' folder will be monitored. This is useful
// if you want to add/remove users while the server is running.
//
// @type boolean
// @default true
//
autoload: true,
2014-10-10 21:12:01 +00:00
//
// Prefetch URLs
//
// If enabled, The Lounge will try to load thumbnails and site descriptions from
2014-10-10 21:12:01 +00:00
// URLs posted in channels.
//
// @type boolean
2016-02-09 14:07:50 +00:00
// @default false
2014-10-10 21:12:01 +00:00
//
2015-09-18 20:11:17 +00:00
prefetch: false,
2014-09-24 22:23:54 +00:00
//
// Prefetch URLs Image Preview size limit
//
// If prefetch is enabled, The Lounge will only display content under the maximum size.
// Default value is 512 (in kB)
//
// @type int
// @default 512
//
prefetchMaxImageSize: 512,
2015-03-22 13:32:01 +00:00
//
// Display network
//
2016-02-21 12:02:35 +00:00
// If set to false network settings will not be shown in the login form.
2015-03-22 13:32:01 +00:00
//
// @type boolean
// @default true
//
displayNetwork: true,
2016-02-21 12:02:35 +00:00
//
// Lock network
//
// If set to true, users will not be able to modify host, port and tls
// settings and will be limited to the configured network.
//
// @type boolean
// @default false
//
lockNetwork: false,
2016-04-03 05:12:49 +00:00
//
// WEBIRC support
//
// If enabled, The Lounge will pass the connecting user's host and IP to the
// IRC server. Note that this requires to obtain a password from the IRC network
// The Lounge will be connecting to and generally involves a lot of trust from the
// network you are connecting to.
//
// Format (standard): {"irc.example.net": "hunter1", "irc.example.org": "passw0rd"}
// Format (function):
// {"irc.example.net": function(client, args, trusted) {
// // here, we return a webirc object fed directly to `irc-framework`
2016-05-06 17:51:38 +00:00
// return {username: "thelounge", password: "hunter1", address: args.ip, hostname: "webirc/"+args.hostname};
2016-04-03 05:12:49 +00:00
// }}
//
// @type string | function(client, args):object(webirc)
// @default null
webirc: null,
2014-09-16 19:47:01 +00:00
//
// Log settings
//
// Logging has to be enabled per user. If enabled, logs will be stored in
2016-05-15 21:15:03 +00:00
// the 'logs/<user>/<network>/' folder.
2014-09-16 19:47:01 +00:00
//
// @type object
// @default {}
//
logs: {
//
// Timestamp format
//
// @type string
// @default "YYYY-MM-DD HH:mm:ss"
//
format: "YYYY-MM-DD HH:mm:ss",
//
// Timezone
//
// @type string
// @default "UTC+00:00"
//
timezone: "UTC+00:00"
},
//
// Maximum number of history lines per channel
//
// Defines the maximum number of history lines that will be kept in
// memory per channel/query, in order to reduce the memory usage of
// the server. Negative means unlimited.
//
// @type integer
// @default -1
maxHistory: -1,
2014-09-15 21:54:01 +00:00
//
// Default values for the 'Connect' form.
//
// @type object
// @default {}
//
defaults: {
//
// Name
//
// @type string
// @default "Freenode"
//
name: "Freenode",
//
// Host
//
// @type string
// @default "chat.freenode.net"
2014-09-15 21:54:01 +00:00
//
host: "chat.freenode.net",
2014-09-15 21:54:01 +00:00
//
// Port
//
// @type int
// @default 6697
//
port: 6697,
//
// Password
//
// @type string
// @default ""
//
password: "",
//
// Enable TLS/SSL
//
// @type boolean
// @default true
//
tls: true,
//
// Nick
//
// @type string
// @default "lounge-user"
2014-09-15 21:54:01 +00:00
//
nick: "lounge-user",
2014-09-15 21:54:01 +00:00
2014-11-02 15:44:52 +00:00
//
// Username
//
// @type string
// @default "lounge-user"
2014-11-02 15:44:52 +00:00
//
username: "lounge-user",
2014-11-02 15:44:52 +00:00
2014-09-15 21:54:01 +00:00
//
// Real Name
//
// @type string
// @default "The Lounge User"
2014-09-15 21:54:01 +00:00
//
realname: "The Lounge User",
2014-09-15 21:54:01 +00:00
//
// Channels
// This is a comma-separated list.
2014-09-15 21:54:01 +00:00
//
// @type string
// @default "#thelounge"
2014-09-15 21:54:01 +00:00
//
join: "#thelounge"
2014-09-26 23:26:21 +00:00
},
2014-11-06 11:48:10 +00:00
//
// Set socket.io transports
//
// @type array
2016-03-19 16:48:36 +00:00
// @default ["polling", "websocket"]
//
2014-11-06 11:48:10 +00:00
transports: ["polling", "websocket"],
2014-09-26 23:26:21 +00:00
//
// Run The Lounge using encrypted HTTP/2.
// This will fallback to regular HTTPS if HTTP/2 is not supported.
2014-09-26 23:26:21 +00:00
//
// @type object
// @default {}
//
https: {
//
// Enable HTTP/2 / HTTPS support.
2014-09-26 23:26:21 +00:00
//
// @type boolean
// @default false
//
enable: false,
//
// Path to the key.
//
// @type string
// @example "sslcert/key.pem"
// @default ""
//
key: "",
//
// Path to the certificate.
//
// @type string
// @example "sslcert/key-cert.pem"
// @default ""
//
certificate: ""
2014-10-09 15:46:12 +00:00
},
//
// Run The Lounge with identd support.
2014-10-09 15:46:12 +00:00
//
// @type object
// @default {}
2014-10-11 17:33:28 +00:00
//
2014-10-09 15:46:12 +00:00
identd: {
//
2014-10-11 17:33:28 +00:00
// Run the identd daemon on server start.
2014-10-09 15:46:12 +00:00
//
// @type boolean
2014-10-11 17:33:28 +00:00
// @default false
//
enable: false,
2014-10-09 15:46:12 +00:00
//
2014-10-11 17:33:28 +00:00
// Port to listen for ident requests.
2014-10-09 15:46:12 +00:00
//
// @type int
2014-10-11 17:33:28 +00:00
// @default 113
2014-10-09 15:46:12 +00:00
//
2014-10-11 17:33:28 +00:00
port: 113
2016-04-26 20:41:08 +00:00
},
//
// Enable oidentd support using the specified file
//
// Example: oidentd: "~/.oidentd.conf",
//
// @type string
// @default null
//
oidentd: null,
2014-09-13 16:41:11 +00:00
};