:plugin: irc
:type: input

///////////////////////////////////////////
START - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////
:version: %VERSION%
:release_date: %RELEASE_DATE%
:changelog_url: %CHANGELOG_URL%
:include_path: ../../../../logstash/docs/include
///////////////////////////////////////////
END - GENERATED VARIABLES, DO NOT EDIT!
///////////////////////////////////////////

[id="plugins-{type}-{plugin}"]

=== Irc input plugin

include::{include_path}/plugin_header.asciidoc[]

==== Description

Read events from an IRC Server.


[id="plugins-{type}s-{plugin}-options"]
==== Irc Input Configuration Options

This plugin supports the following configuration options plus the <<plugins-{type}s-{plugin}-common-options>> described later.

[cols="<,<,<",options="header",]
|=======================================================================
|Setting |Input type|Required
| <<plugins-{type}s-{plugin}-catch_all>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-channels>> |<<array,array>>|Yes
| <<plugins-{type}s-{plugin}-get_stats>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-host>> |<<string,string>>|Yes
| <<plugins-{type}s-{plugin}-nick>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-password>> |<<password,password>>|No
| <<plugins-{type}s-{plugin}-port>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-real>> |<<string,string>>|No
| <<plugins-{type}s-{plugin}-secure>> |<<boolean,boolean>>|No
| <<plugins-{type}s-{plugin}-stats_interval>> |<<number,number>>|No
| <<plugins-{type}s-{plugin}-user>> |<<string,string>>|No
|=======================================================================

Also see <<plugins-{type}s-{plugin}-common-options>> for a list of options supported by all
input plugins.

&nbsp;

[id="plugins-{type}s-{plugin}-catch_all"]
===== `catch_all` 

  * Value type is <<boolean,boolean>>
  * Default value is `false`

Catch all IRC channel/user events not just channel messages

[id="plugins-{type}s-{plugin}-channels"]
===== `channels` 

  * This is a required setting.
  * Value type is <<array,array>>
  * There is no default value for this setting.

Channels to join and read messages from.

These should be full channel names including the '#' symbol, such as
"#logstash".

For passworded channels, add a space and the channel password, such as
"#logstash password".


[id="plugins-{type}s-{plugin}-get_stats"]
===== `get_stats` 

  * Value type is <<boolean,boolean>>
  * Default value is `false`

Gather and send user counts for channels - this requires catch_all and will force it

[id="plugins-{type}s-{plugin}-host"]
===== `host` 

  * This is a required setting.
  * Value type is <<string,string>>
  * There is no default value for this setting.

Host of the IRC Server to connect to.

[id="plugins-{type}s-{plugin}-nick"]
===== `nick` 

  * Value type is <<string,string>>
  * Default value is `"logstash"`

IRC Nickname

[id="plugins-{type}s-{plugin}-password"]
===== `password` 

  * Value type is <<password,password>>
  * There is no default value for this setting.

IRC Server password

[id="plugins-{type}s-{plugin}-port"]
===== `port` 

  * Value type is <<number,number>>
  * Default value is `6667`

Port for the IRC Server

[id="plugins-{type}s-{plugin}-real"]
===== `real` 

  * Value type is <<string,string>>
  * Default value is `"logstash"`

IRC Real name

[id="plugins-{type}s-{plugin}-secure"]
===== `secure` 

  * Value type is <<boolean,boolean>>
  * Default value is `false`

Set this to true to enable SSL.

[id="plugins-{type}s-{plugin}-stats_interval"]
===== `stats_interval` 

  * Value type is <<number,number>>
  * Default value is `5`

How often in minutes to get the user count stats

[id="plugins-{type}s-{plugin}-user"]
===== `user` 

  * Value type is <<string,string>>
  * Default value is `"logstash"`

IRC Username



[id="plugins-{type}s-{plugin}-common-options"]
include::{include_path}/{type}.asciidoc[]