Extensive refactor, quality of life enhancements

[rbdr/mobius] / README.md

diff --git a/README.md b/README.md
index 0a16b2b9520e9c8c12ff9f6394bf0ca6c67a7d2a..5f2c7b4c11c8bd9c124a2de870d834662d445a2b 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,78 +1,173 @@
+<!--<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="dark_logo.png">
+  <source media="(prefers-color-scheme: light)" srcset="light_logo.png">
+  <img src="dark_logo.png" alt="Mobius Logo">
+</picture>
+-->
+

 # Mobius
 
 # Mobius
 

-Mobius is a cross-platform command line [Hotline](https://en.wikipedia.org/wiki/Hotline_Communications) server, client, and library developed in Golang.
+Mobius is a cross-platform command line [Hotline](https://en.wikipedia.org/wiki/Hotline_Communications) client and server implemented in Golang.
+
+- **Server Goal:** Make it simple to run a Hotline server on macOS, Linux, and Windows, with full compatibility for all popular Hotline clients.
+- **Client Goal:** Make it fun and easy to connect to multiple Hotline servers through a [terminal UI](https://github.com/jhalter/mobius/wiki/Mobius-Client-Screenshot-Gallery).
+

 
 

-The project aims to support Hotline functionality from versions v1.2.3 and >v1.5 (e.g. threaded news and folder transfers).
+## Installation

 
 

-## Project status
+Mobius is distributed through a single binary.

 
 

-### Server
+Depending on your platform and preferences, you can acquire the binary in the following ways:
+
+### Build from source

 
 

-* Near feature complete
+1. Install [Go](https://go.dev) if needed
+2. Run `make server`

 
 

-### Client
+### Download pre-built release
+
+See [Releases](https://github.com/jhalter/mobius/releases) page.
+
+
+### Docker

 
 

-* Early stage with functionality for chat and news posting only
+To run a Hotline server with a default, sample configuration with ports forwarded from the host OS to the container:

 
 

-# Getting started
+       docker run --rm -p 5500:5500 -p 5501:5501 ghcr.io/jhalter/mobius:latest

 
 

-### Mac OS
+You can now connect to localhost:5500 with your favorite Hotline client and play around, but all changes will be lost on container restart.

 
 

-For Mac OS the easiest path to installation is to install through Homebrew.
+To serve files from the host OS and persist configuration changes, you'll want to set up a [bind mount](https://docs.docker.com/storage/bind-mounts/) that maps a directory from the host into the container.

 
 

-#### Client
+To do this, create a directory in a location of your choice on the host OS.  For clarity, we'll assign the path to the `HLFILES` environment variable and re-use it.

 
 

-    brew install jhalter/mobius-hotline-client/mobius-hotline-client
+Then run the docker command with `-v` and `-init` like so:

 
 

-After installation `mobius-hotline-client` installed to `/usr/local/bin/mobius-hotline-client` and should be in your $PATH. 
+```
+export HLFILES=/home/myuser/hotline-files
+mdkir $HLFILES

 
 

-The client config file is in `/usr/local/etc/mobius-client-config.yaml`
+sudo docker run \
+    --pull=always \
+    --rm \
+    -p 5500:5500 \
+    -p 5501:5501 \
+    -v $HLFILES:/usr/local/var/mobius/config \
+    ghcr.io/jhalter/mobius:latest \
+    -init
+```

 
 

-Run `mobius-hotline-client -help` for usage options.
+It's a good security practice to run your server as a non-root user, which also happens to make editing the configuration files easier from the host OS.

 
 

-#### Server
+To do this, add the `--user` flag to the docker run arguments with a user ID and group ID of a user on the host OS.
+
+`--user 1001:1001`
+
+### Homebrew
+
+For macOS the easiest path to installation is through Homebrew, as this works around Apple's notarization requirements for downloaded pre-compiled binaries by compiling the binary on your system during brew installation.
+
+To install the server:

 
     brew install jhalter/mobius-hotline-server/mobius-hotline-server
 
 
     brew install jhalter/mobius-hotline-server/mobius-hotline-server
 

-After installation `mobius-hotline-server` installed to `/usr/local/bin/mobius-hotline-server` and should be in your $PATH.
+After installation `mobius-hotline-server` will be installed at `$HOMEBREW_PREFIX/bin/mobius-hotline-server` and should be in your $PATH.

 
 

-The server config file directory is under `/usr/local/var/mobius` which by default contains:
+The server config directory will be created under `$HOMEBREW_PREFIX/var/mobius`.

 
 

-    /usr/local/var/mobius/config/MessageBoard.txt
-    /usr/local/var/mobius/config/config.yaml
-    /usr/local/var/mobius/config/ThreadedNews.yaml
-    /usr/local/var/mobius/config/Agreement.txt
-    /usr/local/var/mobius/config/Users/guest.yaml
-    /usr/local/var/mobius/config/Users/admin.yaml
+To start the service:

 
 

-Edit `/usr/local/var/mobius/config/config.yaml` to change your server name and other settings.
+`brew services start mobius-hotline-server`

 
 

-Edit `/usr/local/var/mobius/config/Agreement.txt` to set your server agreement.

 
 

-Run `mobius-hotline-server -help` for usage options.
+## Server Configuration

 
 

-### Linux
+After you have a server binary, the next step is to configure the server.

 
 

-Download a compiled release for your architecture from the Releases page
+### Configuration directory

 
 

-### Windows
+Mobius stores its configuration and server state in a directory tree:

 
 

-    TODO
+```
+config
+├── Agreement.txt
+├── Files
+│   └── hello.txt
+├── MessageBoard.txt
+├── ThreadedNews.yaml
+├── Users
+│   ├── admin.yaml
+│   └── guest.yaml
+├── banner.jpg
+└── config.yaml
+```

 
 

-### Docker
+If you acquired the server binary by downloading it or compiling it, this directory doesn't exist yet!  But you can generate it by running the the server with the `-init` flag:

 
 

-To run the Mobius server from Docker with a local directory mounted for config and files, follow these steps:
+`./mobius-hotline-server -init -config example-config-dir`

 
 

-1. Clone this repo: `git clone https://github.com/jhalter/mobius.git`
-2. Copy the config dir somewhere `cp -r cmd/mobius-hotline-server/mobius/config ~/mobius-config` 
-3. Build the Docker image: `docker build . -t mobius-hotline-server:latest`
-4. Run the image:
-    `docker run --rm -p 5500:5500 -p 5501:5501 -v ~/mobius-config:/usr/local/var/mobius/config mobius-hotline-server:latest`
+Brew users can find the config directory in `$HOMEBREW_PREFIX/var/mobius`.

 
 

+Within this directory some files are intended to be edited to customize the server, while others are not.
+
+--- 
+
+* 🛠️ Edit this file to customize your server.
+* ⚠️ Avoid manual edits outside of special circumstances (e.g. remove offending news content).
+
+---
+
+🛠️ `Agreement.text` - The server agreement sent to users after they join the server.
+
+🛠️ `Files` - Home of your warez or any other files you'd like to share.
+
+⚠️ `MessageBoard.txt` - Plain text file containing the server's message board.  No need to edit this.
+
+⚠️ `ThreadedNews.yaml` - YAML file containing the server's threaded news.  No need to edit this.
+
+⚠️ `Users` - Directory containing user account YAML files.  No need to edit this.
+
+🛠️ `banner.jpg` - Path to server banner image.
+
+🛠️ `config.yaml` - Edit to set your server name, description, and enable tracker registration.
+
+
+### User accounts
+
+The default installation includes two users: 
+
+* guest (no password) 
+* admin (default password admin).
+
+User administration should be performed from a Hotline client.  Avoid editing the files under the `Users` directory.
+
+## Run the server
+
+By default running `mobius-hotline-server` will listen on ports 5500/5501 of all interfaces with info level logging to STDOUT.
+
+Use the -h or -help flag for a list of options:
+
+```
+$ mobius-hotline-server -h
+Usage of mobius-hotline-server:
+  -bind int
+       Base Hotline server port.  File transfer port is base port + 1. (default 5500)
+  -config string
+       Path to config root (default "/usr/local/var/mobius/config/")
+  -init
+       Populate the config dir with default configuration
+  -interface string
+       IP addr of interface to listen on.  Defaults to all interfaces.
+  -log-file string
+       Path to log file
+  -log-level string
+       Log level (default "info")
+  -stats-port string
+       Enable stats HTTP endpoint on address and port
+  -version
+       Print version and exit
+```

 
 

-### Build from source

 
 

-To build from source, run:
+To run as a systemd service, refer to this sample unit file: [mobius-hotline-server.service](https://github.com/jhalter/mobius/blob/master/cmd/mobius-hotline-server/mobius-hotline-server.service)

 
 

-    make build-client
-    make build-server