Stone_Red/EchoHub
1
0
Fork 0
mirror of https://github.com/Stone-Red-Code/EchoHub.git synced 2026-09-04 00:56:05 +02:00
Code Issues Packages Projects Releases Wiki Activity

deploy: 963c6d3384

Browse Source
This commit is contained in:
HueByte
2026-02-19 10:40:46 +00:00
parent 6db53453af
commit a60dcb4476
35 changed files with 10451 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files
articles/architecture.html
+30 -6
View File
@@ -89,38 +89,62 @@
<h2 id="overview">Overview</h2>
<p>EchoHub follows a decentralized model where each server is fully independent. There is no central authority or account federation. Users create one account per server.</p>
<p>The server exposes two protocol interfaces to the same chat backend:</p>
<pre><code class="lang-text">IRC Client ──► TCP :6667 ──► IrcGateway ──┐
├──► ChatService ──► DB + PresenceTracker
TUI Client ──► WebSocket ──► ChatHub ─────┘
</code></pre>
<p>Both protocols call into a shared <code>IChatService</code> for business logic. Events fan out to all registered <code>IChatBroadcaster</code> implementations (SignalR and IRC).</p>
<h2 id="components">Components</h2>
<h3 id="echohubcore">EchoHub.Core</h3>
<p>Shared library containing:</p>
<ul>
<li><strong>Models</strong>: <code>User</code>, <code>Channel</code>, <code>Message</code>, <code>RefreshToken</code></li>
<li><strong>DTOs</strong>: Record types for API requests/responses</li>
<li><strong>Contracts</strong>: <code>IEchoHubClient</code> -- the strongly-typed SignalR client interface</li>
<li><strong>Contracts</strong>: <code>IChatService</code> (protocol-agnostic chat operations), <code>IChatBroadcaster</code> (event fan-out interface), <code>IEchoHubClient</code> (SignalR client interface)</li>
<li><strong>Constants</strong>: <code>ValidationConstants</code> (shared regex patterns), <code>HubConstants</code></li>
</ul>
<h3 id="echohubserver">EchoHub.Server</h3>
<p>ASP.NET Core web application:</p>
<ul>
<li><strong>Controllers</strong>: REST API endpoints for auth, channels, users, files, server info</li>
<li><strong>Hubs</strong>: SignalR <code>ChatHub</code> for real-time messaging</li>
<li><strong>Hubs</strong>: SignalR <code>ChatHub</code> -- thin adapter delegating to <code>IChatService</code></li>
<li><strong>Auth</strong>: JWT token service (15-min access tokens, 30-day refresh tokens)</li>
<li><strong>Data</strong>: EF Core with SQLite</li>
<li><strong>Services</strong>: Presence tracking, file storage, image-to-ASCII conversion</li>
<li><strong>Services</strong>: <code>ChatService</code> (core business logic), <code>SignalRBroadcaster</code>, presence tracking, file storage, image-to-ASCII conversion</li>
</ul>
<h3 id="echohubserverirc">EchoHub.Server.Irc</h3>
<p>IRC protocol gateway (separate project for clean separation of concerns):</p>
<ul>
<li><strong>IrcGatewayService</strong>: <code>BackgroundService</code> with TCP listener on configured port(s), optional TLS</li>
<li><strong>IrcCommandHandler</strong>: Per-client IRC command dispatch -- handles <code>CAP</code>/<code>SASL</code>, <code>NICK</code>/<code>USER</code>/<code>PASS</code>, <code>JOIN</code>/<code>PART</code>/<code>PRIVMSG</code>/<code>QUIT</code>, <code>NAMES</code>/<code>TOPIC</code>/<code>WHO</code>/<code>WHOIS</code>/<code>AWAY</code>/<code>LIST</code>/<code>MODE</code>/<code>MOTD</code></li>
<li><strong>IrcBroadcaster</strong>: <code>IChatBroadcaster</code> implementation that formats chat events as IRC protocol lines, with echo suppression (IRC convention)</li>
<li><strong>IrcMessageFormatter</strong>: Converts <code>MessageDto</code> to IRC <code>PRIVMSG</code> lines -- splits long text at word boundaries (~400 byte chunks), sends images as ASCII art line-by-line</li>
</ul>
<p>IRC users authenticate with existing EchoHub accounts via <code>PASS</code>/<code>NICK</code>/<code>USER</code> or SASL PLAIN (BCrypt verification against the database).</p>
<h3 id="echohubclient">EchoHub.Client</h3>
<p>Terminal.Gui v2 TUI application:</p>
<ul>
<li><strong>UI</strong>: Main window, dialogs, chat renderer with ANSI color support</li>
<li><strong>Services</strong>: API client with automatic token refresh, SignalR connection wrapper</li>
<li><strong>Themes</strong>: 6 built-in color themes</li>
<li><strong>Themes</strong>: 13 built-in color themes</li>
<li><strong>Config</strong>: Client configuration management</li>
</ul>
<h2 id="communication">Communication</h2>
<ul>
<li>REST API for authentication, profile management, channel CRUD, file uploads</li>
<li>SignalR WebSocket for real-time messaging and presence updates</li>
<li><strong>REST API</strong> for authentication, profile management, channel CRUD, file uploads</li>
<li><strong>SignalR WebSocket</strong> for real-time messaging and presence updates (TUI client)</li>
<li><strong>IRC TCP</strong> for real-time messaging via standard IRC protocol (IRC clients)</li>
<li>JWT tokens passed via query string for SignalR authentication</li>
<li>IRC authentication via PASS/SASL PLAIN against BCrypt password hashes</li>
</ul>
<h2 id="broadcaster-pattern">Broadcaster Pattern</h2>
<p>The <code>IChatBroadcaster</code> interface allows multiple protocols to receive chat events:</p>
<ul>
<li><strong>SignalRBroadcaster</strong>: Wraps <code>IHubContext&lt;ChatHub&gt;</code>, filters out IRC connections</li>
<li><strong>IrcBroadcaster</strong>: Iterates live IRC connections in a channel, formats events as IRC protocol lines</li>
</ul>
<p>Both are registered in DI and called by <code>ChatService</code> when events occur. This means a message sent from an IRC client appears in the TUI client, and vice versa.</p>
</article>
articles/getting-started.html
+19
View File
@@ -91,6 +91,7 @@
<ul>
<li><a href="https://dotnet.microsoft.com/download">.NET 10 SDK</a></li>
</ul>
<p>Or grab a self-contained binary from <a href="https://github.com/HueByte/EchoHub/releases">Releases</a> -- no runtime needed.</p>
<h2 id="run-the-server">Run the Server</h2>
<pre><code class="lang-bash">dotnet run --project src/EchoHub.Server
</code></pre>
@@ -104,6 +105,24 @@
<pre><code class="lang-bash">dotnet run --project src/EchoHub.Client
</code></pre>
<p>Connect to a server, register an account, and start chatting.</p>
<h2 id="connect-via-irc">Connect via IRC</h2>
<p>Enable the IRC gateway in the server's <code>appsettings.json</code>:</p>
<pre><code class="lang-json">{
&quot;Irc&quot;: {
&quot;Enabled&quot;: true,
&quot;Port&quot;: 6667
}
}
</code></pre>
<p>Then connect with any standard IRC client:</p>
<pre><code class="lang-bash">irssi -c localhost -p 6667 -w &lt;password&gt; -n &lt;username&gt;
</code></pre>
<p>IRC users must have an existing EchoHub account. Authentication works via <code>PASS</code>/<code>NICK</code>/<code>USER</code> or SASL PLAIN. Messages flow bidirectionally between IRC and TUI clients.</p>
<p>For TLS, set <code>TlsEnabled: true</code>, <code>TlsPort: 6697</code>, and provide a PKCS#12 certificate path.</p>
<p>See the <a href="architecture.html">Architecture</a> page for details on how the IRC gateway integrates with the chat service.</p>
<h2 id="configuration">Configuration</h2>
<p>Server configuration is in <code>appsettings.json</code> (auto-generated on first run). See the <a href="https://github.com/HueByte/EchoHub/blob/master/src/EchoHub.Server/appsettings.example.json">example config</a> for all available options.</p>
<p>To list your server on the <a href="https://echohub.voidcube.cloud/servers">public directory</a>, set <code>Server:PublicServer</code> to <code>true</code> and <code>Server:PublicHost</code> to your server's public address.</p>
<h2 id="build-from-source">Build from Source</h2>
<pre><code class="lang-bash">dotnet build src/EchoHub.slnx
</code></pre>