iris.conf.example

# Iris configuration file
#
# This is in a format similar to ini files and similar.
# Lines beginning with # are comments.
#
# Note that some changes to this configuration file require re-running
# compile.py, others require restarting Iris, and some may require both.
# Individual blocks are labeled with their requirements.
#
# Be warned that some settings are, via inclusion in the frontend, exposed
# to users. These blocks are labeled.



# EXECUTION OPTIONS
# These options set parameters to Iris startup and execution.
# They require a backend restart to change.
[execution]

# ARGS: These arguments will be used as if Iris was run directly with
# with them, see run.py --help for a list of options.
# Set empty for no options.
args: -n -p 3989

# SYSLOG ADDR: Used in conjunction with util/syslog.py and -s option.
# This option specifies the address that syslog datagrams will be sent
# to. If enabled, set syslog_port, too.
syslog_addr:

# SYSLOG PORT: Sets the port to send syslog datagrams to, if syslog_addr is set.
syslog_port: 514



# BACKEND IRC CONNECTION OPTIONS
# These options provide the needed information for the backend to connect to
# the IRC server and perform registration.
# They require a backend restart to change.
[irc]

# SERVER: Hostname (or IP address) of IRC server to connect to.
server: irc.myserver.com

# PORT: Port of IRC server to connect to.
# Prefix this with a + to use an SSL connection.
port: 6667

# REALNAME: The realname field for clients connecting through the
# webclient.
realname: http://moo.com/

# IDENT: Type of ident to use on IRC, possible values include:
# string: Use a fixed string specified by ident_string.
# hex: Use the user's IP, in hexadecimal.
# nick: Use the user's specified nickname.
ident: string

# IDENT STRING: A fixed string to use as an ident on IRC.
# See ident setting documentation.
ident_string: webchat

# WEBIRC MODE: This option controls how the IP/hostname of the
# connecting browser will be sent to IRC. If set, the IRC server may
# be able to transparently display users of Iris as from their
# original hosts, rather than as coming from the webclient's IP.
# Possible values include:
# webirc: Use WEBIRC type blocks, with an IRCD configuration of
#   the following style:
#
#   cgiirc: {
#     type webirc;
#     hostname <qwebirc's ip address>;
#     password <password>;
#   };
#
#   You must set webirc_password to be the same as <password>.
#
# realname: Disables WEBIRC.
#   Sends the IP and hostname in the realname field in the format
#   <hostname>/<ip> - <normal realname>, convenient for human reading.
#
# <left empty>: Disables WEBIRC.
#   Sends the IP in the realname field, overriding the REALNAME option.
webirc_mode:

# WEBIRC PASSWORD: Used for webirc mode "webirc", see webirc_mode option
# documentation.
webirc_password: fish



# ATHEME ENGINE OPTIONS
# These options control communication with Atheme by the Atheme engine backend,
# and in some cases, features enabled in the Atheme frontend.
# They require a backend restart and a rerun of compile.py to update.
[athemeengine]

# XMLRPC PATH: Address of your Atheme directory instance.  Allows
# authentication to NickServ ala SASL AUTHCOOKIE.
# If you don't have an Atheme directory instance, leave unset.
# Leave this unset to disable all Atheme integration.
xmlrpc_path: http://127.0.0.1:8080/xmlrpc

# CHAN LIST ENABLED: Whether to permit channel lists to be requested.
# These could be a memory usage concern on large networks (at least if the
# below are set badly). Enables the channel list in the frontend if true.
chan_list_enabled: true

# CHAN LIST MAX AGE: Maximum age of a channel list before a new list will be
# requested and used for all future requests. This is how potentially outdated
# the displayed channel list can be for clients requesting a new list.
# Measured in seconds.
chan_list_max_age: 120

# CHAN LIST COUNT: Number of old channel lists to keep. These permit clients
# showing part of a previous list to explicitly request more of the same list
# until it is expired.
chan_list_count: 3



