mirror of https://github.com/hedgedoc/hedgedoc.git synced 2024-10-22 15:12:08 -04:00

Erik Michelson e8793271a0 enhancement(caddy): expose :8080 by default, trust private proxies

This commit changes the caddyfile to not directly rely on the
HD_BASE_URL environment variable, but instead default to port 8080 as
used in our package.json scripts and docs.
The caddy domain can optionally be overridden using the CADDY_HOST env
variable.
Furthermore, this change adds a section to trust reverse-proxies in
front of Caddy if they are in a private range IP address network.
Both these changes are required to be able to expose a local development
setup with another domain than localhost to a co-developer. With
this change it works without having Caddy trying to generate TLS
certificates for that domain nor HedgeDoc erroring about a origin
mismatch, that occurs as Caddy doesn't forward specific headers
otherwise.

Signed-off-by: Erik Michelson <github@erik.michelson.eu>

2024-09-18 17:56:25 +02:00

3.8 KiB

Raw Permalink Blame History

Frontend

Environment Variables

The following environment variables are recognized by the frontend process.

Name	Possible Values	Description
HD_BASE_URL	Any URL with protocol, domain and optionally directory and port. Must end with a trailing slash. (e.g. `http://localhost:3001/`)	The URL under which the frontend is expected. Setting this is mandatory so the server side rendering can generate assets URLs. You only need to set this yourself if you use the production mode.
HD_RENDERER_BASE_URL	Same as `HD_BASE_URL`	You can provide this variable if the renderer should use another domain than the editor. This is recommended for security reasons but not mandatory. This variable is optional and will fallback to `HD_BASE_URL`
NEXT_PUBLIC_USE_MOCK_API	`true`, `false`	Will activate the mocked backend
NEXT_PUBLIC_TEST_MODE	`true`, `false`	Will activate additional HTML attributes that are used to identify elements for test suits.

Variables that start with NEXT_PUBLIC_ will be compiled into the build. You can't change them after compilation. You shouldn't need to set them yourself. Use the designated npm tasks instead.

UI Test

Curious about the new look and feel? We provide a demo of the new UI on HedgeDoc.dev. This version is reset every day, so data is not persisted.

Please see also our privacy policy.

Running Tests

Unit

Unit testing is done via jest.

Run yarn test

End2End

We use cypress for e2e tests.

Start the frontend with yarn start:dev:test (or use a test build using yarn build:test which you can start using yarn start). The usage of :test is mandatory!
Run yarn test:e2e:open to open the cypress test loader
Choose your browser and start a test suite

To run all tests in a headless browser use yarn test:e2e

Bundle analysis

You can inspect the generated production-bundle files to look for optimization issues.

run yarn analyze. This will overwrite any existing builds!
Open the generated .next/server/analyze/server.html in your favourite browser

Enable Debug Logging in Production

The debug logger can be enabled in production by setting debugLogging in the browser's local storage to true. This can be done e.g. by executing this JavaScript command in the browser's console.

window.localStorage.setItem("debugLogging", "true");

3.8 KiB Raw Permalink Blame History