git.r.bdr.sh / rbdr / mobius / blame
| Commit | Line | Data |
|---|---|---|
| 6988a057 JH |
1 | # Mobius |
| 2 | ||
| 69fceb2e | 3 | Mobius is a cross-platform command line [Hotline](https://en.wikipedia.org/wiki/Hotline_Communications) server, client, and library developed in Golang. |
| 6988a057 | 4 | |
| 69fceb2e | 5 | The project aims to support Hotline functionality from versions v1.2.3 and >v1.5 (e.g. threaded news and folder transfers). |
| 6988a057 | 6 | |
| 69fceb2e | 7 | ## Project status |
| 6988a057 | 8 | |
| 69fceb2e JH |
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. | |
| 6988a057 JH |
22 | |
| 23 | #### Client | |
| 24 | ||
| 25 | brew install jhalter/mobius-hotline-client/mobius-hotline-client | |
| 26 | ||
| 69fceb2e JH |
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 | ||
| 6988a057 JH |
33 | #### Server |
| 34 | ||
| bbecef95 | 35 | brew install jhalter/mobius-hotline-server/mobius-hotline-server |
| 6988a057 | 36 | |
| 69fceb2e JH |
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 | ||
| 6988a057 JH |
54 | ### Linux |
| 55 | ||
| d8e28ebc | 56 | Download a compiled release for your architecture from the Releases page or follow build from source instructions |
| 6988a057 JH |
57 | |
| 58 | ### Windows | |
| 59 | ||
| 60 | TODO | |
| 61 | ||
| bddd9d4a JH |
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` | |
| bddd9d4a | 68 | 4. Run the image: |
| d8e28ebc | 69 | `docker run -p 5500:5500 -p 5501:5501 -v ~/mobius-config:/usr/local/var/mobius/config jhalter/mobius-hotline-server:0.3.0` |
| bddd9d4a | 70 | |
| 6988a057 | 71 | |
| 69fceb2e | 72 | ### Build from source |
| 6988a057 | 73 | |
| 69fceb2e | 74 | To build from source, run: |
| 6988a057 | 75 | |
| 69fceb2e JH |
76 | make build-client |
| 77 | make build-server |