{"id":28746239,"url":"https://github.com/ether/ep_guest","last_synced_at":"2025-10-24T18:42:37.236Z","repository":{"id":37057175,"uuid":"463420415","full_name":"ether/ep_guest","owner":"ether","description":"Etherpad plugin to grant limited access to users that are not logged in.","archived":false,"fork":false,"pushed_at":"2025-02-17T12:03:43.000Z","size":328,"stargazers_count":2,"open_issues_count":2,"forks_count":3,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-02-17T13:21:55.763Z","etag":null,"topics":["etherpad","plugin"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ether.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-02-25T06:18:39.000Z","updated_at":"2025-02-17T12:03:46.000Z","dependencies_parsed_at":"2023-02-16T12:15:34.647Z","dependency_job_id":"74b651ce-758b-4313-acc5-079476d2e853","html_url":"https://github.com/ether/ep_guest","commit_stats":{"total_commits":159,"total_committers":6,"mean_commits":26.5,"dds":0.6163522012578616,"last_synced_commit":"eb6d220e05b8c444b3c3e56949fb9af4e586eaae"},"previous_names":[],"tags_count":35,"template":false,"template_full_name":null,"purl":"pkg:github/ether/ep_guest","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ether%2Fep_guest","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ether%2Fep_guest/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ether%2Fep_guest/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ether%2Fep_guest/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ether","download_url":"https://codeload.github.com/ether/ep_guest/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ether%2Fep_guest/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260175645,"owners_count":22970015,"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","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":["etherpad","plugin"],"created_at":"2025-06-16T14:30:53.253Z","updated_at":"2025-10-24T18:42:32.178Z","avatar_url":"https://github.com/ether.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Publish Status](https://github.com/ether/ep_guest/workflows/Node.js%20Package/badge.svg) ![Backend Tests Status](https://github.com/ether/ep_guest/workflows/Backend%20tests/badge.svg)\n\n# ep\\_guest\n\n![Screenshot](docs/img/screenshot.png)\n\nEtherpad plugin that grants limited access to users that are not logged in via\nanother authentication plugin such as\n[ep\\_openid\\_connect](https://www.npmjs.com/package/ep_openid_connect).\n\nWhen a user first visits Etherpad, they will be \"authenticated\" as a guest user\nwith permissions configured by the administrator. A \"log in\" button in the user\ndrop-down list forces the user to authenticate via Etherpad's built-in HTTP\nbasic authentication or via an authentication plugin (if one is installed).\nAfter logging in, the \"log in\" button becomes a \"log out\" button.\n\nThis is a fork of\n[ep\\_readonly\\_guest](https://github.com/ether/ep_readonly_guest) that allows\nadmins to relax that plugin's read-only restriction.\n\n## Configuration\n\n#### Minimal Example\n\n```json\n  \"requireAuthentication\": true,\n```\n\n#### Full Example\n\nThe following is equivalent to the above minimal example:\n\n```json\n  \"requireAuthentication\": true,\n  \"ep_guest\": {\n    \"username\": \"guest\"\n  },\n  \"users\": {\n    \"guest\": {\n      \"displayname\": \"Read-Only Guest\",\n      \"displaynameChangeable\": false,\n      \"readOnly\": true\n    }\n  },\n```\n\n#### Details\n\n  * `requireAuthentication`: Must be explicitly set to `true` to enable this\n    plugin.\n  * `ep_guest.username` (optional, defaults to `\"guest\"`): The username used for\n    the guest account. The corresponding object in the `users` setting (see\n    below) contains settings for the guest account.\n  * `users[ep_guest.username]` (optional, default is described below): Object in\n    `users` that holds settings for the guest account. Relevant properties:\n      * `displayname` (optional): See the\n        [ep\\_user\\_displayname](https://github.com/ether/ep_user_displayname#configuration)\n        plugin.\n      * `displaynameChangeable` (optional): See the\n        [ep\\_user\\_displayname](https://github.com/ether/ep_user_displayname#configuration)\n        plugin.\n      * `readOnly` (optional): See [Etherpad's `settings.json`\n        documentation](https://github.com/ether/etherpad-lite/blob/1.8.17/settings.json.template#L446-L447).\n      * `canCreate` (optional): See [Etherpad's `settings.json`\n        documentation](https://github.com/ether/etherpad-lite/blob/1.8.17/settings.json.template#L448-L449).\n\n#### Default guest user settings\n\nIf `settings.json` (or another plugin) does not define a user object for the\nguest user, an object like the following is used:\n\n```json\n{\n  \"displayname\": \"Read-Only Guest\",\n  \"displaynameChangeable\": false,\n  \"readOnly\": true\n}\n```\n\n## Copyright and License\n\nCopyright © 2022 the ep\\_guest authors and contributors\\\nCopyright © 2020–2022 the ep\\_reaonly\\_guest authors and contributors\n\nLicensed under the [Apache License, Version 2.0](LICENSE) (the \"License\"); you\nmay not use this file except in compliance with the License. You may obtain a\ncopy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software distributed\nunder the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR\nCONDITIONS OF ANY KIND, either express or implied. See the License for the\nspecific language governing permissions and limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fether%2Fep_guest","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fether%2Fep_guest","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fether%2Fep_guest/lists"}