@@ -11,96 +11,99 @@ myst:
1111
1212# Zope manager users
1313
14- Zope manager users have full access to the whole Zope instance.
14+ This guide explains how to add a Zope user with the " manager" role—called a "Zope manager user"— to an existing Zope instance.
1515
16- Some installation methods automatically create a zope ` admin ` user for you already .
16+ Zope manager users have full access to the whole Zope instance .
1717
18- This guide explains how to add a Zope manager user to an existing Zope instance .
18+ Some installation methods automatically create a Zope manager user named ` admin ` for you already .
1919
20- There are multiple reasons why you might need to do that, such as:
20+ There are multiple reasons why you might need to add a Zope manager user, including the following.
2121
22- - Your installation method did not create one.
23- - You lost access to your instance.
24- - You inherited a project without proper documentation.
22+ - Your installation method did not create one.
23+ - You lost access to your instance.
24+ - You inherited a project without proper documentation.
2525
2626``` {note}
27- If you need to regain access to your instance, this user is also referred to as an **emergency user**.
28- ```
27+ If you need to regain access to your instance, this user is also referred to as an "emergency user" in this context only.
2928
30- ``` {note}
3129The emergency user is a superuser with full access to the Zope instance.
3230It is not limited to a specific Plone site.
3331Please be aware of the security implications.
34- You might want to change the passwords of the already existing manager users after you regained to your instance.
32+ Consider changing the passwords of the existing Zope manager users after you regain access to your instance.
3533```
3634
37- (admin-guide-adding -a-new-zope-manager-user-label)=
35+ (admin-guide-add -a-new-zope-manager-user-label)=
3836
3937## Add a new Zope manager user
4038
41- There are multiple ways to create a Zope manager user.
42- That depends on how you created and managed your Zope instance.
39+ There are multiple methods to create a Zope manager user.
40+ The method depends on how you created and manage your Zope instance, either via {term} ` buildout ` or {term} ` pip ` .
4341
4442``` {important}
45- If you are running a standalone instance, it must be stopped before adding the user.
43+ If you are running a standalone instance, you must stop it before adding the user.
4644```
4745
48- (admin-guide-using-the- adduser-instance-command-label)=
46+ (admin-guide-adduser-instance-command-label)=
4947
50- ### Using the ` adduser ` instance command
48+ ### ` adduser ` instance command
5149
52- If your site was installed with ` buildout ` and ` plone.recipe.zope2instance ` , you can add a Zope manager user via an instance script.
50+ If your site was installed with ` buildout ` and ` plone.recipe.zope2instance ` , you can add a Zope manager user via the instance script.
5351
54- Run the following command in the terminal:
52+ Run the following command.
5553
56- ``` bash
57- $ bin/instance adduser username password
58- Created user: username
54+ ``` shell
55+ bin/instance adduser username password
5956```
6057
6158The name of the instance script might vary based on your installation.
6259Replace ` username ` and ` password ` with the desired values.
6360
64- If the user already exists:
61+ If the command is successful, then it will return the following console output.
6562
66- - No user will be created
67- - The password will not be changed
63+ ``` console
64+ Created user: username
65+ ```
6866
69- The command will return a message like this :
67+ When you run the script, if the user already exists :
7068
71- ``` bash
72- $ bin/instance adduser foo baz
73- Created user: None
74- ```
69+ - No user will be created.
70+ - The password will not be changed.
71+ - The command will return a message such as the following.
7572
76- (admin-guide-using-the-addzopeuser-command-label)=
73+ ``` console
74+ Created user: None
75+ ```
7776
78- ### Using the ` addzopeuser ` command
77+ (admin-guide- addzopeuser- command-label)=
7978
80- For ` pip ` based installations, you will have a script called ` addzopeuser ` in the ` bin ` directory of your virtual environment.
79+ ### ` addzopeuser` script
8180
81+ For `pip` based installations, you will have a script called `addzopeuser` in the {file}`bin` directory of your virtual environment.
8282The `addzopeuser` script might also be available in `buildout` based installations.
8383
84- Run in the terminal:
84+ Run the following command.
8585
86- ``` bash
86+ ```shell
8787$ .venv/bin/addzopeuser -c path/to/etc/zope.conf username password
88- User username created.
8988```
9089
91- The ` addzopeuser ` script and ` zope.conf ` locations might vary based on your installations .
90+ The ` addzopeuser ` script and {file} ` zope.conf ` locations might vary based on your installation .
9291Replace ` username ` and ` password ` with the desired values.
9392
94- If the user already exists:
93+ If the command is successful, then it will return the following console output.
94+
95+ ``` console
96+ User username created.
97+ ```
9598
96- - No user will be created
97- - The password will not be changed
99+ When you run the script, if the user already exists:
98100
99- The command will return a message like this:
101+ - No user will be created.
102+ - The password will not be changed.
103+ - The command will return a message such as the following.
100104
101- ``` bash
102- $ .venv/bin/addzopeuser -c tmp/zeoclient/etc/zope.conf foo baz
103- Got no result back. User creation may have failed.
104- Maybe the user already exists and nothing is done then.
105- Or the implementation does not give info when it succeeds.
106- ```
105+ ``` console
106+ Got no result back. User creation may have failed.
107+ Maybe the user already exists and nothing is done then.
108+ Or the implementation does not give info when it succeeds.
109+ ```
0 commit comments