localslackirc(1)

NAME
localslackirc - Creates an IRC server running locally, which acts as a gateway to slack for one user.

SYNOPSIS
localslackirc [OPTIONS]

DESCRIPTION
This command starts an IRC server running on 127.0.0.1:9007 which acts as a gateway to slack for one user.
To connect to multiple instances it is necessary to run multiple instances of this software.

OPTIONS

  Options:

  -h, --help
Show the help message and exit.

-p PORT, --port PORT
    Set the port number. The default is 9007.

-i IP, --ip IP
    Set the IP (Ipv4 only) address to listen to. The default is 127.0.0.1.

-t TOKENFILE, --tokenfile TOKENFILE
    Set the token file. The default is ~/.localslackirc.

-c TOKENFILE, --cookiefile TOKENFILE
    Set the cookie file. This is only used on slack, and is only useful if your token starts with "xoxc".

-u, --nouserlist
    Don't display userlist in the IRC client.

-j, --autojoin
    Automatically join all remote channels.

-o, --override
    Allow listening on addresses that do not start with 127.*
    This is potentially dangerous.

-f --status-file
    Path to the file keeping the status. When this is set, it allows for the history to be loaded on start.

--log-suffix
    Instead of using localslackirc as ident for syslog, this appends a custom string, separated by a -.
    This is useful when running several instances, to be able to distinguish the logs.
    The default .service file uses this. Of course journald keeps track of the services but this makes it easier to have the information on text dumps or other logging daemons such as rsyslog.

--ignored-channels
    Comma separated list of channels to ignore and not automatically join on IRC.
    It is ignored unless autojoin is set.
    If a channel is in this list, the IRC client will not automatically join it, but on slack you will still be inside the channel
    This is useful to avoid off topic channels in which coworkers who can't take a hint keep re-inviting.
    The ignored channels can be joined again if needed, with a /join #channel command. However the conversation history will not be fetched.
    For channel names containing non ascii characters, their ascii representation needs to be used. Use /list to see which that is.

TOKEN
The access token is (unless specified otherwise) located in ~/.localslackirc, for information on how to obtain your token, check the README file.

ENVIRONMENT
The following environment variables are used. They override command line settings. The alternatives to switches must contain "true" to work.

COOKIE
    Alternative to --cookiefile

PORT
    Alternative to --port

TOKEN
    Alternative to --tokenfile

PROCESS_OWNER
    If running as root, this is the name of the user to switch to. If this is not specified, "nobody" will be used.
    This is very useful to start localslackirc as a service and configure which user to use in the configuration file.

IP_ADDRESS
    Alternative to --ip

OVERRIDE_LOCAL_IP
    Alternative to --override

RC_URL
    Alternative to --rc-url

STATUS_FILE
    Path to the status file

AUTOJOIN
    Alternative to --autojoin

NOUSERLIST
    Alternative to --nouserlist

LOG_SUFFIX
    Alternative to --log-suffix

IGNORED_CHANNELS
    Alternative to --ignored-channels

WEB
https://github.com/ltworf/localslackirc

AUTHOR
Salvo "LtWorf" Tomaselli <tiposchi@tiscali.it>