Skip to content

Add guest feature in admin doku - #1257

Open
Heiko-Pohl wants to merge 3 commits into
mainfrom
guest-featur-in-admin-doku
Open

Heiko-Pohl wants to merge 3 commits into
mainfrom
guest-featur-in-admin-doku

Conversation

@Heiko-Pohl

Copy link
Copy Markdown
Contributor

Adding guest feature in admin doku

@Heiko-Pohl
Heiko-Pohl requested a review from Svanvith October 28, 2026 14:18
@Heiko-Pohl Heiko-Pohl mentioned this pull request Oct 28, 2026
4 tasks done

## Prerequisites

- A running OpenCloud deployment based on `opencloud-compose`.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Would it make sense to add a link to the [opencloud-compose repository](https://github.com/opencloud-eu/opencloud-compose) here? It might be helpful for readers.

Treat the service account secret like a password. Do not share it.
:::

## Enable the Guest Feature

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I tested this with a fresh OpenCloud 9.0.0 deployment using opencloud-compose, and the Guest Feature worked by simply setting OC_ENABLE_GUEST_LINKS=true in .env, without creating custom/guest.yml.

I also confirmed that the guest service-account credentials were already present in the generated opencloud.yaml, even though the corresponding environment variables were not set.

Could we clarify whether the additional Compose configuration is necessary for fresh installations, or only for specific scenarios such as upgrades?

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

OC_ENABLE_GUEST_LINKS is already in opencloud-compose. see https://github.com/opencloud-eu/opencloud-compose/pull/409/changes

We can delete creating custom/guest.yml and write just set OC_ENABLE_GUEST_LINKS=true

@Heiko-Pohl

Copy link
Copy Markdown
Contributor Author

@asaah262 Thanks for testing! You’re right about the service account: on fresh 9.0.0 installs opencloud init already writes auth_guest.service_account, so I’ll drop the env vars and only point to the config migration for upgrades. Regarding .env: in the current docker-compose.yml OC_ENABLE_GUEST_LINKS isn’t forwarded to the container. Could you check docker compose exec opencloud printenv OC_ENABLE_GUEST_LINKS on your setup? If it returns true, I’ll simplify the guide accordingly.

@asaah262

asaah262 commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

@Heiko-Pohl Thanks for the clarification!

I double-checked my opencloud-compose setup, and docker compose exec opencloud printenv OC_ENABLE_GUEST_LINKS returns true.

The variable is already forwarded in docker-compose.yml (line 58):

OC_ENABLE_GUEST_LINKS: "${OC_ENABLE_GUEST_LINKS:-false}"

I enabled it by setting OC_ENABLE_GUEST_LINKS=true in .env and recreating the container.

I'm using opencloud-compose commit 91911a5, in case we're looking at different revisions.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants