X-Git-Url: https://git.r.bdr.sh/rbdr/mobius/blobdiff_plain/69fceb2e93085a005c7e677a3bf6c1ddeba123aa..95b51279959956123f87f798d93ee7f1521c0caa:/README.md diff --git a/README.md b/README.md index 1c486a4..c3eb509 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,7 @@ Run `mobius-hotline-client -help` for usage options. #### Server - brew install jhalter/mobius-hotline-client/mobius-hotline-client + 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. @@ -53,12 +53,21 @@ Run `mobius-hotline-server -help` for usage options. ### Linux -Download a compiled release for your architecture from the Releases page +Download a compiled release for your architecture from the Releases page or follow build from source instructions ### Windows TODO +### Docker + +To run the Mobius server from Docker with a local directory mounted for config and files, follow these steps: + +1. Clone this repo: `git clone https://github.com/jhalter/mobius.git` +2. Copy the config dir somewhere `cp -r cmd/mobius-hotline-server/mobius/config ~/mobius-config` +4. Run the image: + `docker run -p 5500:5500 -p 5501:5501 -v ~/mobius-config:/usr/local/var/mobius/config jhalter/mobius-hotline-server:latest` + ### Build from source @@ -66,43 +75,3 @@ To build from source, run: make build-client make build-server - -## Usage - -### Precompiled binaries -To get started quickly, download the precompiled binaries for your platform: - -* [Linux]() -* [Mac OS X]() - -## Compatibility - - - -# TODO - -* Implement 1.5+ protocol account editing -* Implement folder transfer resume -* Implement file transfer queuing -* Map additional file extensions to file type and creator codes -* Implement file comment read/write -* Implement user banning -* Implement Maximum Simultaneous Downloads -* Maximum simultaneous downloads/client -* Maximum simultaneous connections/IP -* Implement server broadcast -* Implement statistics: - * Currently Connected - * Downloads in progress - * Uploads in progress - * Waiting Downloads - * Connection Peak - * Connection Counter - * Download Counter - * Upload Counter - * Since - - -# TODO - Someday Maybe - -* Implement Pitbull protocol extensions \ No newline at end of file