diff --git a/example-conf.yml b/example-conf.yml index 80e39e5..a447ff2 100644 --- a/example-conf.yml +++ b/example-conf.yml @@ -272,14 +272,35 @@ servers: autoconnect: 5 netname: "Nefarious test server" - # The following options are specific to Nefarious servers. + ### The following options are specific to P10 servers: + # Determines whether extended accounts should be used for this network. + # For Nefarious, this **MUST** match the EXTENDED_ACCOUNTS setting in your IRCd configuration. + # Disable this if you are using X3, and leave it on for any other service package + # (atheme, etc.) + # For other P10 IRCds, this should be set to FALSE. + use_extended_accounts: true + + # Sets the IRCd type. The following options are supported here: 'nefarious', 'snircd', and + # 'generic'. + # With this key set to 'nefarious', FAKE (external vHost changing) and SETHOST (host changing + # for PyLink / relay clients) are enabled, along with a set of modes tailored to Nefarious. + + # With this key set to 'snircd', SETHOST and a set of modes tailored to snircd are enabled. + # vHost changing of other users (e.g. via the changehost plugin) is not supported. + + # With this key set to 'generic', neither of these host changing features are enabled + # and a baseline RFC1459 mode set is used. + p10_ircd: nefarious + + ### The following options are specific to Nefarious servers and should be set to false if + ### you're using another P10 IRCd (unless your variant supports them as well): # Halfop is optional in Nefarious. This should match your IRCd configuration. use_halfop: false # Determines whether account-based cloaks should be used (someone.users.yournet.org # format). This should match your IRCd configuration: # ENABLE this if HOST_HIDING_STYLE is set to either 1 or 3. - use_account_cloaks: true + use_account_cloaks: false # The cloak suffix to be used for account-based cloaks. This **MUST** match your # IRCd configuration if use_account_cloaks is enabled. @@ -288,7 +309,7 @@ servers: # Determines whether account-based cloaks should be used for opers # (someone.opers.yournet.org format). If use_account_cloaks is disabled, # this will have no effect. This should match your IRCd configuration: - use_oper_account_cloaks: true + use_oper_account_cloaks: false # The cloak suffix to be used for IRCop account-based cloaks. This **MUST** match your # IRCd configuration if use_oper_account_cloaks is enabled. @@ -297,13 +318,7 @@ servers: # Determines whether UnrealIRCd-style hashed-host cloaks will be used. # This should match your IRCd configuration: # ENABLE this if HOST_HIDING_STYLE is set to either 2 or 3. - use_hashed_cloaks: true - - # Determines whether extended accounts should be used for this network. - # This **MUST** match the EXTENDED_ACCOUNTS setting in your IRCd configuration. - # Disable this if you are using X3, and leave it on for any other service package - # (atheme, etc.) - use_extended_accounts: true + use_hashed_cloaks: false # Sample Clientbot configuration, if you want to connect PyLink as a bot to relay somewhere # (or do other bot things).