README.md


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68

# Mobius

Mobius is a cross-platform command line [Hotline](https://en.wikipedia.org/wiki/Hotline_Communications) server, client, and library developed in Golang.

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

## Project status

### Server

* Near feature complete

### Client

* Early stage with functionality for chat and news posting only

# Getting started

### Mac OS

For Mac OS the easiest path to installation is to install through Homebrew.

#### Client

    brew install jhalter/mobius-hotline-client/mobius-hotline-client

After installation `mobius-hotline-client` installed to `/usr/local/bin/mobius-hotline-client` and should be in your $PATH. 

The client config file is in `/usr/local/etc/mobius-client-config.yaml`

Run `mobius-hotline-client -help` for usage options.

#### 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.

The server config file directory is under `/usr/local/var/mobius` which by default contains:

    /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

Edit `/usr/local/var/mobius/config/config.yaml` to change your server name and other settings.

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

Run `mobius-hotline-server -help` for usage options.

### Linux

Download a compiled release for your architecture from the Releases page

### Windows

    TODO


### Build from source

To build from source, run:

    make build-client
    make build-server