diff --git a/docs/1.10/administration/configure_project_settings.md b/docs/1.10/administration/configure_project_quotas.md similarity index 88% rename from docs/1.10/administration/configure_project_settings.md rename to docs/1.10/administration/configure_project_quotas.md index cec118df2..1687e646c 100644 --- a/docs/1.10/administration/configure_project_settings.md +++ b/docs/1.10/administration/configure_project_quotas.md @@ -2,16 +2,7 @@ ---------- -# Configure Project Settings - -You can configure Harbor so that only system administrators can create projects, and set limits on the amounts of resources that projects can consume. - -## Set Who Can Create Projects - -Use the **Project Creation** drop-down menu to set which users can create projects. Select **Everyone** to allow all users to create projects. Select **Admin Only** to allow only users with the Harbor system administrator role to create projects. -![browse project](../../img/new_proj_create.png) - -## Set Project Quotas +# Configure Project Quotas To exercise control over resource use, as a Harbor system administrator you can set quotas on projects. You can limit the number of tags that a project can contain and limit the amount of storage capacity that a project can consume. You can set default quotas that apply to all projects globally. diff --git a/docs/1.10/administration/general_settings.md b/docs/1.10/administration/general_settings.md new file mode 100644 index 000000000..adeb18892 --- /dev/null +++ b/docs/1.10/administration/general_settings.md @@ -0,0 +1,45 @@ +[Back to table of contents](../index.md) + +---------- + +# Configure Global Settings + +You can configure Harbor to connect to an email server, set the registry in read-only mode, and configure Harbor so that only system administrators can create projects. + +## Configure an Email Server + +You can configure Harbor to connect to an email server. The email server is only used to send out responses to users who request to reset their password. + +![browse project](../../img//new_config_email.png) + +## Make the Registry Read Only + +You can set Harbor to read-only mode. In read-only mode, Harbor allows `docker pull` but prevents `docker push` and the deletion of repositories and tags. + +![Read-only mode](../../img//read_only.png) + +If it set to true, deleting repositories, tags and pushing images are not permitted. + +![browse project](../../img//read_only_enable.png) + + +``` +$ docker push 10.117.169.182/demo/ubuntu:14.04 +The push refers to a repository [10.117.169.182/demo/ubuntu] +0271b8eebde3: Preparing +denied: The system is in read only mode. Any modification is prohibited. +``` + +## Set Who Can Create Projects + +Use the **Project Creation** drop-down menu to set which users can create projects. Select **Everyone** to allow all users to create projects. Select **Admin Only** to allow only users with the Harbor system administrator role to create projects. +![browse project](../../img/new_proj_create.png) + +## Set Who Can Create Projects + +Use the **Project Creation** drop-down menu to set which users can create projects. Select **Everyone** to allow all users to create projects. Select **Admin Only** to allow only users with the Harbor system administrator role to create projects. +![browse project](../../img/new_proj_create.png) + +---------- + +[Back to table of contents](../index.md) \ No newline at end of file diff --git a/docs/1.10/administration/index.md b/docs/1.10/administration/index.md index 3ed1fdac0..ff326ee77 100644 --- a/docs/1.10/administration/index.md +++ b/docs/1.10/administration/index.md @@ -6,8 +6,8 @@ The operations that are performed by the Harbor system administrator are the fol - Select database, LDAP/Active Directory, or OIDC based authentication. For information, see [Configuring Authentication](configure_authentication/configure_authentication.md). - Add users in database authentication mode and assign the system administrator role to other users. For information, see [Role Based Access Control](managing_users/rbac.md). -- Set the registry to read-only mode. For information, see [Make the Registry Read Only](registry_read_only.md). -- Configure how projects are created, and apply resource quotas to projects. For information, see [Configure Project Settings](configure_project_settings.md). +- Configure global settings, such as configuring an email server, setting the registry to read-only mode, and restriction who can create projects. For information, see [Configure Global Settings](general_settings.md). +- Apply resource quotas to projects. For information, see [Configure Project Quotas](configure_project_quotas.md). - Set up replication of images between Harbor and another Harbor instance or a 3rd party replication target. For information, see [Configuring Replication](configuring_replication/configuring_replication.md). - Set up vulnerability scanners to check the images in the registry for CVE vulnerabilities. For information, see [Vulnerability Scanning](vulnerability_scanning/vulnerability_scanning.md). - Perform garbage collection, to remove unnecessary data from Harbor. For information, see [Garbage Collection](garbage_collection.md). diff --git a/docs/1.10/administration/managing_users/create_users_db.md b/docs/1.10/administration/managing_users/create_users_db.md index 3ed181e38..26e313c80 100644 --- a/docs/1.10/administration/managing_users/create_users_db.md +++ b/docs/1.10/administration/managing_users/create_users_db.md @@ -19,7 +19,7 @@ In database authentication mode, the Harbor system administrator creates user ac - The email address is used for password recovery - The password must contain at least 8 characters with 1 lowercase letter, 1 uppercase letter and 1 numeric character -If users forget their password, there is a **Forgot Password** in the Harbor log in page. +If users forget their password, there is a **Forgot Password** in the Harbor log in page. To use this feature, you must [configure an email server](general_settings.md). ---------- diff --git a/docs/1.10/administration/managing_users/email_server.md b/docs/1.10/administration/managing_users/email_server.md deleted file mode 100644 index df29a2aec..000000000 --- a/docs/1.10/administration/managing_users/email_server.md +++ /dev/null @@ -1,13 +0,0 @@ -[Back to table of contents](../../index.md) - ----------- - -# Configure an Email Server - -You can configure Harbor to connect to an email server. The email server is only used to send out responses to users who request to reset their password. - -![Configure email settings](../../img//new_config_email.png) - ----------- - -[Back to table of contents](../../index.md) \ No newline at end of file diff --git a/docs/1.10/administration/registry_read_only.md b/docs/1.10/administration/registry_read_only.md deleted file mode 100644 index 422eddabb..000000000 --- a/docs/1.10/administration/registry_read_only.md +++ /dev/null @@ -1,25 +0,0 @@ -[Back to table of contents](../index.md) - ----------- - -# Make the Registry Read Only - -You can set Harbor to read-only mode. In read-only mode, Harbor allows `docker pull` but prevents `docker push` and the deletion of repositories and tags. - -![Read-only mode](../../img//read_only.png) - -If it set to true, deleting repositories, tags and pushing images are not permitted. - -![browse project](../../img//read_only_enable.png) - - -``` -$ docker push 10.117.169.182/demo/ubuntu:14.04 -The push refers to a repository [10.117.169.182/demo/ubuntu] -0271b8eebde3: Preparing -denied: The system is in read only mode. Any modification is prohibited. -``` - ----------- - -[Back to table of contents](../index.md) \ No newline at end of file diff --git a/docs/1.10/index.md b/docs/1.10/index.md index aeb8e7d20..71a8a2956 100644 --- a/docs/1.10/index.md +++ b/docs/1.10/index.md @@ -31,9 +31,8 @@ This section describes how to use and maintain Harbor after deployment. These da - [Role Based Access Control](administration/managing_users/rbac.md) - [User Permissions By Role](administration/managing_users/user_permissions_by_role.md) - [Create User Accounts in Database Mode](administration/managing_users/create_users_db.md) - - [Configure an Email Server](administration/managing_users/email_server.md) -- [Make the Registry Read Only](administration/registry_read_only.md) -- [Configure Project Settings](administration/configure_project_settings.md) +- [Configure Global Settings](administration/general_settings.md) +- [Configure Project Quotas](administration/configure_project_quotas.md) - [Configuring Replication](administration/configuring_replication/configuring_replication.md) - [Create Replication Endpoints](administration/configuring_replication/create_replication_endpoints.md) - [Create Replication Rules](administration/configuring_replication/create_replication_rules.md)