Skip to content

Feat/docker #10

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
matheusfillipe wants to merge 16 commits into
base: main
Choose a base branch
from
Open

Feat/docker #10

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
88fb70d
Small fixes to build again
matheusfillipe Apr 18, 2026
2da3906
Add e2e tests
matheusfillipe Apr 18, 2026
61a9651
Add WebSocket support and Coolify-compatible compose config
matheusfillipe Apr 19, 2026
a1e28ed
Add JSON-RPC support, enabled via RPC_PASSWORD env var
matheusfillipe Apr 19, 2026
cc362cc
Fix websocket module loading, TLS file ownership, anti-flood deprecation
matheusfillipe Apr 19, 2026
007967b
fix missing modules.default.conf in volume-mounted conf dir
matheusfillipe Apr 19, 2026
8dd6bad
fix mkdir before cp in Dockerfile
matheusfillipe Apr 19, 2026
3815b70
fix websocket listen syntax for unrealircd 6.x
matheusfillipe Apr 19, 2026
3bd6014
try websocket text; syntax
matheusfillipe Apr 19, 2026
fad38e5
move WS_CONFIG after module includes so websocket_common is loaded first
matheusfillipe Apr 19, 2026
d67a403
restore options websocket syntax, correct position after modules
matheusfillipe Apr 19, 2026
731c55a
websocket listen block: options+type both required
matheusfillipe Apr 19, 2026
814e158
fix websocket: options{websocket{type text}} inside listen, add webse…
matheusfillipe Apr 19, 2026
ac2225c
Add custom module volume and E2E tests
matheusfillipe Apr 19, 2026
0540edf
Fix module gcc flags: add -DDYNAMIC_LINKING
matheusfillipe Apr 19, 2026
141d575
Include operclass.default.conf in template
matheusfillipe Apr 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .env.test
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
IRC_PORT=6667
SSL_PORT=6697
SERVER_NAME=irc.test.local
NETWORK_NAME=TestNet
ADMIN_EMAIL=test@example.com
34 changes: 34 additions & 0 deletions .github/workflows/e2e.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: E2E Tests

on:
push:
branches: [main]
pull_request:
branches: [main]

jobs:
e2e:
runs-on: ubuntu-latest
timeout-minutes: 20

env:
TESTCONTAINERS_RYUK_DISABLED: "true"
TESTCONTAINERS_HOST_OVERRIDE: "localhost"
TESTCONTAINERS_CONNECTION_MODE: "docker_host"

steps:
- uses: actions/checkout@v4

- uses: astral-sh/setup-uv@v4
with:
enable-cache: true

- name: Install dependencies
run: uv sync --group test

- name: Run E2E tests
run: uv run pytest tests/ -v

- name: Dump container logs on failure
if: failure()
run: docker ps -a && docker logs $(docker ps -aq --filter ancestor=unrealircd-modules-test) 2>/dev/null || true
4 changes: 3 additions & 1 deletion .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,13 @@ certs/
# Node modules (if any)
node_modules/

# Python cache (if any)
# Python
__pycache__/
*.pyc
*.pyo
*.pyd
.venv/
.pytest_cache/

