Merge pull request #126 from wemeya/master

add the doc of authentication, Chinese users download efficiency

contrib/docker-compose.yml.daocloud

@@ -0,0 +1,68 @@
+version: '2'
+services:
+  log:
+    image: daocloud.io/harbor/deploy_log:latest
+    volumes:
+      - /var/log/harbor/:/var/log/docker/
+    ports:
+      - 1514:514
+  registry:
+    image: daocloud.io/library/registry:2.3.0
+    volumes:
+      - /data/registry:/storage
+      - ./config/registry/:/etc/registry/
+    ports:
+      - 5001:5001
+    command:
+      /etc/registry/config.yml
+    depends_on:
+      - log
+    logging:
+      driver: "syslog"
+      options:  
+        syslog-address: "tcp://127.0.0.1:1514"
+        syslog-tag: "registry"
+  mysql:
+    image: daocloud.io/harbor/deploy_mysql:latest
+    volumes:
+      - /data/database:/var/lib/mysql
+    env_file:
+      - ./config/db/env
+    depends_on:
+      - log
+    logging:
+      driver: "syslog"
+      options:  
+        syslog-address: "tcp://127.0.0.1:1514"
+        syslog-tag: "mysql"
+  ui:
+    image: daocloud.io/harbor/deploy_ui:latest
+    env_file:
+      - ./config/ui/env
+    volumes:
+      - ./config/ui/app.conf:/etc/ui/app.conf
+      - ./config/ui/private_key.pem:/etc/ui/private_key.pem
+    depends_on:
+      - log
+    logging:
+      driver: "syslog"
+      options:  
+        syslog-address: "tcp://127.0.0.1:1514"
+        syslog-tag: "ui"
+  proxy:
+    image: daocloud.io/library/nginx:1.9
+    volumes:
+      - ./config/nginx:/etc/nginx
+    ports:
+      - 80:80
+      - 443:443
+    depends_on:
+      - mysql
+      - registry
+      - ui
+      - log
+    logging:
+      driver: "syslog"
+      options:  
+        syslog-address: "tcp://127.0.0.1:1514"
+        syslog-tag: "proxy"

docs/customize_token_service.md

@@ -0,0 +1,60 @@
+#Customize Harbor token service with your key and certificate
+
+Harbor requires Docker client to access the Harbor registry with a token. The procedure to generate a token is like [Docker Registry v2 authentication](https://github.com/docker/distribution/blob/master/docs/spec/auth/token.md). Firstly, you should make a request to the token service for a token. The token is signed by the private key. After that, you make a new request with the token to the Harbor registry, Harbor registry will verify the token with the public key in the rootcert bundle. Then Harbor registry will authorize the Docker client to push/pull images.
+
+By default, Harbor uses default private key and certificate in authentication. 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.
+
+2.If not, you can generate a root certificate using openSSL with following commands:
+  
+**1)Generate a private key:**
+
+```sh
+    $ openssl genrsa -out private_key.pem 4096    
+```
+   
+**2)Generate a certificate:** 
+```sh
+    $ openssl req -new -x509 -key private_key.pem -out root.crt -days 3650
+```   
+You are about to be asked to enter information that will be incorporated into your certificate request.
+What you are about to enter is what is called a Distinguished Name or a DN.
+There are quite a few fields but you can leave some blank
+For some fields there will be a default value,
+If you enter '.', the field will be left blank. Following are what you're asked to enter.
+
+Country Name (2 letter code) [AU]:
+
+State or Province Name (full name) [Some-State]:
+
+Locality Name (eg, city) []:
+
+Organization Name (eg, company) [Internet Widgits Pty Ltd]:
+
+Organizational Unit Name (eg, section) []:
+
+Common Name (eg,  server FQDN or YOUR name) []:
+
+Email Address []:
+
+After you execute these two commands, you will see private_key.pem and root.crt in the **current directory**, just type "ls", you'll see them.
+
+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.
+
+4.Replace the default key and certificate. Assume that you key and certificate are in the directory /root/cert, following are what you should do:
+
+```
+$ cd config/ui
+$ cp /root/cert/private_key.pem private_key.pem
+$ cp /root/cert/root.crt ../registry/root.crt
+```
+
+5.After these, go back to the Deploy directory, you can start Harbor using following command:
+```
+  $ 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) for more info.
+
+

docs/image_pulling_chinese_user.md

@@ -0,0 +1,11 @@
+### A faster way to pull images for Chinese Harbor users
+By default, Harbor not only build images according to Dockerfile but also pull images from Docker Hub. For the reason we all know, it is difficult for Chinese Harbor users to pull images from the Docker Hub. We put images on daocloud.io platform, we'll put images on other platforms later. If you have difficulty to pull images from Docker Hub, or you think it wastes too much time to build images. We recommend you to use the following way to accelerate the pulling procedure(make sure you're in the harbor diectory):
+```
+$ cd contrib
+$ cp docker-compose.yml.daocloud ../Deploy
+$ cd ../Deploy
+$ mv docker-compose.yml docker-compose.yml.bak
+$ mv docker-compose.yml.daocloud docker-compose.yml
+$ docker-compose up -d 
+```
+Then you'll see docker pulling imges faster than before.