]> git.r.bdr.sh - rbdr/mobius/blob - README.md
41de347588c461d4941668e3e9b5b4a22c4cbb9a
[rbdr/mobius] / README.md
1 <picture>
2 <source media="(prefers-color-scheme: dark)" srcset="dark_logo.png">
3 <source media="(prefers-color-scheme: light)" srcset="light_logo.png">
4 <img src="dark_logo.png" alt="Mobius Logo">
5 </picture>
6
7 # Mobius
8
9 Mobius is a cross-platform command line [Hotline](https://en.wikipedia.org/wiki/Hotline_Communications) client and server implemented in Golang.
10
11 The goal of Mobius server is to make it simple to run a Hotline server on macOS, Linux, and Windows, with full compatibility for all popular Hotline clients.
12
13 The goal of the Mobius client is to make it fun and easy to connect to multiple Hotline servers through a [cool retro terminal UI](https://github.com/jhalter/mobius/wiki/Mobius-Client-Screenshot-Gallery).
14
15 ## Getting started
16
17 ### Docker
18
19 To quickly run a Hotline server with ports forwarded from the host OS to the container, run:
20
21 docker run --rm -p 5500:5500 -p 5501:5501 ghcr.io/jhalter/mobius:latest
22
23 You can now connect to localhost:5500 with your favorite Hotline client and play around, but all changes will be lost on container restart.
24
25 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.
26
27 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:
28
29 ```
30 export HLFILES=/home/myuser/hotline-files
31 mdkir $HLFILES
32
33 sudo docker run \
34 --pull=always \
35 --rm \
36 -p 5500:5500 \
37 -p 5501:5501 \
38 -v $HLFILES:/usr/local/var/mobius/config \
39 ghcr.io/jhalter/mobius:latest \
40 -init
41 ```
42
43 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.
44
45 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.
46
47 `--user 1001:1001`
48
49 You'll now find a configuration directory on your host OS populated with a default configuration:
50
51 ```
52 ❯ ls -al $HLFILES
53 total 32
54 drwxr-xr-x 8 jhalter staff 256 Jun 12 17:11 .
55 drwxr-x---+ 49 jhalter staff 1568 Jun 12 17:11 ..
56 -rw-r--r-- 1 jhalter staff 38 Jun 12 17:11 Agreement.txt
57 drwxr-xr-x 3 jhalter staff 96 Jun 12 17:11 Files
58 -rw-r--r-- 1 jhalter staff 19 Jun 12 17:11 MessageBoard.txt
59 -rw-r--r-- 1 jhalter staff 15 Jun 12 17:11 ThreadedNews.yaml
60 drwxr-xr-x 4 jhalter staff 128 Jun 12 17:11 Users
61 -rw-r--r-- 1 jhalter staff 313 Jun 12 17:11 config.yaml
62 ```
63
64 Edit `config.yaml` to get started personalizing your server.
65
66 ### Mac OS
67
68 For Mac OS the easiest path to installation is through Homebrew.
69
70 #### Client
71
72 To install the client:
73
74 brew install jhalter/mobius-hotline-client/mobius-hotline-client
75
76 Then run `mobius-hotline-client` to get started.
77
78 #### Server
79
80 To install the server:
81
82 brew install jhalter/mobius-hotline-server/mobius-hotline-server
83
84 After installation `mobius-hotline-server` will be installed at `$HOMEBREW_PREFIX/bin/mobius-hotline-server` and should be in your $PATH.
85
86 The server config file directory is under `$HOMEBREW_PREFIX/var/mobius` which by default contains:
87
88 /opt/homebrew/mobius/config/MessageBoard.txt
89 /opt/homebrew/var/mobius/config/config.yaml
90 /opt/homebrew/var/mobius/config/ThreadedNews.yaml
91 /opt/homebrew/var/mobius/config/Agreement.txt
92 /opt/homebrew/var/mobius/config/Users/guest.yaml
93 /opt/homebrew/var/mobius/config/Users/admin.yaml
94
95 Edit `/usr/local/var/mobius/config/config.yaml` to change your server name and other settings.
96
97 Edit `/usr/local/var/mobius/config/Agreement.txt` to set your server agreement.
98
99 Run `mobius-hotline-server -help` for usage options.
100
101 ### Linux
102
103 Download a compiled release for your architecture from the Releases page or follow build from source instructions
104
105 ### Windows
106
107 TODO
108
109 ### Build from source
110
111 To build from source, run:
112
113 make all
114
115 Then grab your desired build from `dist`