# Local development overrides
docker-compose.override.yml
Expand Down
42 changes: 16 additions & 26 deletions compose.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,30 +6,22 @@ services:
container_name: obsidian-unrealircd
restart: unless-stopped
ports:
- "${IRC_PORT:-6667}:6667"
- "${SSL_PORT:-6697}:6697"
- "${SSL_HOST_PORT:-6697}:6697"
volumes:
- unrealircd_conf:/home/unrealircd/unrealircd/conf
- unrealircd_data:/home/unrealircd/unrealircd/data
- unrealircd_logs:/home/unrealircd/unrealircd/logs
- unrealircd_tls:/home/unrealircd/unrealircd/tls
environment:
- SERVER_NAME=${SERVER_NAME:-irc.example.com}
- IRC_PORT=${IRC_PORT:-6667}
- SSL_PORT=${SSL_PORT:-6697}
- NETWORK_NAME=${NETWORK_NAME:-ObsidianNetwork}
- ADMIN_EMAIL=${ADMIN_EMAIL:-admin@example.com}
- ICON_URL=${ICON_URL:-}
- FILEHOST_URL=${FILEHOST_URL:-}
- MOTD_TEXT=${MOTD_TEXT:-Welcome to ObsidianIRC! Connect and enjoy our features.}
networks:
- irc_network
- ${CONF_BIND:-unrealircd_conf}:/home/unrealircd/unrealircd/conf
- ${DATA_BIND:-unrealircd_data}:/home/unrealircd/unrealircd/data
- ${LOGS_BIND:-unrealircd_logs}:/home/unrealircd/unrealircd/logs
- ${TLS_BIND:-unrealircd_tls}:/home/unrealircd/unrealircd/tls
- ${CUSTOM_MODULES_BIND:-unrealircd_custom_modules}:/home/unrealircd/unrealircd/custom-modules
env_file:
- path: .env
required: false
healthcheck:
test: ["CMD", "nc", "-z", "localhost", "6667"]
interval: 30s
timeout: 10s
retries: 3
start_period: 40s
test: ["CMD-SHELL", "nc -z localhost 6697"]

@coderabbitai coderabbitai Bot Apr 30, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor | ⚡ Quick win

Use SSL_PORT in healthcheck to avoid config drift.

Line 20 hardcodes 6697; if SSL_PORT is overridden through .env, the service can be healthy but marked unhealthy.

Proposed fix 
-      test: ["CMD-SHELL", "nc -z localhost 6697"]
+      test: ["CMD-SHELL", "nc -z localhost $${SSL_PORT:-6697}"]
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
test: ["CMD-SHELL", "nc -z localhost 6697"]
test: ["CMD-SHELL", "nc -z localhost $${SSL_PORT:-6697}"]
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@compose.yaml` at line 20, The healthcheck currently hardcodes the port in the
test array ("test: [\"CMD-SHELL\", \"nc -z localhost 6697\"]"), which will drift
if SSL_PORT is overridden; update the healthcheck to use the SSL_PORT
environment variable (e.g., replace the literal 6697 with ${SSL_PORT}) so the
container's healthcheck reads the same value as SSL_PORT and won't be marked
unhealthy when the port is changed.

interval: 5s
timeout: 5s
retries: 6
start_period: 10s

volumes:
unrealircd_conf:
Expand All @@ -40,7 +32,5 @@ volumes:
driver: local
unrealircd_tls:
driver: local

networks:
irc_network:
driver: bridge
unrealircd_custom_modules:
driver: local
225 changes: 0 additions & 225 deletions docker/DOCKER_README.md
View file
Open in desktop

This file was deleted.

7 changes: 6 additions & 1 deletion docker/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ RUN apk add --no-cache \
libsodium-dev \
jansson-dev \
curl-dev \
sqlite-dev \
wget \
tar \
gettext \
Expand All @@ -34,7 +35,6 @@ RUN mv unrealircd-* unrealircd-source
WORKDIR /tmp/unrealircd-source

# Copy our custom modules from repository root
COPY --chown=unrealircd:unrealircd o-icon.c src/modules/third/
COPY --chown=unrealircd:unrealircd o-filehost.c src/modules/third/
COPY --chown=unrealircd:unrealircd obsidianirc.c src/modules/third/
COPY --chown=unrealircd:unrealircd obsidian.h include/
Expand All @@ -55,6 +55,11 @@ RUN echo "1" | ./Config \
# Switch back to root for final setup
USER root

# Save default conf files outside the volume mount point so they survive volume mounts
RUN mkdir -p /etc/unrealircd/conf-defaults \
&& cp -r /home/unrealircd/unrealircd/conf/. /etc/unrealircd/conf-defaults/ \
&& chmod -R a+rX /etc/unrealircd/

# Create directories for runtime
RUN mkdir -p /home/unrealircd/unrealircd/conf \
&& mkdir -p /home/unrealircd/unrealircd/data \
Expand Down
Loading
Loading