datasette-x-forwarded-host by simonw

19 downloads this week        Star

README

datasette-x-forwarded-host

PyPI Changelog Tests License

Treat the X-Forwarded-Host header as the Host header

Installation

Install this plugin in the same environment as Datasette.

$ datasette install datasette-x-forwarded-host

Usage

Once installed, Datasette will replace the host header with the content of the incoming x-forwarded-host header.

This helps Datasette generate links to new pages that work when hosted behind a proxy that rewrites the host header.

Only use this plugin in deployment environmens where you know the x-forwarded-host header can be trusted!

This has been tested on GitHub Codespaces.

Development

To set up this plugin locally, first checkout the code. Then create a new virtual environment:

cd datasette-x-forwarded-host
python3 -mvenv venv
source venv/bin/activate

Or if you are using pipenv:

pipenv shell

Now install the dependencies and test dependencies:

pip install -e '.[test]'

To run the tests:

pytest