{"id":15051230,"url":"https://github.com/nextcloud/guests","last_synced_at":"2025-07-25T15:07:29.817Z","repository":{"id":37546910,"uuid":"89679807","full_name":"nextcloud/guests","owner":"nextcloud","description":"🙈 Create guest users which can only see files shared with them","archived":false,"fork":false,"pushed_at":"2025-07-22T06:14:25.000Z","size":11815,"stargazers_count":49,"open_issues_count":87,"forks_count":29,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-07-22T07:39:10.066Z","etag":null,"topics":["email-invitation","guest","guest-user","nextcloud","nextcloud-app","open-source"],"latest_commit_sha":null,"homepage":"https://apps.nextcloud.com/apps/guests","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/nextcloud.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":"AUTHORS.md","dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2017-04-28T07:25:32.000Z","updated_at":"2025-07-22T06:14:28.000Z","dependencies_parsed_at":"2023-02-18T13:30:57.458Z","dependency_job_id":"7a45f1bf-1ea0-49b5-9160-849355167d0a","html_url":"https://github.com/nextcloud/guests","commit_stats":{"total_commits":1642,"total_committers":45,"mean_commits":36.48888888888889,"dds":0.6388550548112059,"last_synced_commit":"3a0b2ac435fd20f60781e98e8faa1101c0a9519f"},"previous_names":[],"tags_count":43,"template":false,"template_full_name":null,"purl":"pkg:github/nextcloud/guests","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nextcloud%2Fguests","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nextcloud%2Fguests/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nextcloud%2Fguests/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nextcloud%2Fguests/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/nextcloud","download_url":"https://codeload.github.com/nextcloud/guests/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/nextcloud%2Fguests/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":267023054,"owners_count":24022912,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-07-25T02:00:09.625Z","response_time":70,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["email-invitation","guest","guest-user","nextcloud","nextcloud-app","open-source"],"created_at":"2024-09-24T21:32:00.913Z","updated_at":"2025-07-25T15:07:29.790Z","avatar_url":"https://github.com/nextcloud.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003c!--\n  - SPDX-FileCopyrightText: 2017-2024 Nextcloud GmbH and Nextcloud contributors\n  - SPDX-FileCopyrightText: 2015-2017 ownCloud GmbH\n  - SPDX-License-Identifier: AGPL-3.0-only AND (AGPL-3.0-or-later OR AGPL-3.0-only)\n--\u003e\n# 👥 Guests\n\n[![REUSE status](https://api.reuse.software/badge/github.com/nextcloud/guests)](https://api.reuse.software/info/github.com/nextcloud/guests)\n\nThe Nextcloud Guests app allows you to create users which can only see files shared with them and access a customizable set of apps.\n\n![image](https://github.com/nextcloud/guests/assets/1731941/e1d1f71d-458f-48c1-a837-b3c9d6d03ac3)\n\nGuests accounts can be created from the share menu by entering either the recipients email or name and choosing *Invite guest*. Once the\nshare is created the guest user will receive an email notification about the mail with a link to set their password.\n\nGuests users can only access files shared to them and cannot create any files outside of shares. Additionally, the apps accessible to guest\naccounts are whitelisted.\n\n## Installation\n\nThe app is published in the [app store](https://apps.nextcloud.com/apps/guests). It can be [installed through Nextcloud's app management UI](https://docs.nextcloud.com/server/latest/admin_manual/apps_management.html#managing-apps).\n\n## Development\n\nDevelopment is ongoing. A [CHANGELOG](https://github.com/nextcloud/guests/blob/master/CHANGELOG.md) covers the highlights. [New releases are also published](https://github.com/nextcloud-releases/guests/releases) on GitHub.\n\n## Usage\n\nGuests are be created via the Web UI or `occ guests` commands. The admin can also customize system-wide guest related behavior by going to *Administration settings-\u003eGuests* in the Web UI.\n\n### Creating a guest\n\n1. Create a guest user by typing their email address into the sharing dialog\n2. Select *Invite guest* in the menu that appears.\n\nThe guest will receive an email invitation with a link to create an account. They only have access to files which are shared with them.\n\nOptionally, when creating a guest the following values may also be specified:\n\n* Set a display name for the guest user.\n* Set a language for the invitation email (otherwise the server's [default language](https://docs.nextcloud.com/server/latest/admin_manual/configuration_server/config_sample_php_parameters.html#user-experience) will be used).\n\nAdmins/Group admins also may:\n\n* specify the group(s) to put the guest user in (see [Guest specific behavior and configuration](https://github.com/nextcloud/guests/blob/master/README.md#guest-specific-behavior-and-configuration) for details).\n\n![image](https://github.com/nextcloud/guests/assets/1731941/68edbd4f-fedc-45f0-8241-2e1cd12d04de)\n\n\u003e [!WARNING]\n\u003e While it is easy to create a new Guest, it's important to understand the default behavior and how guests interact with other features in Nextcloud. See [Guest specific behavior and configuration](https://github.com/nextcloud/guests/blob/master/README.md#guest-specific-behavior-and-configuration) for details.\n\n### Deleting a guest\n\nGuests may be deleted in the same way you would remove (or disable) regular user accounts. Guests are in the group *Guests*.\n\n### `occ` commands\n\nThe command `occ guests:add` can be used to create guest users on the command-line.\n\n```\nphp occ guests:add [--generate-password] [--password-from-env] [--display-name [DISPLAY-NAME]] [--language [LANGUAGE]] [--] \u003ccreated-by\u003e \u003cemail\u003e\n```\n\nFor example:\n\n```bash\nOC_PASS=somepassword php occ guests:add --password-from-env --display-name \"Max Mustermann\" --language \"de_DE\" admin maxmustermann@example.com\n```\n\nThe user will then be able to login with \"maxmustermann@example.com\" using the given password.\n\nWhen using `--generate-password` instead of giving a password, a random password will be generated. The guest user should then use the \"forgot password\" link to reset it.\n\n\u003e [!NOTE]\n\u003e The `occ` command will only create the guest account (i.e. it will not send out the invite email).\n\n#### List existing guest users\n\nThe following command will list existing guest users:\n```bash\n% php occ guests:list\n+---------------------------+----------------+------------+---+\n| Email                     | Name           | Invited By |   |\n+---------------------------+----------------+------------+---+\n| maxmustermann@example.com | Max Mustermann | admin      | 0 |\n+---------------------------+----------------+------------+---+\n```\n\n## Guest Specific Behavior and Configuration\n\nGuest users interact with sharing and security functionality in unique ways. Many of the default behaviors related to Guests can also be customized.\n\n\u003e [!TIP]\n\u003e It's important to understand how the Guests app interacts with other aspects of Nextcloud even if you choose to utilize the default settings.\n\n### Inviting guests (sharing)\n\nIt is possible to restrict users to only share within the groups they are members of themselves (_Settings \u003e Administration \u003e Sharing \u003e ```Restrict users to only share with users in their groups```_)\n\nIf that setting is turned on, guests can only be invited by [group admins](https://docs.nextcloud.com/server/latest/admin_manual/configuration_user/user_configuration.html).\n\nUpon invitation, the group admin must select at least one of their adminstrated groups the guest shall be member of.\n\n### Share acceptance\n\nGuest users automatically accept all files and folders that are shared with them. This is in constract to regular full users (who have to actively accept incoming shares since Nextcloud 18).\n\n### Restricting app access\n\nAdministrators can set a whitelist of apps that guest users have access to.\n\nBy default the following are allowed:\n\n* `files_trashbin`\n* `files_versions`\n* `files_sharing`\n* `files_texteditor`\n* `text`\n* `activity`\n* `firstrunwizard`\n* `photos`\n* `notifications`\n* `dashboard`\n* `user_status`\n* `weather_status`\n\nIn addition, the following apps are always whitelisted to ensure minimal functionality:\n\n* core\n* `theming`\n* `settings`\n* `avatar`\n* `files`\n* `heartbeat`\n* `dav`\n* `guests`\n* `impersonate`\n* `accessibility`\n* `terms_of_service`\n* `dashboard`\n* `weather_status`\n* `user_status`\n* `apporder`\n\n### Hide other users\n\nBy default, guests will not be able to list other users in the system, but if a guest gets added to a group they will be able\nto list users within that group (and, for example, share files with those users).\n\nAs a result, guests will be able to see each other as they are part of the same `guest` group. To prevent that behavior, you can add the `guest` group to the \"Exclude groups from sharing\" settings. You can find more information in [our documentation about sharing](https://docs.nextcloud.com/server/21/admin_manual/configuration_files/file_sharing_configuration.html).\n\n### Converting guest users to full users\n\nGuest users can be automatically converted into full users (provided by any other user back end like SAML, LDAP, OAuth, database...) on their next login. When this happens they will retain their shares.\n\nFor this to happen the following must be true:\n\n* The target (new) account needs to have the same email address as the guest account.\n* The `config.php` setting `'migrate_guest_user_data' =\u003e true,` must be added.\n\nBy default the old (guest) account will be disabled after successful conversion. The `config.php` setting `'remove_guest_account_on_conversion' =\u003e true` can be set if you want the old account to be deleted rather than disabled.\n\n## Help \u0026 Contributing\n\n- Bug reports: https://github.com/nextcloud/guests/issues (*not* for general troubleshooting assistance)\n- Enhancement ideas: https://github.com/nextcloud/guests/issues\n- Pull requests: https://github.com/nextcloud/guests/pulls\n- Troubleshooting assistance: https://help.nextcloud.com\n- Code: https://github.com/nextcloud/guests/tree/master\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnextcloud%2Fguests","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnextcloud%2Fguests","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnextcloud%2Fguests/lists"}