From af46159275c3e533a4c02326ffa80a673a4bcdc3 Mon Sep 17 00:00:00 2001 From: Pierre-Louis Bonicoli Date: Thu, 23 Feb 2017 16:56:17 +0100 Subject: [PATCH] Sample config file: add default values --- samples/bip.conf | 130 ++++++++++++++++++++++++++--------------------- 1 file changed, 73 insertions(+), 57 deletions(-) diff --git a/samples/bip.conf b/samples/bip.conf index 8de31ca..f350691 100644 --- a/samples/bip.conf +++ b/samples/bip.conf @@ -1,44 +1,53 @@ # bip default config file. # Thou shoult change thy password +# Default values are commented out. + # Listening IP address. This is the IP address bip will listen for incoming # client connections. -ip = "0.0.0.0"; +#ip = "0.0.0.0"; # To connect a client to bip, try the port below, and # be sure to set the password to the value # specified in the network you want to connect to. -# Port is 6667 by default. -port = 7778; +# Port is 7778 by default. +#port = 7778; # If you set this to true, you'll only be able to connect to bip # with a SSL capable IRC client. Be sure to generate a certificate # for bip using scripts/bipgenconfig. -client_side_ssl = false; +#client_side_ssl = false; # This is the file containing the SSL cert/key pair bip'll use to # serve SSL clients. If unset, it defaults to /bip.pem -#client_side_ssl_pem = "/path/to/pemfile"; +# Supply at least 2048-bit parameters, for example using openssl: +# openssl dhparam -out dh.pem 2048; +#client_side_ssl_pem = "/bip.pem"; # OpenSSL cipher lists used with SSL client connections. -#client_side_ciphers = "ECDHE-RSA-AES128-GCM-SHA256"; +# If not set, OpenSSL default ciphers will be used. See OpenSSL ciphers +# command. An example value: "ECDHE-RSA-AES128-GCM-SHA256". +#client_side_ciphers = ; # DH parameters bip'll use when serving SSL clients. # Supply at least 2048-bit parameters, for example using openssl: # openssl dhparam -out dh.pem 2048; -#client_side_dh_param = "dh.pem"; +#client_side_dh_param = "/dh.pem"; # Default OpenSSL cipher lists used with outgoing connections to IRC servers. -#ssl_default_ciphers = "ECDHE-RSA-AES128-GCM-SHA256"; +# If not set, OpenSSL default ciphers will be used. See OpenSSL ciphers +# command. An example value: "ECDHE-RSA-AES128-GCM-SHA256". +# If not set, OpenSSL default ciphers will be used. +#ssl_default_ciphers = ; -# Define where the pidfile should be stored. Defaults to /bip.pid -#pid_file="/run/bip/bip.pid"; +# Define where the pidfile should be stored. Defaults to /bip.pid. +#pid_file=""; # Defaults to /.oidentd.conf #oidentd_file=""; -# Uncomment this line to disable logging and backlogging. -#log = false +# Set to false and uncomment this line to disable logging and backlogging. +#log = true # Define bip's log level : # 0 : only fatal errors @@ -46,16 +55,16 @@ client_side_ssl = false; # 2 : add warnings # 3 : add info messages # 4 : add debug messages -log_level = 3; +#log_level = 3; # This is where logs go. Channel and private messages will use that # configuration value as a prefix, and then log_format to determine # full log filename. Defaults to /logs. -#log_root = "/var/proxy/logs"; +#log_root = ""; -# Uncomment this line to disable bip's internal messages logging. -# This is not recommended, a better option is to reduce log_level. -#log_system = false; +# Set to false and uncomment this line to disable bip's internal messages +# logging. This is not recommended, a better option is to reduce log_level. +#log_system = true; # Log format allows you to make log filenames depend on the log line's # attributes. Here's a list : @@ -107,23 +116,23 @@ network { # a hash # User structure is grouping information for a given user -user { +#user { # The name in bip of the user # This is used by bip only - name = "bip4ever"; - # this user's password (md5(md5("tata"))) with seed - generated by - # bipmkpw - password = "3880f2b39b3b9cb507b052b695d2680859bfc327"; + #name = ; + # This user's password (md5(md5("tata"))) with seed - generated by + # bipmkpw, for example: "3880f2b39b3b9cb507b052b695d2680859bfc327" + #password = ; - # Set this to true if you want "bip4ever" to have admin privileges on - # bip He'll be able to RELOAD bip and see all users' configuration - # (except pass) - admin = true; + # Set this to true if you want this user to have admin privileges on + # bip. User will be able to RELOAD bip and see all users' configuration + # (except pass). + #admin = false; # When bip_use_notice is true, bip will send internal messages like # disconnection notifications or /BIP commands replies as notices # instead of private messages. The default is false. - #bip_use_notice = true; + #bip_use_notice = false; # SSL certificates checking mode for user: # - "none" to accept anything; @@ -134,7 +143,7 @@ user { # in the store below (you have to put in it every cert, CRL, up to the # root CA). You have to build your store manually, so you may prefer # using "basic" unless you're a crypto zealot... - ssl_check_mode = "none"; + #ssl_check_mode = "none"; # Location of the user's store for server SSL certificate check # In "basic" mode, that must point to a single file with all trusted @@ -146,30 +155,32 @@ user { # - a certificate bundle file containing one or more certificates in PEM # format, enclosed in BEGIN CERTIFICATE / END CERTIFICATE lines # - unspecified: in this case, bip will attempt to use the default - # certificate store of the OpenSSL it is built against - ssl_check_store = "/home/bip4ever/.bip/trustedcerts.txt"; + # certificate store of the OpenSSL it is built against. This is the default. + #ssl_check_store = ""; # Some networks (OFTC at least) allow you to authenticate to nickserv # using client side certificates, see # http://www.oftc.net/oftc/NickServ/CertFP # This is where you put your user's certificate. - # ssl_client_certfile = "/home/bip4ever/.bip/bip4ever_client_auth.pem"; + # The default is not to use a certificate. + #ssl_client_certfile = ""; - # These will be the default for each connections - default_nick = "bip4ever"; - default_user = "bip4ever"; - default_realname = "bip4ever"; + # These will be the default for each connections. + #default_nick = ; + #default_user = ; + #default_realname = ; # Makes bip send the log of each channel and privates while # you were not connected to the proxy upon connection. #backlog = true; # enable backlog - backlog_lines = 10; # number of lines in backlog, 0 means - # no limit - backlog_always = true; # backlog even lines already backlogged - # = do not reset backlog when no client - # attached anymore - #backlog_no_timestamp = false; # Disables time stamps if you find them - # ugly. + #backlog_lines = 10; # number of lines in backlog, 0 means no limit + + # When true, backlog even lines already backlogged, do not reset backlog + # when no client attached anymore. + #backlog_always = false; + + # When true, disables time stamps if you find them ugly. + #backlog_no_timestamp = false; # If blreset_on_talk talking on an irc network has the same effect of # issuing /bip blreset , meaning that stuffed logged @@ -180,7 +191,7 @@ user { # will reset the backlog for the query. Same goes for channel. With the # following option set to true, talking in a connection will reset the # whole connection. The backlog for the current network is reset. - #backlog_reset_connection = true; + #backlog_reset_connection = false; # If bl_msg_only is true, only channel and private messages will be # backlogged upon the reconnection of a client. Default is false, thus @@ -195,40 +206,46 @@ user { network = "iiens"; # which ircnet to connect to #log = false; # disable or enable logging and backlogging for - # the current connection. overrides global log - # parameter + # the current connection. Overrides global + # (top-level) log parameter. # You can define ssl_check_mode here, if you want a different - # behavior than the one defined in the parent user {}. + # behavior than the one defined in the parent level ('user' section). #ssl_check_mode = "none"; # If you have multiple IP addresses, you can set the one you - # want bip to use here. See manpage for more information. - #vhost = "192.168.10.6"; + # want bip to use here. This options is totally useless to people who + # only have one IP address. + #vhost = ""; # When source_port is defined, bip will connect to the IRC # server from this port number. That means the IRC server will # see the socket coming from :source_port. - #source_port = "4567"; + #source_port = ""; - # these will be sent to the real server + # These will be sent to the real server. Nick, user and realname are + # required. Default values are defined at the parent level + # (default_nick, default_user, default_realname). #nick = "othernick"; #user = "otheruser"; #realname = "otheruser"; - #password = "serverpassword"; + #password = "server password"; + + #on_connect_send = "PRIVMSG NickServ :IDENTIFY nspassword"; # Some options: #away_nick = "bip`away"; # Away message to be set when no client is connected #no_client_away_msg = "Having life, knock again later"; - #follow_nick = true; - #ignore_first_nick = true; + #follow_nick = false; + #ignore_first_nick = false; - #autojoin_on_kick = false; - #ignore_server_capab = false; + #autojoin_on_kick = true; + #ignore_server_capab = true; # Autojoined channels: - channel { name = "#bip"; }; + #channel { name = "#bip"; }; # name is required. + # Password protected channel channel { name = "#elite_UnDeRgR0uNd"; @@ -250,7 +267,6 @@ user { #away_nick = "bip`away"; #follow_nick = true; #ignore_first_nick = true; - #on_connect_send = "PRIVMSG NickServ :IDENTIFY nspassword"; # Autojoined channels: channel { name = "#bip"; };