Merge pull request #438 from kelseyhightower/document-osx-setup

docs: document running Registry natively on OS X

docs/osx-setup-guide.md

@@ -0,0 +1,56 @@
+# OS X Setup Guide
+
+This guide will walk you through running the new Go based [Docker registry](https://github.com/docker/distribution) on your local OS X machine.
+
+## Checkout the Docker Distribution source tree
+
+```
+mkdir -p $GOPATH/src/github.com/docker
+git clone https://github.com/docker/distribution.git $GOPATH/src/github.com/docker/distribution
+cd $GOPATH/src/github.com/docker/distribution
+```
+
+## Build the registry binary
+
+```
+GOPATH=$(PWD)/Godeps/_workspace:$GOPATH make binaries
+sudo cp bin/registry /usr/local/libexec/registry
+```
+
+## Setup
+
+Copy the registry configuration file in place:
+
+```
+mkdir /Users/Shared/Registry
+cp docs/osx/config.yml /Users/Shared/Registry/config.yml
+```
+
+## Running the Docker Registry under launchd
+
+Copy the Docker registry plist into place:
+
+```
+plutil -lint docs/osx/com.docker.registry.plist
+cp docs/osx/com.docker.registry.plist ~/Library/LaunchAgents/
+chmod 644 ~/Library/LaunchAgents/com.docker.registry.plist
+```
+
+Start the Docker registry:
+
+```
+launchctl load ~/Library/LaunchAgents/com.docker.registry.plist
+```
+
+### Restarting the docker registry service
+
+```
+launchctl stop com.docker.registry
+launchctl start com.docker.registry
+```
+
+### Unloading the docker registry service
+
+```
+launchctl unload ~/Library/LaunchAgents/com.docker.registry.plist
+```

docs/osx/com.docker.registry.plist

@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+<plist version="1.0">
+<dict>
+	<key>Label</key>
+	<string>com.docker.registry</string>
+	<key>KeepAlive</key>
+	<true/>
+	<key>StandardErrorPath</key>
+	<string>/Users/Shared/Registry/registry.log</string>
+	<key>StandardOutPath</key>
+	<string>/Users/Shared/Registry/registry.log</string>
+	<key>Program</key>
+	<string>/usr/local/libexec/registry</string>
+	<key>ProgramArguments</key>
+	<array>
+		<string>/usr/local/libexec/registry</string>
+		<string>/Users/Shared/Registry/config.yml</string>
+	</array>
+	<key>Sockets</key>
+	<dict>
+		<key>http-listen-address</key>
+		<dict>
+			<key>SockServiceName</key>
+			<string>5000</string>
+			<key>SockType</key>
+			<string>dgram</string>
+			<key>SockFamily</key>
+			<string>IPv4</string>
+		</dict>
+		<key>http-debug-address</key>
+		<dict>
+			<key>SockServiceName</key>
+			<string>5001</string>
+			<key>SockType</key>
+			<string>dgram</string>
+			<key>SockFamily</key>
+			<string>IPv4</string>
+		</dict>
+	</dict>
+</dict>
+</plist>

docs/osx/config.yml

@@ -0,0 +1,16 @@
+version: 0.1
+log:
+  level: info
+  fields:
+    service: registry
+    environment: macbook-air
+storage:
+    cache:
+        layerinfo: inmemory
+    filesystem:
+        rootdirectory: /Users/Shared/Registry
+http:
+    addr: 0.0.0.0:5000
+    secret: mytokensecret 
+    debug:
+        addr: localhost:5001