Skip to content
This repository was archived by the owner on Dec 30, 2025. It is now read-only.

Commit a9b8e93

Browse files
committed
chore: update configuration files and documentation for IRC service port changes
- Added additional entries to .gitignore for improved file management. - Updated docker-compose configuration to reflect the disabled standard IRC port (6667) and added plaintext Atheme services connection on port 6901. - Modified environment example file to clarify the use of TLS only for IRC connections. - Adjusted README and Makefile to ensure consistency in documentation regarding the IRC service ports and connection methods.
1 parent cefc6b5 commit a9b8e93

File tree

5 files changed

+26
-24
lines changed

5 files changed

+26
-24
lines changed

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ webpanel_config/
4343
*.tmp
4444
*.swp
4545
*.bak
46+
47+
48+
4649
# WebPanel config (part of data)
4750
data/webpanel/config/
4851

Makefile

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ help:
4949
@echo " make ssl-status - Check SSL status"
5050
@echo ""
5151
@echo "🗂️ ACCESS POINTS:"
52-
@echo " 📡 IRC: localhost:6667 (standard) / localhost:6697 (SSL)"
52+
@echo " 📡 IRC: localhost:6697 (TLS only)"
5353
@echo " 🌐 WebPanel: http://localhost:8080"
5454
@echo " 📝 Logs: tail -f logs/unrealircd/ircd.log"
5555
@echo " 📋 JSON: tail -f logs/unrealircd/ircd.json.log"
@@ -96,7 +96,7 @@ up:
9696
@./scripts/prepare-config.sh
9797
@docker compose up -d
9898
@echo -e "$(GREEN)[SUCCESS]$(NC) Services started!"
99-
@echo -e "$(BLUE)[INFO]$(NC) IRC Server: localhost:6667"
99+
@echo -e "$(BLUE)[INFO]$(NC) IRC Server: localhost:6697 (TLS only)"
100100
@echo -e "$(BLUE)[INFO]$(NC) WebPanel: http://localhost:8080"
101101
@echo -e "$(BLUE)[INFO]$(NC) Log files accessible at: logs/unrealircd/"
102102

