# unrealircd

**Repository Path**: uesoft/unrealircd

## Basic Information

- **Project Name**: unrealircd
- **Description**: Official UnrealIRCd repository. Downloads are available from our site
- **Primary Language**: Unknown
- **License**: GPL-2.0
- **Default Branch**: unreal60_dev
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-01-20
- **Last Updated**: 2026-09-24

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[![Twitter Follow](https://img.shields.io/twitter/follow/Unreal_IRCd.svg?style=social&label=Follow)](https://twitter.com/Unreal_IRCd)
[![Linux CI](https://github.com/unrealircd/unrealircd/actions/workflows/linux-ci.yml/badge.svg)](https://github.com/unrealircd/unrealircd/actions/workflows/linux-ci.yml)

## 本项目定制：Docker 构建与部署（UESoft）

本仓库是 UESoft 的 UnrealIRCd 定制版（基于上游 6.x），包含自研第三方模块：
`gsp-core`、`gsp-db`、`gsp-bridge`、`gomoku`、`ai-battle`、`ueadmin-auth`。
所有模块随镜像一起编译打包，升级时无需手动拷贝文件到服务器。

### 镜像约定

| 镜像 | tag | 用途 |
|---|---|---|
| `roasal55/unrealircd-builder` | 与运行镜像相同 | 编译镜像，仅本地构建用，不推送 |
| `roasal55/unrealircd` | git 短 hash，工作区未提交时追加 `-uncommitted-<8hex>`；另打 `latest` | 运行镜像，推送到 Docker Hub |

### 本地构建（Windows PowerShell）

```powershell
.\docker-build-push.ps1              # 构建 builder → runtime → 打 latest 并推送
.\docker-build-push.ps1 -SkipPush    # 仅本地构建，不推送
.\docker-build-push.ps1 -Help        # 查看全部选项
```

Linux/macOS 下等价使用 `./docker-build-push.sh`。

### 服务器部署 / 升级

```bash
cd /home/roasal/unrealircd        # docker-compose.yml 所在目录
docker compose pull               # 拉取最新 latest 镜像
docker compose up -d              # 镜像有更新时自动重建容器
docker compose logs -f unrealircd # 观察启动日志
```

数据卷 `./data/ircd` 挂载到容器 `/ircd`，只存放运行状态：
`conf/ data/ logs/ tmp/ cache/`。

> **重要**：模块（`*.so`）和库属于代码，始终从镜像内加载，**不要放入数据卷**
> （卷上遗留的旧版本目录可直接删除）。如需加载镜像外的临时模块，在配置里用
> 绝对路径：`loadmodule "/ircd/modules-custom/xxx.so";`

常用运维：

```bash
# 校验配置语法（不改运行中的服务）
docker exec unrealircd sh -c \
  '/home/builder/unrealircd/bin/unrealircd -c'
# 仅重启（改了 conf 之后）
docker compose restart unrealircd
```

完整细节（配置示例、故障排查、TLS 等）见
[doc/DOCKER-DEPLOYMENT.md](doc/DOCKER-DEPLOYMENT.md)。

---

以下为上游原文。

## About UnrealIRCd
UnrealIRCd is an Open Source IRC Server, serving thousands of networks since 1999.
It runs on Linux, OS X and Windows and is currently the most widely deployed IRCd
with a market share of 38%. UnrealIRCd is a highly advanced IRCd with a strong
focus on modularity and security. It uses an advanced and highly configurable
configuration file. Other key features include: full IRCv3 support, SSL/TLS,
cloaking, advanced anti-flood and anti-spam systems, GeoIP, remote includes,
and lots of [other features](https://www.unrealircd.org/docs/About_UnrealIRCd).
We are also particularly proud on our extensive online documentation.

## Versions
* UnrealIRCd 6 is the *stable* series since December 2021. It is the only supported version.
* For full details of release scheduling and EOL dates, see
  [UnrealIRCd releases](https://www.unrealircd.org/docs/UnrealIRCd_releases) on the wiki

## How to get started
Follow the installation guide on the wiki. See:
* [Installing from source for *NIX](https://www.unrealircd.org/docs/Installing_from_source)
* [Installation instructions for Windows](https://www.unrealircd.org/docs/Installing_(Windows))

## Documentation & FAQ
You can find all **documentation** online at: https://www.unrealircd.org/docs/

We also have a good **FAQ**: https://www.unrealircd.org/docs/FAQ

## Website, support, and other links ##
* https://www.unrealircd.org - Our main website
* https://forums.unrealircd.org - Support
* https://bugs.unrealircd.org - Bug tracker
* ircs://irc.unrealircd.org:6697/unreal-support - IRC support