Skip to content

Clarify and rework the docs for adding a Zope manager user #1860

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Feb 14, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 16 additions & 13 deletions docs/admin-guide/add-emergency-user.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,48 +7,49 @@ myst:
"keywords": "Plone, Zope, users, emergency user, administration, pip, buildout"
---

(user-groups-emergency-user-label)=
(admin-guide-zope-manager-user-label)=

# Zope Manager Users

Zope manager users have full access to the whole Zope instance.

Some installation methods automatically create a zope admin user for you already.
Some installation methods automatically create a zope `admin` user for you already.

The credentials for this user are usually:

- username: `admin`
- password: `admin`
This guide explains how to add a Zope manager user to an existing Zope instance.

There are multiple reasons why you might need to add a new Zope manager user, such as:
There are multiple reasons why you might need to do that, such as:

- Your installation method did not create one.
- You lost access to your instance.
- You inherited a project without proper documentation.

If you need to regain access to your instance, this user is also refered to as an emergency user.

This guide explains how to add a Zope manager user to an existing Zope instance.
```{note}
If you need to regain access to your instance, this user is also referred to as an **emergency user**.
```

```{note}
The emergency user is a superuser with full access to the Zope instance.
It is not limited to a specific Plone site.
Please be aware of the security implications.
You might want to change the passwords of the already existing manager users after you regained to your instance.
```

(user-groups-create-an-emergency-user-label)=
(admin-guide-adding-a-new-zope-manager-user-label)=

## Adding a New Zope Manager User

There are multiple ways to create a Zope manager user, depending on how you created and managed your Zope instance.
There are multiple ways to create a Zope manager user.
That depends on how you created and managed your Zope instance.

```{important}
If you are running a standalone instance, it must be stopped before adding the user.
```

(admin-guide-using-the-adduser-instance-command-label)=

### Using the `adduser` instance command

If your site was installed with `buildout`, you can add a Zope manager user via an instance script.
If your site was installed with `buildout` and `plone.recipe.zope2instance`, you can add a Zope manager user via an instance script.

Run the following command in the terminal:

Expand All @@ -72,6 +73,8 @@ $ bin/instance adduser foo baz
Created user: None
```

(admin-guide-using-the-addzopeuser-command-label)=

### Using the `addzopeuser` command

For `pip` based installations, you will have a script called `addzopeuser` in the `bin` directory of your virtual environment.
Expand Down
Loading