https://github.com/ether/ep_guest
Etherpad plugin to grant limited access to users that are not logged in.
https://github.com/ether/ep_guest
etherpad plugin
Last synced: 4 months ago
JSON representation
Etherpad plugin to grant limited access to users that are not logged in.
- Host: GitHub
- URL: https://github.com/ether/ep_guest
- Owner: ether
- License: apache-2.0
- Created: 2022-02-25T06:18:39.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2025-02-17T12:03:43.000Z (about 1 year ago)
- Last Synced: 2025-02-17T13:21:55.763Z (about 1 year ago)
- Topics: etherpad, plugin
- Language: JavaScript
- Homepage:
- Size: 320 KB
- Stars: 2
- Watchers: 7
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
 
# ep\_guest
Etherpad plugin that grants limited access to users that are not logged in via
another authentication plugin such as
[ep\_openid\_connect](https://www.npmjs.com/package/ep_openid_connect).
When a user first visits Etherpad, they will be "authenticated" as a guest user
with permissions configured by the administrator. A "log in" button in the user
drop-down list forces the user to authenticate via Etherpad's built-in HTTP
basic authentication or via an authentication plugin (if one is installed).
After logging in, the "log in" button becomes a "log out" button.
This is a fork of
[ep\_readonly\_guest](https://github.com/ether/ep_readonly_guest) that allows
admins to relax that plugin's read-only restriction.
## Configuration
#### Minimal Example
```json
"requireAuthentication": true,
```
#### Full Example
The following is equivalent to the above minimal example:
```json
"requireAuthentication": true,
"ep_guest": {
"username": "guest"
},
"users": {
"guest": {
"displayname": "Read-Only Guest",
"displaynameChangeable": false,
"readOnly": true
}
},
```
#### Details
* `requireAuthentication`: Must be explicitly set to `true` to enable this
plugin.
* `ep_guest.username` (optional, defaults to `"guest"`): The username used for
the guest account. The corresponding object in the `users` setting (see
below) contains settings for the guest account.
* `users[ep_guest.username]` (optional, default is described below): Object in
`users` that holds settings for the guest account. Relevant properties:
* `displayname` (optional): See the
[ep\_user\_displayname](https://github.com/ether/ep_user_displayname#configuration)
plugin.
* `displaynameChangeable` (optional): See the
[ep\_user\_displayname](https://github.com/ether/ep_user_displayname#configuration)
plugin.
* `readOnly` (optional): See [Etherpad's `settings.json`
documentation](https://github.com/ether/etherpad-lite/blob/1.8.17/settings.json.template#L446-L447).
* `canCreate` (optional): See [Etherpad's `settings.json`
documentation](https://github.com/ether/etherpad-lite/blob/1.8.17/settings.json.template#L448-L449).
#### Default guest user settings
If `settings.json` (or another plugin) does not define a user object for the
guest user, an object like the following is used:
```json
{
"displayname": "Read-Only Guest",
"displaynameChangeable": false,
"readOnly": true
}
```
## Copyright and License
Copyright © 2022 the ep\_guest authors and contributors\
Copyright © 2020–2022 the ep\_reaonly\_guest authors and contributors
Licensed under the [Apache License, Version 2.0](LICENSE) (the "License"); you
may not use this file except in compliance with the License. You may obtain a
copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed
under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
CONDITIONS OF ANY KIND, either express or implied. See the License for the
specific language governing permissions and limitations under the License.