https://github.com/ether/ep_headerauth

Etherpad plugin to use a reverse proxy's HTTP headers for authentication.
https://github.com/ether/ep_headerauth

Last synced: 9 months ago
JSON representation

Etherpad plugin to use a reverse proxy's HTTP headers for authentication.

• Host: GitHub
• URL: https://github.com/ether/ep_headerauth
• Owner: ether
• License: apache-2.0
• Created: 2020-08-16T04:50:56.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-03-16T21:45:25.000Z (almost 2 years ago)
• Last Synced: 2025-03-14T09:38:49.965Z (12 months ago)
• Language: JavaScript
• Homepage:
• Size: 3.49 MB
• Stars: 1
• Watchers: 4
• Forks: 6
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

          
![Publish Status](https://github.com/ether/ep_headerauth/workflows/Node.js%20Package/badge.svg) ![Backend Tests Status](https://github.com/ether/ep_headerauth/workflows/Backend%20tests/badge.svg)

# `ep_headerauth`

Etherpad plugin to use a reverse proxy's HTTP headers for authentication.

If the `X-Authenticated-User` header is present in the HTTP request coming from

your reverse proxy, then the user is considered to have already been

authenticated by your reverse proxy. The header's value is used as the user's

username.

If the `X-Authenticated-Name` header is present, the user's displayed name is

forced to that header's value.

The headers used by the plugin can be customized.

## Configuration

To use this plugin the `trustProxy` and `requireAuthentication` config items

must be set to true, otherwise it won't work as expected.

In your `settings.json`:

```

{

  // ...

  "trustProxy": true,

  "requireAuthentication": true,

  "ep_headerauth": {

    // Defaults to "x-authenticated-user"

    "username_header": "x-authenticated-user",

    // Defaults to "x-authenticated-name"

    "displayname_header": "x-authenticated-name"

  },

  // ...

}

```

## Copyright and License

Copyright © 2020 Richard Hansen 

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.