@@ -172,7 +172,7 @@ modules-installed:
172172
webpanel:
173173
@echo -e "$(PURPLE)=== WebPanel Access ===$(NC)"
174174
@echo "WebPanel URL: http://localhost:8080"
175-
@echo "IRC Server: localhost:6667 (standard) / localhost:6697 (SSL)"
175+
@echo "IRC Server: localhost:6697 (TLS only)"
176176
@echo ""
177177
@echo "To access webpanel:"
178178
@echo " 1. Start services: make up"

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ Copy `env.example` to `.env` and configure:
4848
```bash
4949
# Server Settings
5050
IRC_DOMAIN=irc.atl.chat
51-
IRC_PORT=6667
51+
# IRC_PORT=6667 # Disabled - TLS only
5252
IRC_TLS_PORT=6697
5353
IRC_RPC_PORT=8600
5454

@@ -139,9 +139,10 @@ irc.atl.chat/
139139

140140
| Port | Protocol | Service | Purpose |
141141
|------|----------|---------|---------|
142-
| 6667 | IRC | UnrealIRCd | Standard IRC |
142+
| ~~6667~~ | ~~IRC~~ | ~~UnrealIRCd~~ | ~~Standard IRC~~ (disabled - TLS only) |
143143
| 6697 | IRC+TLS | UnrealIRCd | Encrypted IRC |
144144
| 6900 | IRC+TLS | UnrealIRCd | Server links |
145+
| 6901 | IRC | UnrealIRCd | Atheme services (localhost) |
145146
| 8600 | HTTP | UnrealIRCd | JSON-RPC API |
146147
| 8000 | WebSocket | UnrealIRCd | WebSocket IRC |
147148
| 8080 | HTTP | WebPanel | Admin interface |
@@ -151,11 +152,11 @@ irc.atl.chat/
151152
### Connect to IRC
152153

153154
```bash
154-
# Standard connection
155-
irc irc.atl.chat:6667
156-
157-
# SSL connection
155+
# TLS connection (required)
158156
irc irc.atl.chat:6697
157+
158+
# Note: Plaintext connections are disabled for security
159+
# All clients must use SSL/TLS on port 6697
159160
```
160161

161162
### WebPanel

compose.yaml

Lines changed: 8 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,10 +18,7 @@ services:
1818
# Container configuration
1919
container_name: unrealircd
2020
hostname: unrealircd
21-
init: true
22-
23-
# Dependencies
24-
# (none - this is the primary service)
21+
init: true
2522

2623
# Volume mounts - aligned with Containerfile paths
2724
volumes:
@@ -37,9 +34,10 @@ services:
3734

3835
# Port mappings
3936
ports:
40-
- '${IRC_PORT:-6667}:6667' # Standard IRC port
37+
# - '${IRC_PORT:-6667}:6667' # Standard IRC port (disabled - TLS only)
4138
- '${IRC_TLS_PORT:-6697}:6697' # IRC over SSL/TLS
4239
- '${IRC_SERVER_PORT:-6900}:6900' # Server-to-server TLS
40+
- '${ATHEME_UPLINK_PORT:-6901}:6901' # Atheme services connection (plaintext)
4341
- '${IRC_RPC_PORT:-8600}:8600' # JSON-RPC API
4442
- '${IRC_WEBSOCKET_PORT:-8000}:8000' # WebSocket for web IRC clients
4543

@@ -52,7 +50,7 @@ services:
5250

5351
# Health monitoring
5452
healthcheck:
55-
test: ['CMD', 'nc', '-z', 'localhost', '6667']
53+
test: ['CMD', 'nc', '-z', 'localhost', '6697']
5654
interval: 30s
5755
timeout: 10s
5856
retries: 3
@@ -75,7 +73,7 @@ services:
7573

7674
# Container configuration
7775
container_name: atheme
78-
hostname: atheme
76+
# hostname: atheme # Removed when using network_mode
7977

8078
# Dependencies
8179
depends_on:
@@ -95,9 +93,8 @@ services:
9593
- PUID=${PUID:-1000}
9694
- PGID=${PGID:-1000}
9795

98-
# Network configuration
99-
networks:
100-
- irc-network
96+
# Network configuration - Share network with UnrealIRCd for localhost services connection
97+
network_mode: service:unrealircd
10198

10299
# Restart policy
103100
restart: unless-stopped
@@ -280,4 +277,4 @@ networks:
280277
volumes:
281278
unrealircd-webpanel-data:
282279
name: unrealircd-webpanel-data
283-
driver: local
280+
driver: local

env.example

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# IRC Server Environment Configuration
22
# ====================================
33
# Copy this file to .env and customize for your setup
4-
#
4+
#
55
# When using `make up` or `./scripts/prepare-config.sh`, env variables will
66
# be parsed and used to create the production config files via the templates.
77
#
@@ -38,7 +38,7 @@ IRC_NETWORK_NAME=atl.chat
3838
IRC_CLOAK_PREFIX=atl
3939

4040
# Network Ports
41-
IRC_PORT=6667 # Standard IRC port
41+
# IRC_PORT=6667 # Disabled - TLS only
4242
IRC_TLS_PORT=6697 # Secure IRC port (SSL/TLS)
4343
IRC_SERVER_PORT=6900 # Server-to-server linking port
4444
IRC_RPC_PORT=8600 # JSON-RPC API port
@@ -92,8 +92,9 @@ IRC_SERVICES_PASSWORD=change_me_services_password_here
9292
# Atheme Core Configuration
9393
ATHEME_SERVER_NAME=services.atl.chat
9494
ATHEME_SERVER_DESC="All Things Linux IRC Services"
95-
ATHEME_UPLINK_HOST=unrealircd
95+
ATHEME_UPLINK_HOST=127.0.0.1
9696
ATHEME_UPLINK_PORT=6901
97+
ATHEME_UPLINK_SSL_PORT=6900
9798
ATHEME_SEND_PASSWORD=change_me_atheme_send_password_here
9899
ATHEME_RECEIVE_PASSWORD=change_me_atheme_receive_password_here
99100
ATHEME_NUMERIC=00A
@@ -222,4 +223,4 @@ WEBPANEL_RPC_PASSWORD=test1234
222223

223224
# Uncomment these for development/testing environments
224225
# DEBUG=1 # Enable debug mode in scripts
225-
# VERBOSE=1 # Enable verbose logging in scripts
226+
# VERBOSE=1 # Enable verbose logging in scripts

0 commit comments

Comments
 (0)