# FEEDBACK ENGINE OPTIONS
# These options control the feedback system backend, which allows users to
# send feedback directly from Iris, when forwards it via email.
# They require a backend restart to change.
[feedbackengine]

# ENABLE FEEDBACK ENGINE: Whether or not the feedback engine is enabled
enabled: true

# FEEDBACK FROM: E-mail address that feedback will originate from.
from: moo@moo.com

# FEEDBACK TO: E-mail address that feedback will be sent to.
to: moo@moo.com

# SMTP HOST: Hostname/IP address of SMTP server feedback will be sent
# through.
smtp_host: 127.0.0.1

# SMTP PORT: Port of SMTP server feedback will be sent through.
smtp_port: 25



# FRONTEND OPTIONS
# These alter the general settings and text used within the frontend.
# Many of these are overridable by query string, in which case these settings
# serve as the default when they are not.
# These are exposed to users.
# These require a rerun of compile.py to change.
[frontend]

# BASE URL: URL that this qwebirc instance will be available at, add
# the port number if your instance runs on a port other than 80.
base_url: http://foo.foo.org/

# NETWORK NAME: The name of your IRC network, displayed throughout the
# application.
network_name: FooNet

# APP TITLE: The title of the application in the web browser.
# The title of the application in the web browser.
app_title: %(network_name)s Web IRC

# INITIAL NICK: Default initial nickname for the user.
# '.' characters will be replaced by random digits.
# Leave blank to force the user to enter a nick before connecting.
initial_nick:

# INITIAL CHANS: Default channels to join on connect.
# Comma-separate channels, and provide keys after, space-separated.
# Leave blank for to join no channels by default.
initial_chans:

# PROMPT: Whether the user should be prompted to edit their connection details
# before connecting. Ignored if initial_nick or initial_chans are empty.
prompt: true

# CHAN PROMPT: Whether the user should be prompted to edit the default channel
# provided by settings before connecting if prompted for connection details.
# Otherwise, they are only prompted for nick. Ignored if initial_chans is empty.
# Primarily useful as a query string parameter for embedded webclients.
chan_prompt: true

# CHAN AUTOCONNECT: Whether on clicking a channel in the client prior to
# connect, in a channel list or other URLified text, they should be
# automatically connected and joined without any further confirmation if they
# have a nick either provided by settings or typed into a connect window.
# If set false, then the user is simply redirected to the connect window, with
# the channel set in the channel box.
chan_autoconnect: true

# STATIC BASE URL: This value is used to build the URL for all static
# HTTP requests. You'd find this useful if you're running multiple
# Iris instances on the same host.
static_base_url: /

# DYNAMIC BASE URL: This value is used to build the URL for all dynamic
# HTTP requests. You'd find this useful if you're running multiple
# Iris instances on the same host.
dynamic_base_url: /



# ATHEME INTEGRATION OPTIONS
# These options control integration with Atheme in the frontend.
# They require a rerun of compile.py to change.
# These are exposed to end users.
[atheme]

# NICKSERV LOGIN: Enable login to a NickServ account using Iris, before
# connecting. Requires SASL with the AUTHCOOKIE method be loaded in Atheme.
# If an XML-RPC connection isn't available, will fall back to SASL PLAIN.
nickserv_login: true

# CHAN LIST ON START: Open the channel listing automatically when the
# client starts. Requires the channel list be enabled, obviously.
# Always defaults off if any query string parameters are specified; must be
# explicitly set on in the query string to enable.
chan_list_on_start: true

# CHAN LIST CLOUD VIEW: Whether the channel list's cloud view should be the
# default, or it should default to the list view. An option to switch view mode
# is shown regardless.
chan_list_cloud_view: false



# UI OPTIONS
# These alter the way the frontend looks and presents information to the user.
# Many of these can be set by user in their options, in which case these
# settings serve as the default.
# These are exposed to users.
# These require a rerun of compile.py to change.
[ui]

# DEDICATED MSG WINDOW: Whether PMs should be shown in a dedicated window.
dedicated_msg_window: false

# DEDICATED NOTICE WINDOW: Whether notices should be shown in a dedicated
# window.
dedicated_notice_window: false

