feat: add Chocolatey package and Linux/macOS install script with automated publishing

This commit is contained in:
HueByte
2026-02-24 19:44:46 +01:00
parent 38df05df41
commit 045515369c
9 changed files with 339 additions and 10 deletions
+30 -10
View File
@@ -1,12 +1,33 @@
# Getting Started
## Prerequisites
## Install the Client
- [.NET 10 SDK](https://dotnet.microsoft.com/download)
### Windows (Chocolatey)
Or grab a self-contained binary from [Releases](https://github.com/HueByte/EchoHub/releases) -- no runtime needed.
```bash
choco install echohub
```
## Docker
### Linux / macOS
```bash
curl -sSfL https://raw.githubusercontent.com/HueByte/EchoHub/master/scripts/install.sh | sh
```
To install a specific version or to a custom directory:
```bash
curl -sSfL .../install.sh | sh -s -- --version 0.2.8
curl -sSfL .../install.sh | sh -s -- --install-dir /opt/echohub
```
### Manual Download
Grab a self-contained binary from [Releases](https://github.com/HueByte/EchoHub/releases) -- no runtime needed.
## Host a Server
### Docker
The quickest way to host a server:
@@ -17,24 +38,23 @@ docker compose up -d
See the [Docker guide](docker.md) for configuration, pre-built images, and more.
## Run the Server
### From Source
```bash
dotnet run --project src/EchoHub.Server
```
Requires [.NET 10 SDK](https://dotnet.microsoft.com/download).
On first run, the server automatically:
1. Creates `appsettings.json` from the example config
2. Generates a secure JWT secret
3. Creates the SQLite database with a `#general` channel
## Run the Client
```bash
dotnet run --project src/EchoHub.Client
```
## Usage
After installing the client, run `echohub` (or `dotnet run --project src/EchoHub.Client` from source).
Connect to a server, register an account, and start chatting.
## Connect via IRC