mirror of
https://github.com/distribution/distribution.git
synced 2025-06-28 08:18:18 +00:00
bb0253d1df
Incorrect directories fixed. Added explanation for ensuring port 5000 is available or changing it. There will be a subsequent fix to the plist file. Signed-off-by: andy-cooper <andrew.john.cooper@gmail.com>
95 lines
2.7 KiB
Markdown
95 lines
2.7 KiB
Markdown
---
|
|
description: Explains how to run a registry on macOS
|
|
keywords: registry, on-prem, images, tags, repository, distribution, macOS, recipe, advanced
|
|
title: macOS setup guide
|
|
---
|
|
|
|
## Use-case
|
|
|
|
This is useful if you intend to run a registry server natively on macOS.
|
|
|
|
### Alternatives
|
|
|
|
You can start a VM on macOS, and deploy your registry normally as a container using Docker inside that VM.
|
|
|
|
### Solution
|
|
|
|
Using the method described here, you install and compile your own from the git repository and run it as an macOS agent.
|
|
|
|
### Gotchas
|
|
|
|
Production services operation on macOS is out of scope of this document. Be sure you understand well these aspects before considering going to production with this.
|
|
|
|
## Setup golang on your machine
|
|
|
|
If you know, safely skip to the next section.
|
|
|
|
If you don't, the TLDR is:
|
|
|
|
```console
|
|
$ bash < <(curl -s -S -L https://raw.githubusercontent.com/moovweb/gvm/master/binscripts/gvm-installer)
|
|
$ source ~/.gvm/scripts/gvm
|
|
$ gvm install go1.4.2
|
|
$ gvm use go1.4.2
|
|
```
|
|
|
|
If you want to understand, you should read [How to Write Go Code](https://golang.org/doc/code.html).
|
|
|
|
## Checkout the source tree
|
|
|
|
```console
|
|
$ mkdir -p $GOPATH/src/github.com/distribution
|
|
$ git clone https://github.com/distribution/distribution.git $GOPATH/src/github.com/distribution/distribution
|
|
$ cd $GOPATH/src/github.com/distribution/distribution
|
|
```
|
|
|
|
## Build the binary
|
|
|
|
```console
|
|
$ GOPATH=$(PWD)/Godeps/_workspace:$GOPATH make binaries
|
|
$ sudo mkdir -p /usr/local/libexec
|
|
$ sudo cp bin/registry /usr/local/libexec/registry
|
|
```
|
|
|
|
## Setup
|
|
|
|
Copy the registry configuration file in place:
|
|
|
|
```console
|
|
$ mkdir /Users/Shared/Registry
|
|
$ cp docs/content/recipes/osx/config.yml /Users/Shared/Registry/config.yml
|
|
```
|
|
|
|
## Modify ports if needed
|
|
|
|
MacOS runs an Airplay receiver on port 5000 by default, which is the same port as the registry server. You can either disable the Airplay receiver in _System Settings… > General > AirDrop & Handoff > AirPlay Receiver_, or change the listening ports in the config file that you have just copied to /Users/Shared/Registry/config.yml.
|
|
|
|
## Run the registry under launchd
|
|
|
|
Copy the registry plist into place:
|
|
|
|
```console
|
|
$ plutil -lint docs/content/recipes/osx/com.docker.registry.plist
|
|
$ cp docs/content/recipes/osx/com.docker.registry.plist ~/Library/LaunchAgents/
|
|
$ chmod 644 ~/Library/LaunchAgents/com.docker.registry.plist
|
|
```
|
|
|
|
Start the registry:
|
|
|
|
```console
|
|
$ launchctl load ~/Library/LaunchAgents/com.docker.registry.plist
|
|
```
|
|
|
|
### Restart the registry service
|
|
|
|
```console
|
|
$ launchctl stop com.docker.registry
|
|
$ launchctl start com.docker.registry
|
|
```
|
|
|
|
### Unload the registry service
|
|
|
|
```console
|
|
$ launchctl unload ~/Library/LaunchAgents/com.docker.registry.plist
|
|
```
|