Update Dockerfile and README info

[rbdr/mobius] / README.md

diff --git a/README.md b/README.md
index 1c486a4b178b4035567cc26efc2d1683cd598cb7..0a16b2b9520e9c8c12ff9f6394bf0ca6c67a7d2a 100644 (file)
--- 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.
 
@@ -59,6 +59,16 @@ Download a compiled release for your architecture from the Releases page
 
     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` 
+3. Build the Docker image: `docker build . -t mobius-hotline-server:latest`
+4. Run the image:
+    `docker run --rm -p 5500:5500 -p 5501:5501 -v ~/mobius-config:/usr/local/var/mobius/config mobius-hotline-server:latest`
+
 
 ### Build from source
 
@@ -66,43 +76,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