diff --git a/docs/img/new_add_member.png b/docs/img/new_add_member.png new file mode 100644 index 000000000..675e1839c Binary files /dev/null and b/docs/img/new_add_member.png differ diff --git a/docs/img/new_browser_project.png b/docs/img/new_browser_project.png new file mode 100644 index 000000000..d374b45bf Binary files /dev/null and b/docs/img/new_browser_project.png differ diff --git a/docs/img/new_create_policy.png b/docs/img/new_create_policy.png new file mode 100644 index 000000000..d9dc603be Binary files /dev/null and b/docs/img/new_create_policy.png differ diff --git a/docs/img/new_create_project.png b/docs/img/new_create_project.png new file mode 100644 index 000000000..036de4e52 Binary files /dev/null and b/docs/img/new_create_project.png differ diff --git a/docs/img/new_manage_destination.png b/docs/img/new_manage_destination.png new file mode 100644 index 000000000..7b8778672 Binary files /dev/null and b/docs/img/new_manage_destination.png differ diff --git a/docs/img/new_manage_replication.png b/docs/img/new_manage_replication.png new file mode 100644 index 000000000..89864ca82 Binary files /dev/null and b/docs/img/new_manage_replication.png differ diff --git a/docs/img/new_policy_list.png b/docs/img/new_policy_list.png new file mode 100644 index 000000000..608bbd7fe Binary files /dev/null and b/docs/img/new_policy_list.png differ diff --git a/docs/img/new_project_log.png b/docs/img/new_project_log.png new file mode 100644 index 000000000..0207b8fdb Binary files /dev/null and b/docs/img/new_project_log.png differ diff --git a/docs/img/new_remove_update_member.png b/docs/img/new_remove_update_member.png new file mode 100644 index 000000000..313ed19a0 Binary files /dev/null and b/docs/img/new_remove_update_member.png differ diff --git a/docs/img/new_search.png b/docs/img/new_search.png new file mode 100644 index 000000000..cee714551 Binary files /dev/null and b/docs/img/new_search.png differ diff --git a/docs/img/new_set_admin_remove_user.png b/docs/img/new_set_admin_remove_user.png new file mode 100644 index 000000000..7d4aafe94 Binary files /dev/null and b/docs/img/new_set_admin_remove_user.png differ diff --git a/docs/user_guide.md b/docs/user_guide.md index 1a94cc5e8..d9f0e830a 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -44,50 +44,59 @@ A project in Harbor contains all repositories of an application. RBAC is applied You can create a project after you signed in. Enabling the "Public project" checkbox will make this project public. -![create project](img/create_project.png) +![create project](img/new_create_project.png) After the project is created, you can browse repositories, users and access logs using the navigation column on the left. -![browse project](img/browse_project.png) +![browse project](img/new_browse_project.png) All access logs can be listed by clicking "Logs". You can apply a filter by username, or operations and dates under "Advanced Search". -![browse project](img/project_log.png) +![browse project](img/new_project_log.png) ##Managing members of a project ###Adding members You can add members with different roles to an existing project. -![browse project](img/add_member.png) +![browse project](img/new_add_member.png) ###Updating and removing members You can update or remove a member by clicking the icon on the right. -![browse project](img/remove_update_member.png) +![browse project](img/new_remove_update_member.png) ##Replicating images If you are a system administrator, you can replicate images to a remote registry, which is called destination in Harbor. Only Harbor instance is supported as a destination for now. Click "Add New Policy" on the "Replication" tab, fill the necessary fields and click "OK", a policy for this project will be created. If "Enable" is chosen, the project will be replicated to the remote immediately, and when a new repository is pushed to this project or an existing repository is deleted from this project, the same operation will also be replicated to the destination. + +![browse project](img/new_create_policy.png) + You can enable or disable a policy in the policy list view, and only the policies which are disbled can be edited. Click a policy, jobs which belong to this policy will be listed. A job represents the progress which will replicate a repository of one project to the remote. +![browse project](img/new_policy_list.png) + ##Searching projects and repositories Entering a keyword in the search field at the top lists all matching projects and repos. The search result includes public repos and private repos you have access privilege to. -![browse project](img/search.png) +![browse project](img/new_search.png) ##Administrator options ###Managing user Administrator can add "SysAdmin" role to an ordinary user by toggling the switch under "System Admin". To delete a user, click on the recycle bin icon. -![browse project](img/set_admin_remove_user.png) +![browse project](img/new_set_admin_remove_user.png) ###Managing destination You can list, add, edit and delete destinations in the "Destination" tab. Only destinations which are not referenced by any policies can be edited. +![browse project](img/new_manage_destination.png) + ###Managing replication You can list, edit, enable and disable policies in the "Replication" tab. Make sure the policy is disabled before you edit it. +![browse project](img/new_manage_replication.png) + ##Pulling and pushing images using Docker client **NOTE: Harbor only supports Registry V2 API. You need to use Docker client 1.6.0 or higher.** @@ -153,4 +162,4 @@ $ docker run -it --name gc -v /harbor_deploy_path/harbor/Deploy/config/registry/ Replace "/harbor_deploy_path" with path where your Harbor is deployed. And if your images are not storaged in "/data/registry", replace it too. Option "--dry-run" will print the progress without removing any data. -About the details of GC, please see [GC](https://github.com/docker/distribution/blob/master/docs/garbage-collection.md) \ No newline at end of file +About the details of GC, please see [GC](https://github.com/docker/distribution/blob/master/docs/garbage-collection.md). \ No newline at end of file