Skip to content

Commit

Permalink
Add account section and update settings and security (docker#20350)
Browse files Browse the repository at this point in the history
* add account section and update admin pages

* update hub build and security sections

* update toc

* Update content/accounts/_index.md

* Update .github/labeler.yml

---------

Co-authored-by: Craig Osterhout <103533812+craig-osterhout@users.noreply.github.com>
  • Loading branch information
stephaurelio and craig-osterhout authored Jul 17, 2024
1 parent 3e38e62 commit 37e129a
Show file tree
Hide file tree
Showing 18 changed files with 255 additions and 96 deletions.
5 changes: 5 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
Expand Up @@ -124,6 +124,11 @@ area/storage:
- any-glob-to-any-file:
- content/storage/**

area/accounts:
- changed-files:
- any-glob-to-any-file:
- content/accounts/**

hugo:
- changed-files:
- any-glob-to-any-file:
Expand Down
1 change: 1 addition & 0 deletions .github/vale/config/vocabularies/Docker/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ Git
GitHub( Actions)?
Google
Grafana
Gravatar
HTTP
HyperKit
IPs?
Expand Down
32 changes: 32 additions & 0 deletions content/accounts/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
description: Learn how to create and manage your Docker account.
keywords: accounts, docker ID, account management, account settings, docker account, docker home
title: Docker account overview
grid:
- title: Create a Docker ID
description: Get started with Docker and create an account.
icon: fingerprint
link: /docker-id/
- title: Manage account
description: Learn how to manage the settings for your account.
icon: manage_accounts
link: /accounts/manage-account/
- title: Account FAQ
description: Explore popular FAQ topics about organizations.
icon: help
link: /faq/admin/general-faqs/
- title: Personal access tokens
description: Learn how to create and manage access tokens for your account.
icon: password
link: /security/for-developers/access-tokens/
- title: Set up two-factor authentication
description: Add an extra layer of authentication to your Docker account.
link: /security/for-developers/2fa/
icon: phonelink_lock
---

You can create a Docker account to secure a Docker ID, which is a username for your account that lets you access Docker products. You can use your Docker account to sign in to Docker products like Docker Hub, Docker Desktop, or Docker Scout. You can centrally manage your [Docker account settings](https://app.docker.com/settings), as well as account security features, in [Docker Home](https://app.docker.com).

In this section, explore how you can create, manage, or update your account.

{{< grid >}}
50 changes: 50 additions & 0 deletions content/accounts/deactivate-user-account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
---
title: Deactivating a user account
description: Learn how to deactivate a Docker user account.
keywords: Docker Hub, delete, deactivate, account, account management
---

You can deactivate an account at any time. This section describes the prerequisites and steps to deactivate a user account. For information on deactivating an organization, see [Deactivating an organization](../admin/deactivate-account.md).

>**Warning**
>
> All Docker products and services that use your Docker account will be inaccessible after deactivating your account.
{ .warning }

## Prerequisites

Before deactivating your Docker account, ensure that you meet the following requirements:

- You must not be a member of a company or any teams or organizations. You must remove the account from all teams, organizations, or the company.

To do this:
1. Navigate to **Organizations** and then select the organization(s) you need to leave.
2. Find your username in the **Members** tab.
3. Select the **More options** menu and then select **Leave organization**.

- If you are the sole owner of an organization, either assign another member of the organization the owner role and then remove yourself from the organization, or deactivate the organization. Similarly, if you are the sole owner of a company, either add someone else as a company owner and then remove yourself, or deactivate the company.

- If you have an active Docker subscription, [downgrade it to a Docker Personal subscription](../subscription/core-subscription/downgrade.md).

- If you have an active Docker Build Cloud Paid subscription, [downgrade it to a Docker Build Cloud Starter subscription](../billing/build-billing.md#downgrade-your-subscription).

- If you have an active Docker Scout subscription, [downgrade it to a Docker Scout Free subscription](../billing/scout-billing.md#downgrade-your-subscription).

- Download any images and tags you want to keep. Use `docker pull -a <image>:<tag>`.

- Unlink your [GitHub and Bitbucket accounts](../docker-hub/builds/link-source.md#unlink-a-github-user-account).

## Deactivate

Once you have completed all the previous steps, you can deactivate your account.

> **Warning**
>
> This cannot be undone. Be sure you've gathered all the data you need from your account before deactivating it.
{ .warning }

1. Sign in to your [Docker account](https://app.docker.com/login).
2. In Docker Home, select your avatar in the top-right corner to open the drop-down.
3. Select **Account settings**.
4. In the **Account management** section, select **Deactivate account** to open to deactivate account page.
5. To confirm, select **Deactivate account**.
68 changes: 68 additions & 0 deletions content/accounts/manage-account.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
---
description: Learn how to manage settings for your Docker account.
keywords: accounts, docker ID, account settings, account management, docker home
title: Manage your Docker account
---

You can centrally manage the settings for your Docker account. Here you can also take administrative actions for your account and manage your account security.

> **Tip**
>
> If your account is associated with an organization that enforces single sign-on (SSO), you may not have permissions to update your account settings. You need to contact your administrator to update your settings.
{ .tip }

## Update general settings

1. Sign in to your [Docker account](https://account.docker.com/login).
2. In Docker Home, select your avatar in the top-right corner to open the drop-down.
3. Select **Account settings**.

From here, you can take any of the following actions.

### Update account information

To update your account information, select the arrow icon. You can edit the following settings here:

- Full name
- Company
- Location
- Website
- Gravatar email

This information is visible on your account profile in Docker Hub.

Make your changes here, then select **Save** to save your settings.

### Update email address

To update your email address, select the arrow icon.

1. Enter your new email address.
2. Enter your password to confirm the change.
3. Select **Send verification email** to send a verification email to your new email address.

Once you verify your email address, your account information will update.

### Change your password

You can change your password by initiating a password reset via email.

To change your password, select **Reset password**.

Follow the instructions in the password reset email.

## Manage security settings

You can manage the security settings for your account in Docker Home.

For information on two-factor authentication (2FA) for your account, see [Enable two-factor authentication](../security/for-developers/2fa/_index.md) to get started.

For information on personal access tokens (PAT), see [Create and manage access tokens](../security/for-developers/access-tokens.md).

## Account management

You can take administrative actions for your account in Docker Home.

For more information on converting your account, see [Convert an account into an organization](../admin/convert-account.md).

For information on deactivating your account, see [Deactivating a user account](./deactivate-user-account.md).
14 changes: 9 additions & 5 deletions content/admin/convert-account.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,12 +50,16 @@ Consider the following effects of converting your account:

1. Ensure you have removed your user account from any company or teams or organizations. Also make sure that you have a new Docker ID before you convert an account. See the [Prerequisites](#prerequisites) section for details.

2. In the top-right of Docker Hub, select your account name and then from the drop-down menu, select **Account settings**.
2. Sign in to your [Docker account](https://app.docker.com/login).

3. From the **Convert Account** tab, select **Convert to Organization**.
3. In Docker Home, select your avatar in the top-right corner to open the drop-down.

4. Review the warning displayed about converting a user account. This action cannot be undone and has considerable implications for your assets and the account.
4. Select **Account settings**.

5. Enter a **Docker ID** to set an organization owner. This is the user account that will manage the organization, and the only way to access the organization settings after conversion. You cannot use the same Docker ID as the account you are trying to convert.
5. In the **Account management** section, select **Convert account**.

6. Select **Convert and Purchase** to confirm. The new owner receives a notification email. Use that owner account to sign in to your new organization.
6. Review the warning displayed about converting a user account. This action cannot be undone and has considerable implications for your assets and the account.

7. Enter a **Docker ID** to set an organization owner. This is the user account that will manage the organization, and the only way to access the organization settings after conversion. You cannot use the same Docker ID as the account you are trying to convert.

8. Select **Confirm and purchase** to confirm. The new owner receives a notification email. Use that owner account to sign in and manage the new organization.
54 changes: 10 additions & 44 deletions content/admin/deactivate-account.md
Original file line number Diff line number Diff line change
@@ -1,73 +1,39 @@
---
title: Deactivating an account or an organization
description: Learn how to deactivate a Docker Hub account or an organization
keywords: Docker Hub, delete, deactivate, account, organization
title: Deactivating an organization
description: Learn how to deactivate a Docker organization.
keywords: Docker Hub, delete, deactivate organization, account, organization management
aliases:
- /docker-hub/deactivate-account/
---

You can deactivate an account at any time.
You can deactivate an account at any time. This section describes the prerequisites and steps to deactivate an organization account. For information on deactivating a user account, see [Deactivate a user account](../accounts/deactivate-user-account.md).

>**Warning**
>
> All Docker products and services that use your Docker account or organization account will be inaccessible after deactivating your account.
{ .warning }

## Deactivate a user account

### Prerequisites

Before deactivating your Docker account, ensure that you meet the following requirements:

- You must not be a member of a company or any teams or organizations. You must remove the account from all teams, organizations, or the company.

To do this:
1. Navigate to **Organizations** and then select the organization(s) you need to leave.
2. Find your username in the **Members** tab.
3. Select the **More options** menu and then select **Leave organization**.

- If you are the sole owner of an organization, either assign another member of the organization the owner role and then remove yourself from the organization, or deactivate the organization. Similarly, if you are the sole owner of a company, either add someone else as a company owner and then remove yourself, or deactivate the company.

- If you have an active Docker subscription, [downgrade it to a Docker Personal subscription](../subscription/core-subscription/downgrade.md).

- If you have an active Docker Build Cloud Team subscription, [downgrade it to a Docker Build Cloud Starter subscription](../billing/build-billing.md#downgrade-your-subscription).

- If you have an active Docker Scout subscription, [downgrade it to a Docker Scout Free subscription](../billing/scout-billing.md#downgrade-your-subscription).

- Download any images and tags you want to keep. Use `docker pull -a <image>:<tag>`.

- Unlink your [Github and Bitbucket accounts](../docker-hub/builds/link-source.md#unlink-a-github-user-account).

### Deactivate

Once you have completed all the steps above, you can deactivate your account.

1. Select your account name in the top-right of Docker Hub and from the drop-down menu, select **Account settings**.
2. From the **Deactivate Account** tab, select **Deactivate account**.

> This cannot be undone. Be sure you've gathered all the data you need from your account before deactivating it.
{ .warning }


## Deactivate an organization
## Prerequisites

Before deactivating an organization, complete the following:

- Download any images and tags you want to keep:
`docker pull -a <image>:<tag>`.

- If you have an active Docker subscription, [downgrade it to a **Docker Free Team** subscription](../subscription/core-subscription/downgrade.md).
- If you have an active Docker subscription, [downgrade it to a free subscription](../subscription/core-subscription/downgrade.md).

- If you have an active Docker Scout subscription, [downgrade it to a Docker Scout Free subscription](../billing/scout-billing.md#downgrade-your-subscription).

- Remove all other members within the organization.

- Unlink your [Github and Bitbucket accounts](../docker-hub/builds/link-source.md#unlink-a-github-user-account).

### Deactivate
## Deactivate

Once you have completed all the previous the steps, you can deactivate your organization.
Once you have completed all the previous steps, you can deactivate your organization.

> **Warning**
>
> This cannot be undone. Be sure you've gathered all the data you need from your organization before deactivating it.
{ .warning }

Expand Down
4 changes: 4 additions & 0 deletions content/admin/faqs/general-faqs.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,3 +71,7 @@ A [service account](../../docker-hub/service-accounts.md) is a Docker ID used fo
Only someone with access to the Docker account can deactivate the account. For more details, see [Deactivating an account](../../admin/deactivate-account.md).

If the user is a member of your organization, you can remove the user from your organization. For more details, see [Remove a member or invitee](../../admin/organization/members.md#remove-a-member-from-a-team).

### How do I manage settings for a user account?

You can manage your account settings any time when you sign in to your [Docker account](https://app.docker.com/login). In Docker Home, select your avatar in the top-right navigation, then select **My Account**. You can also access this menu from any Docker web applications when you're signed in to your account. See [Manage your Docker account](/accounts/manage-account). If your account is associated with an organization that uses SSO, you may have limited access to the settings that you can control.
21 changes: 11 additions & 10 deletions content/docker-hub/builds/link-source.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,12 @@ If you are linking a source code provider to create autobuilds for a team, follo

1. Sign in to Docker Hub.

2. Select **Account settings** in the top-right drop-down navigation, then select the **Linked Accounts** tab.
2. Select the **Settings** icon in the top-right navigation, then select **Repository Settings**.

3. Select **Link provider** for the source provider you want to link.
![Repository settings menu](../images/docker-hub-repo-settings-menu.png)


3. From the **Linked accounts** tab, select **Link provider** for the source provider you want to link.

If you want to unlink your current GitHub account and relink to a new GitHub account, make sure to completely sign out of [GitHub](https://github.com/) before linking via Docker Hub.

Expand Down Expand Up @@ -97,10 +100,9 @@ To revoke Docker Hub's access to an organization's GitHub repositories:
To revoke Docker Hub's access to your GitHub account, you must unlink it both
from Docker Hub, and from your GitHub account.

1. Select **Account settings** in the top-right drop-down navigation, then open
the **Linked Accounts** section.
1. Select the **Settings** icon in the top-right navigation, then select **Repository Settings**.

2. Select the plug icon next to the source provider you want to remove.
2. From the **Linked accounts** tab, select the plug icon next to the source provider you want to remove.

3. Go to your GitHub account's **Settings** page.

Expand All @@ -119,9 +121,9 @@ code provider.

1. Sign in to Docker Hub using your Docker ID.

2. Select **Account settings** in the top-right drop-down navigation, then select the **Linked Accounts** tab.
2. Select the **Settings** icon in the top-right navigation, then select **Repository Settings**.

3. Select **Link provider** for the source provider you want to link.
3. From the **Linked accounts** tab, select **Link provider** for the source provider you want to link.

4. If necessary, sign in to Bitbucket.

Expand All @@ -135,10 +137,9 @@ unlink it both from Docker Hub, and from your Bitbucket account.

1. Sign in to Docker Hub.

2. Select **Account settings** in the top-right drop-down navigation, then open
the **Linked Accounts** section.
2. Select the **Settings** icon in the top-right navigation, then select **Repository Settings**.

3. Select the **Plug** icon next to the source provider you want to remove.
3. From the **Linked accounts** tab, select the **Plug** icon next to the source provider you want to remove.

4. Go to your Bitbucket account and navigate to **Bitbucket settings**.

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
12 changes: 12 additions & 0 deletions content/docker-hub/repos/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,18 @@ aliases:
- /engine/tutorials/dockerrepos/
---

## Manage default repository settings

You can manage the default repository settings for your personal account in Docker Hub. Select the **Settings** icon, then select **Repository Settings**.

![Repository settings menu](../images/docker-hub-repo-settings-menu.png)

Here you can manage the following:

- Default privacy: set the default repository privacy to either **Public** or **Private**.
- Linked accounts: for users with a Docker Pro, Team, or Business subscription, manage your source provider accounts to enable Automated Builds.
- Notifications: for users with a Docker Pro, Team, or Business subscription, manage how you receive notifications from autobuilds.

## Change a repository from public to private

1. Navigate to your repository.
Expand Down
4 changes: 2 additions & 2 deletions content/docker-id/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Your Docker ID becomes your username for hosted Docker services, and [Docker for

### Sign up with your email address

1. Go to the [Docker sign-up page](https://hub.docker.com/signup/).
1. Go to the [Docker sign-up page](https://app.docker.com/signup/).

2. Enter a unique, valid email address.

Expand All @@ -48,7 +48,7 @@ Your Docker ID becomes your username for hosted Docker services, and [Docker for
> To sign up with your social provider, make sure you verify your email address with your provider before you begin.
{ .important }

1. Go to the [Docker sign-up page](https://hub.docker.com/signup/).
1. Go to the [Docker sign-up page](https://app.docker.com/signup/).

2. Select your social provider, Google or GitHub.

Expand Down
Loading

0 comments on commit 37e129a

Please sign in to comment.