diff --git a/docs/img/clair_not_ready.png b/docs/img/clair_not_ready.png index 85fbe9f13..5dd683165 100644 Binary files a/docs/img/clair_not_ready.png and b/docs/img/clair_not_ready.png differ diff --git a/docs/img/clair_not_ready2.png b/docs/img/clair_not_ready2.png index 588747e2e..8da28622d 100644 Binary files a/docs/img/clair_not_ready2.png and b/docs/img/clair_not_ready2.png differ diff --git a/docs/img/clair_ready.png b/docs/img/clair_ready.png index 387121899..fc2845ec8 100644 Binary files a/docs/img/clair_ready.png and b/docs/img/clair_ready.png differ diff --git a/docs/img/ldap_auth.png b/docs/img/ldap_auth.png index 32bed1d29..3db4bf9f2 100644 Binary files a/docs/img/ldap_auth.png and b/docs/img/ldap_auth.png differ diff --git a/docs/img/log_search_advanced.png b/docs/img/log_search_advanced.png new file mode 100644 index 000000000..c0ac422ee Binary files /dev/null and b/docs/img/log_search_advanced.png differ diff --git a/docs/img/new_auth.png b/docs/img/new_auth.png index 504f0b6d4..ef5832763 100644 Binary files a/docs/img/new_auth.png and b/docs/img/new_auth.png differ diff --git a/docs/img/new_browse_project.png b/docs/img/new_browse_project.png index 5c66edc2a..cc876780b 100644 Binary files a/docs/img/new_browse_project.png and b/docs/img/new_browse_project.png differ diff --git a/docs/img/new_config_email.png b/docs/img/new_config_email.png index 829444eee..686e3cd56 100644 Binary files a/docs/img/new_config_email.png and b/docs/img/new_config_email.png differ diff --git a/docs/img/new_create_project.png b/docs/img/new_create_project.png index e59050ccc..27069a8f6 100644 Binary files a/docs/img/new_create_project.png and b/docs/img/new_create_project.png differ diff --git a/docs/img/new_create_rule.png b/docs/img/new_create_rule.png index 31912e62e..125d26c5f 100644 Binary files a/docs/img/new_create_rule.png and b/docs/img/new_create_rule.png differ diff --git a/docs/img/new_delete_repo.png b/docs/img/new_delete_repo.png index e987e928e..fc6f9b8c8 100644 Binary files a/docs/img/new_delete_repo.png and b/docs/img/new_delete_repo.png differ diff --git a/docs/img/new_delete_tag.png b/docs/img/new_delete_tag.png index e62fd5b79..f34141901 100644 Binary files a/docs/img/new_delete_tag.png and b/docs/img/new_delete_tag.png differ diff --git a/docs/img/new_manage_endpoint.png b/docs/img/new_manage_endpoint.png index 14ef73eff..d344e6d31 100644 Binary files a/docs/img/new_manage_endpoint.png and b/docs/img/new_manage_endpoint.png differ diff --git a/docs/img/new_manage_replication.png b/docs/img/new_manage_replication.png index 9fc40af92..fd782bb46 100644 Binary files a/docs/img/new_manage_replication.png and b/docs/img/new_manage_replication.png differ diff --git a/docs/img/new_proj_create.png b/docs/img/new_proj_create.png index cf9c4ff61..5eb604cd9 100644 Binary files a/docs/img/new_proj_create.png and b/docs/img/new_proj_create.png differ diff --git a/docs/img/new_project_log.png b/docs/img/new_project_log.png index 49a602c1e..67f27282c 100644 Binary files a/docs/img/new_project_log.png 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 index 08bffa0b9..3650ed8c1 100644 Binary files a/docs/img/new_remove_update_member.png and b/docs/img/new_remove_update_member.png differ diff --git a/docs/img/new_rule_list.png b/docs/img/new_rule_list.png index d49b7526f..b734eec46 100644 Binary files a/docs/img/new_rule_list.png and b/docs/img/new_rule_list.png differ diff --git a/docs/img/new_self_reg.png b/docs/img/new_self_reg.png index 3c27f24a0..49e59be62 100644 Binary files a/docs/img/new_self_reg.png and b/docs/img/new_self_reg.png differ diff --git a/docs/img/project_configuration.png b/docs/img/project_configuration.png new file mode 100644 index 000000000..1705d9f66 Binary files /dev/null and b/docs/img/project_configuration.png differ diff --git a/docs/img/scan_all.png b/docs/img/scan_all.png index aa4c0f99c..b6cb5e99c 100644 Binary files a/docs/img/scan_all.png and b/docs/img/scan_all.png differ diff --git a/docs/img/scan_all2.png b/docs/img/scan_all2.png index e73d89451..070a326b4 100644 Binary files a/docs/img/scan_all2.png and b/docs/img/scan_all2.png differ diff --git a/docs/img/scan_policy.png b/docs/img/scan_policy.png index 643c06876..18fbcc283 100644 Binary files a/docs/img/scan_policy.png and b/docs/img/scan_policy.png differ diff --git a/docs/user_guide.md b/docs/user_guide.md index 4f80daced..d3452aa28 100644 --- a/docs/user_guide.md +++ b/docs/user_guide.md @@ -70,14 +70,28 @@ You can create a project after you signed in. Check on the "Access Level" checkb ![create project](img/new_create_project.png) -After the project is created, you can browse repositories, users and logs using the navigation tab. +After the project is created, you can browse repositories, members, logs, replication and configuration using the navigation tab. ![browse project](img/new_browse_project.png) All logs can be listed by clicking "Logs". You can apply a filter by username, or operations and dates under "Advanced Search". +![browse project](img/log_search_advanced.png) + ![browse project](img/new_project_log.png) +Project properties can be changed by clicking "Configuration". + +* To make all repositories under the project accessible to everyone, select the `Public` checkbox. + +* To prevent un-signed images under the project from being pulled, select the `Enable content trust` checkbox. + +* To prevent vulnerable images under the project from being pulled, select the `Prevent vulnerable images from running` checkbox and change the severity level of vulnerabilities. Images cannot be pulled if their level equals to or higher than the currently selected level. + +* To activate an immediate vulnerability scan on new images that are pushed to the project, select the `Automatically scan images on push` checkbox. + +![browse project](img/project_configuration.png) + ## Managing members of a project ### Adding members You can add members with different roles to an existing project. @@ -98,7 +112,7 @@ There may be a bit of delay during replication according to the situation of the **Note:** The replication feature is incompatible between Harbor instance before version 0.3.5(included) and after version 0.3.5. -Start replication by creating a rule. Click "Add Replication Rule" on the "Replication" tab, fill in the necessary fields, if there is no endpoint in the list, you need to create one, and then click "OK", a rule for this project will be created. If "Enable" is chosen, the project will be replicated to the remote immediately. +Replication can be configured by creating a rule. Click "Add Replication Rule" on the "Replication" tab and fill in the necessary fields. If there is no endpoint available in the list, you need to create one. Uncheck "Verify Remote Cert" if the remote registry uses a self-signed or an untrusted certificate. Click "OK" to create a replication rule for this project. If "Enable" is chosen, the project will be replicated to the remote registry immediately. ![browse project](img/new_create_rule.png) @@ -145,10 +159,6 @@ Use the **Project Creation** drop-down menu to set which users can create projec You can manage whether a user can sign up for a new account. This option is not available if you use LDAP authentication. ![browse project](img/new_self_reg.png) -### Managing verification of remote certificate -You can choose whether to verify remote endpoint's certification. You may need to disable certificate verification if the remote registry uses a self-signed or an untrusted certificate. -![browse project](img/new_remote_cert.png) - ### Managing email settings You can change Harbor's email settings, the mail server is used to send out responses to users who request to reset their password. ![browse project](img/new_config_email.png)