# HIDE JOINPARTS: Whether joins and parts should be hidden in channels.
hide_joinparts: false

# SIMPLE COLOR: If enabled, hides most colour options, only showing the
# background hue slider. This may be desirable if you consider the colour
# options too complicated. Note that how useful the results of moving this
# single slider are depends on the colour you have set.
simple_color: false

# PRIMARY FOREGROUND COLOR: The base foreground colour for the UI.
# Used for the bulk of the text.
# Provide as a hexadecimal RGB value, without a # at the start.
fg_color: DDDDDD

# SECONDARY FOREGROUND COLOR: The secondary foreground colour for the UI.
# Used for titles and links. If left empty, the same as the primary.
# Provide as a hexadecimal RGB value, without a # at the start.
fg_sec_color: 999999

# BACKGROUND COLOR: The base background colour for the UI.
# Provide as a hexadecimal RGB value, without a # at the start.
bg_color: 111111

# LASTPOS LINE: Whether a "last position" marker should be displayed.
lastpos_line: true

# NICK CLICK QUERY: Whether clicking on a nick in channel queries them.
# If off, it whoises instead.
nick_click_query: false

# NICK COLORS: Whether nicks are coloured by default.
nick_colors: false

# NICK STATUS: Whether to show status symbols before nicknames in channel lines.
nick_status: false

# FLASH ON MENTION: Whether to flash the title for attention when highlighted.
flash_on_mention: false

# BEEP ON MENTION: Whether to beep for attention when highlighted.
# Requires Flash; does nothing if the user lacks it.
beep_on_mention: false



# ADMIN ENGINE OPTIONS
# These options control the admin engine backend.
# They require a backend restart to change.
[adminengine]

# HOSTS: Space-separated list of IP addresses to allow onto the admin
# engine at http://instance/adminengine
hosts: 127.0.0.1



# PROXY OPTIONS
# These options manage trust of proxies between the users and the backend.
# They require a backend restart to change.
[proxy]

# FORWARDED FOR HEADER: If you're using a proxy that passes through a
# forwarded-for header, set this option to the header name, also set
# forwarded_for_ips. Leave empty otherwise.
forwarded_for_header:

# FORWARDED FOR IPS: This option specifies the IP addresses that
# forwarded-for headers will be accepted from as a space-separated
# list. Ignored if forwarded_for_header is empty.
forwarded_for_ips: 127.0.0.1



# BACKEND TUNEABLE VALUES
# You probably don't want to fiddle with these unless you really know what
# you're doing...
# These options require a backend restart to change.
[tuneback]

# UPDATE FREQ: Maximum rate (in seconds) at which updates will be
# propagated to clients
update_freq: 0.5

# MAXBUFLEN: Maximum client AJAX recieve buffer size (in bytes), if
# this buffer size is exceeded then the client will be disconnected.
# This value should match the client sendq size in your ircd's
# configuration.
maxbuflen: 100000

# MAXSUBSCRIPTIONS: Maximum amount of 'subscriptions' to a specific
# AJAX channel, i.e. an IRC connection. In theory with a value greater
# than one you can connect more than one web IRC client to the same
# IRC connection, ala irssi-proxy.
maxsubscriptions: 1

# MAXLINELEN: If the client sends a line greater than maxlinelen (in
# bytes) then they will be disconnected.
# Note that IRC normally silently drops messages >=512 bytes.
maxlinelen: 600

# DNS TIMEOUT: DNS requests that do not respond within dns_timeout
# seconds will be cancelled.
dns_timeout: 5

# HTTP AJAX REQUEST TIMEOUT: Connections made to the AJAX engine are
# closed after this many seconds. Note that this value is intimately
# linked with the client AJAX code at this time, changing it will
# result in bad things happening.
http_ajax_request_timeout: 30

# HTTP REQUEST TIMEOUT: Connections made to everything but the AJAX
# engine will be closed after this many seconds, including connections
# that haven't started/completed an HTTP request.
http_request_timeout: 5