add notes to create an emergency user #1703
Conversation
|
@stevepiercy can you check wording and spelling please? |
| An emergency user is one that you can use to regain administrative access to a Plone site. | ||
| If you lose the administrator password, or you inherit a project without proper documentation, you can create an emergency user. | ||
|
|
||
| First of all, do the following steps not in a production environment! |
There was a problem hiding this comment.
What would someone do in a Production environment? Are they out of luck?
There was a problem hiding this comment.
Of course, you can do this operations in a production env, but you should not do this. ;-)
There was a problem hiding this comment.
What should someone do in production instead? We can't say "don't do this", then in the next section say "do this". It's very confusing.
Perhaps you can include what are the consequences and risks of doing this in production, aside from the obvious, specifically that the site will be down while adding the emergency user.
There was a problem hiding this comment.
@1letter can you answer the following questions? I want to move this PR forward.
- What should someone do in production instead?
- If someone does this in production, what are the risks?
- In which environments is it OK to do this?
|
Here are direct links to the RTD pull request preview: |
|
The failing linkcheck for Docker Linux install can be ignored, as I fixed it in #1704. @robgietema for https://nickcms.org, can you check its status? linkcheck says it is not responding. Alternatively, should I use https://docs.nickcms.org/ or https://github.com/robgietema/nick? Please advise. |
|
|
||
| ```{important} | ||
| You should always stop your Plone site before adding a new user. | ||
| ``` |
There was a problem hiding this comment.
Why? This is only necessary if the site uses a ZODB filestorage directly without using ZEO or Relstorage (then the storage is locked and can't be accessed by multiple processes at once).
| ```shell | ||
| ./venv/bin/instance stop | ||
| ./venv/bin/addzopeuser -c instance/etc/zope.conf <user> <password> | ||
| ./venv/bin/instance start |
There was a problem hiding this comment.
This assumes that Plone was installed into a Python virtualenv in the venv directory. That may or may not be the case.
It also assumes there is a script named instance, which is not usually the case when Plone was installed using pip.
| bin/instance stop | ||
| bin/instance adduser <user> <password> | ||
| bin/instance start | ||
| ``` |
There was a problem hiding this comment.
This assumes the buildout includes a plone.recipe.zope2instance section named instance. That may or may not be the case.
|
@1letter would you please respond to @davisagli's suggestions? Let's get this finished and published! |
There was a problem hiding this comment.
This should now go in docs/admin-guide and be linked under the "Operate" heading of https://6.docs.plone.org/admin-guide/index.html
i created a subdirectory for users and groups and add a file with a short description to create an emergency user in a pip and buildout based installation of Plone.
📚 Documentation preview 📚: https://plone6--1703.org.readthedocs.build/