Update zope-manager-users.md with addzopeuser script for docker setups #1869

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

Jump to bottom

Draft

acsr wants to merge 2 commits into 6.0

from acsr-patch-1--zope-manager-users-addzopeuser-script-for-docker-setups

Draft

Update zope-manager-users.md with addzopeuser script for docker setups #1869

acsr wants to merge 2 commits into 6.0 from acsr-patch-1--zope-manager-users-addzopeuser-script-for-docker-setups

Conversation

@acsr

Copy link

Contributor

@acsr acsr commented Feb 18, 2025 •

edited by github-actions bot

Loading

Moved my notes from the original Pull Request #1703 related to ticket #1702

📚 Documentation preview 📚: https://plone6--1869.org.readthedocs.build/

@acsr


 Update zope-manager-users.md with addzopeuser script for docker setups

8083d14

Moved my notes from the original Pull Request #1703 related to ticket #1702

@acsr acsr mentioned this pull request

Feb 18, 2025

add notes to create an emergency user #1703

Merged

@stevepiercy

Copy link

Contributor

stevepiercy commented Feb 19, 2025

@acsr would you please request a review from someone who has knowledge of this scenario? The technical content is outside my knowledge and experience. I can do English and MyST grammar and syntax, but that's about it. Thank you!

@davisagli davisagli mentioned this pull request

Feb 19, 2025

Add addzopeuser command to docker-entrypoint plone/plone-backend#175

Merged

davisagli

davisagli reviewed

Feb 19, 2025

View reviewed changes

docs/admin-guide/zope-manager-users.md

- A running docker swarm stack from the full featured docker based Plone Volto deployment

- Created by current Cookieplone project template including backend, frontend, postgres, traefik, varnish:

#### Create a new Zope Manager User with a non existing user-ID

Copy link

Member

@davisagli davisagli Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"with a non existing user-ID" is a bit confusing here. This addzopeuser command is the same as the one mentioned above, it's just a different procedure for running it inside the Docker container. so we can copy some of the same explanations from above about how it behaves if the user already exists.

docs/admin-guide/zope-manager-users.md

The user is now available in the ZMI root at at /acl_users/users/manage_users

#### Hown to access the ZMI root from via basicauth and the new user

In the Volto page root use the url `/ClassicUI/aq_parent/acl_users/users/manage_users`

Copy link

Member

@davisagli davisagli Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a path, not a URL. It's relative to the hostname where the Docker container is served via Traefik.

docs/admin-guide/zope-manager-users.md

- In Volto from the browser use the url `/ClassicUI/aq_parent/acl_users/manage_access`

The new user has `Manager` role, but not `Owner` role and no `Take ownership` permission

- You can add the Owner role in the ZMI root manually, but only as the original `admin` user.

Copy link

Member

@davisagli davisagli Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Honestly I've never noticed this or run into a situation where it was necessary for a new Manager user to have the Owner role on the Zope root. It feels like unnecessary information. It's also nothing unique to using this script within the docker container.

docs/admin-guide/zope-manager-users.md

####` Remark on httpauth challenges for the ZMI `admin user in Cookieplone based Volto and ClassicUI projects using Traefik

The original cookieplone-template `project` in the above full setup includes a traefik middleware `mw-backend-auth` in the `docker-compose.yaml` `service -> backend -> labels` section. This basic httpauth overrides the ZMI httpauth for the original admin user-id.

Copy link

Member

@davisagli davisagli Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we remove this, given the solution that was merged in plone/cookieplone-templates#154?

docs/admin-guide/zope-manager-users.md

```{note}

To change the Traefik middleware basicauth password edit the yaml file in devops/stacks/[hosturl].yml named after the hostname and follow the instructions in the comments for `mw-backend-auth` to create a proper hash and redeploy the project.

Copy link

Member

@davisagli davisagli Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a different topic which should be covered in docs about the Docker stack included in the cookieplone templates, not in this chapter about Zope Manager users.

docs/admin-guide/zope-manager-users.md

in the ZMI root

at the Plonelogin

How this has impact on the Plone Volto login needs testing in your particular setup.

Copy link

Member

@davisagli davisagli Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure what these notes are about

docs/admin-guide/zope-manager-users.md

- Enter the host via ssh as root

- list the running containers: docker ps

- enter a shell in the first backend container listed: `docker exec -it [[4-digitPartOfID]] bash`

- run command in the app folder: `./docker-entrypoint.sh bin/addzopeuser -c /app/etc/relstorage.conf userid password`

Copy link

Member

@davisagli davisagli Feb 19, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The conf file can also be zope.conf or zeo.conf depending on the configuration. I submitted plone/plone-backend#175 which will make it so you can just run ./docker-entrypoint.sh addzopeuser userid password -- but that won't be available until it's merged and the next Plone 6.1.x image is released.

@acsr

Copy link

Contributor Author

acsr commented Feb 19, 2025 •

edited

Loading

@davisagli I moved over all my notes from the closed PR as a first step. I fully agree that there are duplicate informations and some stuff can be moved to the deployment Troubleshooting FAQ. I need to review your comments in detail later and I therefore changed this PR into draft status. I am also happy to see progress in other changes making some of the remarks obsolete.

@acsr acsr marked this pull request as draft

February 19, 2025 09:10

davisagli added a commit to plone/plone-backend that referenced this pull request

Feb 19, 2025

@davisagli


 Add addzopeuser command to docker-entrypoint ( #175 )

6bf76c2

This makes it easier to run the addzopeuser script with the correct
conf. Relevant to plone/documentation#1869

davisagli added a commit to plone/plone-backend that referenced this pull request

Feb 19, 2025

@davisagli


 Add addzopeuser command to docker-entrypoint ( #175 )

dffa798

This makes it easier to run the addzopeuser script with the correct
conf. Relevant to plone/documentation#1869

@davisagli davisagli mentioned this pull request

Feb 19, 2025

Backport for 6.0: Add addzopeuser command to docker-entrypoint (#175) plone/plone-backend#178

Merged

davisagli added a commit to plone/plone-backend that referenced this pull request

Feb 19, 2025

@davisagli


 Backport for 6.0: Add addzopeuser command to docker-entrypoint ( #175 ) ( ...

c6c4b8b

...#178)
This makes it easier to run the addzopeuser script with the correct
conf. Relevant to plone/documentation#1869

@stevepiercy


 Merge branch '6.0' into acsr-patch-1--zope-manager-users-addzopeuser-...

eae297e

...script-for-docker-setups

@stevepiercy stevepiercy added this to Plone Documentation

Mar 5, 2025

@github-project-automation github-project-automation bot moved this to New in Plone Documentation

Mar 5, 2025

@stevepiercy stevepiercy moved this from New to In Progress in Plone Documentation

Mar 5, 2025

Labels

None yet

3 participants

@acsr @stevepiercy @davisagli

Uh oh!

Update zope-manager-users.md with addzopeuser script for docker setups #1869

Are you sure you want to change the base?

Update zope-manager-users.md with addzopeuser script for docker setups #1869

Uh oh!

Conversation

@acsr acsr commented Feb 18, 2025 • edited by github-actions bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

stevepiercy commented Feb 19, 2025

Uh oh!

@davisagli davisagli Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

@davisagli davisagli Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

@davisagli davisagli Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

@davisagli davisagli Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

@davisagli davisagli Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

@davisagli davisagli Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

@davisagli davisagli Feb 19, 2025

Choose a reason for hiding this comment

Uh oh!

acsr commented Feb 19, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

@acsr acsr commented Feb 18, 2025 •

edited by github-actions bot

Loading

acsr commented Feb 19, 2025 •

edited

Loading