git.r.bdr.sh - rbdr/mobius/blob - README.md

   1 <picture>
   2   <source media="(prefers-color-scheme: dark)" srcset="https://user-images.githubusercontent.com/190136/173893691-349dcf82-4fbe-431f-966b-c54817770f66.png">
   3   <source media="(prefers-color-scheme: light)" srcset="https://user-images.githubusercontent.com/190136/173893686-d07f72a6-2822-4e4b-9d61-7ba7019ba706.png">
   4 </picture>
   5
   6 # Mobius
   7
   8 Mobius is a cross-platform command line [Hotline](https://en.wikipedia.org/wiki/Hotline_Communications) client and server implemented in Golang.
   9
  10 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.
  11
  12 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).
  13
  14 ## Getting started
  15
  16 ### Docker
  17
  18 If you run Docker, you can quickly try out the Mobius server with the official image from Docker hub:
  19
  20     docker run --rm -p 5500:5500 -p 5501:5501 jhalter/mobius-hotline-server:latest
  21
  22 This will start the Mobius server with the Hotline ports 5500 and 5501 exposed on localhost using a default configuration from the image.
  23
  24 To edit the configuration and serve files from your host OS, include the `-v` option to setup a Docker [bind mount](https://docs.docker.com/storage/bind-mounts/):
  25
  26         export HLFILES=/Users/foo/HotlineFiles #
  27         docker run --rm -p 5500:5500 -p 5501:5501 -v $HLFILES:/usr/local/var/mobius/config jhalter/mobius-hotline-server:latest -init
  28
  29 You'll now find a configuration directory on your host OS populated with a default configuration:
  30
  31 ```
  32 ❯ ls -al $HLFILES
  33 total 32
  34 drwxr-xr-x   8 jhalter  staff   256 Jun 12 17:11 .
  35 drwxr-x---+ 49 jhalter  staff  1568 Jun 12 17:11 ..
  36 -rw-r--r--   1 jhalter  staff    38 Jun 12 17:11 Agreement.txt
  37 drwxr-xr-x   3 jhalter  staff    96 Jun 12 17:11 Files
  38 -rw-r--r--   1 jhalter  staff    19 Jun 12 17:11 MessageBoard.txt
  39 -rw-r--r--   1 jhalter  staff    15 Jun 12 17:11 ThreadedNews.yaml
  40 drwxr-xr-x   4 jhalter  staff   128 Jun 12 17:11 Users
  41 -rw-r--r--   1 jhalter  staff   313 Jun 12 17:11 config.yaml
  42 ```
  43
  44 Edit `config.yaml` to get started personalizing your server.
  45
  46
  47 ### Mac OS
  48
  49 For Mac OS the easiest path to installation is through Homebrew.
  50
  51 #### Client
  52
  53 To install the client:
  54
  55     brew install jhalter/mobius-hotline-client/mobius-hotline-client
  56
  57 Then run `mobius-hotline-client` to get started.
  58
  59 #### Server
  60
  61 To install the server:
  62
  63     brew install jhalter/mobius-hotline-server/mobius-hotline-server
  64
  65 After installation `mobius-hotline-server` will be installed at `$HOMEBREW_PREFIX/bin/mobius-hotline-server` and should be in your $PATH.
  66
  67 The server config file directory is under `$HOMEBREW_PREFIX/var/mobius` which by default contains:
  68
  69     /opt/homebrew/mobius/config/MessageBoard.txt
  70     /opt/homebrew/var/mobius/config/config.yaml
  71     /opt/homebrew/var/mobius/config/ThreadedNews.yaml
  72     /opt/homebrew/var/mobius/config/Agreement.txt
  73     /opt/homebrew/var/mobius/config/Users/guest.yaml
  74     /opt/homebrew/var/mobius/config/Users/admin.yaml
  75
  76 Edit `/usr/local/var/mobius/config/config.yaml` to change your server name and other settings.
  77
  78 Edit `/usr/local/var/mobius/config/Agreement.txt` to set your server agreement.
  79
  80 Run `mobius-hotline-server -help` for usage options.
  81
  82 ### Linux
  83
  84 Download a compiled release for your architecture from the Releases page or follow build from source instructions
  85
  86 ### Windows
  87
  88     TODO
  89
  90 ### Build from source
  91
  92 To build from source, run:
  93
  94     make all
  95
  96 Then grab your desired build from `dist`