causefx před 7 roky
rodič
revize
2d3c69f154
1 změnil soubory, kde provedl 24 přidání a 1 odebrání
  1. 24 1
      README.md

+ 24 - 1
README.md

@@ -57,7 +57,30 @@ Do you have quite a bit of services running on your computer or server?  Do you
 
 [![Feature Requests](http://feathub.com/causefx/Organizr?format=svg)](http://feathub.com/causefx/Organizr)
 
-Thanks to everyone that helped!  
+<img src="https://user-images.githubusercontent.com/16184466/53667702-fcdcc600-3c2e-11e9-8828-860e531e8096.png">
+
+##### Usage
+```
+docker create \
+  --name=organizr \
+  -v <path to data>:/config \
+  -e PGID=<gid> -e PUID=<uid>  \
+  -p 80:80 \
+  organizrtools/organizr-v2
+```
+##### Parameters
+The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. So `-p 8080:80` would expose port 80 from inside the container to be accessible from the host's IP on port 8080 and `http://192.168.x.x:8080` would show you what's running INSIDE the container on port 80.
+
+* `-p 80` - The port(s)
+* `-v /config` - Mapping the config files for Organizr
+* `-e PGID` Used for GroupID - see below for explanation
+* `-e PUID` Used for UserID - see below for explanation
+
+##### Info
+* Shell access whilst the container is running: `docker exec -it organizr /bin/bash`
+* To monitor the logs of the container in realtime: `docker logs -f organizr`
+* Container version number: `docker inspect -f '{{ index .Config.Labels "build_version" }}' organizr`
+* Image version number: `docker inspect -f '{{ index .Config.Labels "build_version" }}' organizrtools/docker-organizr-v2`
 
 <img src="https://user-images.githubusercontent.com/16184466/53614287-a9b73480-3b96-11e9-9c8e-e32b4ae20c0d.png">