Upstream/harbor
1
0
Fork 0
mirror of https://github.com/goharbor/harbor.git synced 2024-11-30 06:03:45 +01:00
Code Issues Projects Releases Wiki Activity

Update auth.md

Browse Source
This commit is contained in:
wemeya 2016-04-13 18:09:59 +08:00
parent bc9f8377ca
commit 3207a8f842
1 changed files with 8 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/auth.md
View File

@ -1,25 +1,24 @@
#Customize Harbor auth with your key and certificate #Customize Harbor auth with your key and certificate
By default, Harbor use default private key and certificate in authentication. The auth procedure is like [Docker Registry v2 authentication](https://github.com/docker/distribution/blob/master/docs/spec/auth/token.md). Also, you can customize your configuration with your own key and certificate with the following steps: By default, Harbor use default private key and certificate in authentication. The auth procedure is like [Docker Registry v2 authentication](https://github.com/docker/distribution/blob/master/docs/spec/auth/token.md). If you try to connect the registry without authorization, the registry will return `401 Unauthorized`. Then you should make a request to the authorization service for a token. The token is encrypted by the private key. After that, you make a new request with the token to the registry, registry will decrypted the token with the public key in the root.crt. The registry will check the token and authorize the client the access to push/pull images.
Also, you can customize your configuration with your own key and certificate with the following steps:
1.If you already have a certificate, go to step 3. 1.If you already have a certificate, go to step 3.
2.If not, you can generate a self-signed certificate using openSSL with following commands 2.If not, you can generate a root certificate using openSSL with following commands
**1)Generate a private key:** **1)Generate a private key:**
```sh ```sh
openssl genrsa -out private_key.pem 2048 openssl genrsa -out private_key.pem 4096
``` ```
you can call it prvtkey.pem or other names you like.
**2)Generate a certificate:** **2)Generate a certificate:**
```sh ```sh
openssl req -new -x509 -key private_key.pem -out root.crt -days 1095 openssl req -new -x509 -key private_key.pem -out root.crt -days 3650
``` ```
3.Refer to [Installation Guide](https://github.com/vmware/harbor/blob/master/docs/installation_guide.md) to install Harbor, After you execute ./prepare, Harbor generates several config files. We need to replace the original private key and certificate with your own key and certificate. 3.Refer to [Installation Guide](https://github.com/vmware/harbor/blob/master/docs/installation_guide.md) to install Harbor, After you execute ./prepare, Harbor generates several config files. We need to replace the original private key and certificate with your own key and certificate.
@ -30,7 +29,7 @@ you can call it prvtkey.pem or other names you like.
**2)replace private_key.pem with your private_key.pem** **2)replace private_key.pem with your private_key.pem**
**3)cd ../registry, you will see root.crt. Replace it with your certificate root.crt** **3)cd ../registry, you will see root.crt. Replace it with your root.crt**
5.After these, go back to the Deploy directory, you can start Harbor using following command: 5.After these, go back to the Deploy directory, you can start Harbor using following command:
@ -38,6 +37,6 @@ you can call it prvtkey.pem or other names you like.
docker-compose up -d docker-compose up -d
``` ```
6.Then you can push/pull images to see if your own certificate works. Please refer [User Guide](https://github.com/vmware/harbor/blob/master/docs/user_guide.md) 6.Then you can push/pull images to see if your own certificate works. Please refer [User Guide](https://github.com/vmware/harbor/blob/master/docs/user_guide.md) for more info.