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

   1 # Mobius
   2
   3 Mobius is a cross-platform command line [Hotline](https://en.wikipedia.org/wiki/Hotline_Communications) server, client, and library developed in Golang.
   4
   5 The project aims to support Hotline functionality from versions v1.2.3 and >v1.5 (e.g. threaded news and folder transfers).
   6
   7 ## Project status
   8
   9 ### Server
  10
  11 * Near feature complete
  12
  13 ### Client
  14
  15 * Early stage with functionality for chat and news posting only
  16
  17 # Getting started
  18
  19 ### Mac OS
  20
  21 For Mac OS the easiest path to installation is to install through Homebrew.
  22
  23 #### Client
  24
  25     brew install jhalter/mobius-hotline-client/mobius-hotline-client
  26
  27 After installation `mobius-hotline-client` installed to `/usr/local/bin/mobius-hotline-client` and should be in your $PATH.
  28
  29 The client config file is in `/usr/local/etc/mobius-client-config.yaml`
  30
  31 Run `mobius-hotline-client -help` for usage options.
  32
  33 #### Server
  34
  35     brew install jhalter/mobius-hotline-server/mobius-hotline-server
  36
  37 After installation `mobius-hotline-server` installed to `/usr/local/bin/mobius-hotline-server` and should be in your $PATH.
  38
  39 The server config file directory is under `/usr/local/var/mobius` which by default contains:
  40
  41     /usr/local/var/mobius/config/MessageBoard.txt
  42     /usr/local/var/mobius/config/config.yaml
  43     /usr/local/var/mobius/config/ThreadedNews.yaml
  44     /usr/local/var/mobius/config/Agreement.txt
  45     /usr/local/var/mobius/config/Users/guest.yaml
  46     /usr/local/var/mobius/config/Users/admin.yaml
  47
  48 Edit `/usr/local/var/mobius/config/config.yaml` to change your server name and other settings.
  49
  50 Edit `/usr/local/var/mobius/config/Agreement.txt` to set your server agreement.
  51
  52 Run `mobius-hotline-server -help` for usage options.
  53
  54 ### Linux
  55
  56 Download a compiled release for your architecture from the Releases page
  57
  58 ### Windows
  59
  60     TODO
  61
  62 ### Docker
  63
  64 To run the Mobius server from Docker with a local directory mounted for config and files, follow these steps:
  65
  66 1. Clone this repo: `git clone https://github.com/jhalter/mobius.git`
  67 2. Copy the config dir somewhere `cp -r cmd/mobius-hotline-server/mobius/config ~/mobius-config`
  68 3. Build the Docker image: `docker build . -t mobius-hotline-server:latest`
  69 4. Run the image:
  70     `docker run --rm -p 5500:5500 -p 5501:5501 -v ~/mobius-config:/usr/local/var/mobius/config mobius-hotline-server:latest`
  71
  72
  73 ### Build from source
  74
  75 To build from source, run:
  76
  77     make build-client
  78     make build-server