ircb 0.3.0

# ircb

一个多功能的IRC跳转器。

## 要求

- Python3.5
- Pip3.5


## 安装

- 安装依赖

``[sudo] pip3.5 install -r requirements.txt``

- 复制并扩展

``ircb/config/default_settings.py``，根据需要，到一个自定义位置。例如，``/etc/ircb/settings.py``。

- [可选] ``export IRCB_SETTINGS=<your custom settings file path>``

- 将项目作为开发依赖安装

``python3.5 setup.py develop``

## 开发安装

- 安装系统依赖

`` sudo dnf install python3-devel openssl-devel redis``

`` sudo pip install virtualenvwrapper``

- 创建 `python3` 虚拟环境

``mkvirtualenv --python=/usr/bin/python3 python3``

- 激活虚拟环境

``workon python3``

- 安装依赖

``pip3 install -r requirements.txt``

- 将项目作为开发依赖安装

``python3.5 setup.py develop``

- 确保 `REDIS` 正在运行

``sudo systemctl start redis.service``

- 现在，你需要运行 ``ircb stores``

``ircb run stores``

继续进行 `` 设置数据``

## 设置数据
- 创建用户
```
ircb users create USERNAME EMAIL [PASSWORD]
```

- 为用户创建网络
```
ircb networks create USER NETWORK_NAME HOST PORT NICK
```
您将在上述操作中获取一个访问令牌。使用此令牌作为
**服务器密码** 配置您的IRC客户端连接到 ``ircb``。

## 运行应用程序

### 快速入门
```
sudo ircb run allinone

```

注意：如果您正在使用virtualenv，则这种方式将无法使用 `sudo`，您需要
运行

```
sudo ~/.virtualenvs/python3/bin/ircb run allinone

```
### 高级

您可以以不同的进程运行 ``ircb`` 的各个组件：``stores``、``bouncers``。


- 以不同的进程运行 stores: ``ircb run stores``
- 运行 bouncer: ``ircb run bouncer``
- 运行 web 服务器: ``ircb run web``
- 运行 identd 服务器: ``sudo ircb run identd``

## 连接到 IRC 客户端

现在，您应该能够从您的 IRC 客户端连接到 ``ircb``，地址为：

- 主机/端口：``localhost/9000``

- 服务器密码：``<您的网络访问令牌>``

- IRC 客户端应启用以下设置

* 在此网络上的所有服务器上使用 SSL
* 接受无效 SSL 证书

### 配置 HexChat

- 前往 HexChat -> 网络列表

- 将昵称更改为您配置网络时指定的昵称

- 在“网络”下点击“添加”，并将服务器命名为“ircb”

- 点击“编辑”然后“添加”，并输入 `localhost/9000`

- 在“服务器”选项卡中检查上述提到的“SSL”选项

- 在“密码”字段中输入“服务器密码”

- 关闭对话框，然后连接到网络

注意：如果问题持续存在，请尝试“重启”ircb 服务器