HTTPS and websockets

Open
#10 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Domain
documentation, infrastructure

Research direction

Start by reviewing the repository's setup instructions alongside the mentioned config.json, websocketPort, Caddyfile, and PagePark examples. Document the HTTPS and secure-websocket configuration and reverse-proxy routing, with completion shown by a clear setup path that avoids websocket mixed-content errors.

Written by the indexing model from the issue text.

Description

I've been running my FeedLand instance with HTTPS for the past week or so. With the package updates the mixed-content errors in the console have been mostly eliminated. There were still errors showing up were for websockets, but I figured out how to configure FeedLand to use secure websockets

  • In config.json set urlWebsocketServerForClient to "wss://#your FeedLand domain#"
  • Configure your HTTPS reverse proxy to forward websocket requests to your configuredwebsocketPort, and all other requests to your configured port

I use Caddy as my reverse proxy, and I run FeedLand without PagePark. This is my Caddyfile

https://feedland.papascott.de {
  # Define named matcher to match websocket requests
  # See https://caddyserver.com/docs/caddyfile/matchers#named-matchers
  @websockets {
    header Connection *Upgrade*
    header Upgrade    websocket
  }
  # Redirect websocket requests to my FeedLand websocketPort
  reverse_proxy @websockets localhost:1462
  # Redirect everything else to my FeedLand port
  reverse_proxy localhost:1452
}

For PagePark I have an example CaddyFile that should work.

I am now seeing no errors under HTTPS except when when a feed requests images from HTTP (for example Scripting News)

CleanShot 2023-02-09 at 10 23 56

Console message:

Dominant language
HTML
Stars
11
Forks
4
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from scripting/feedlandInstall

All issues in scripting/feedlandInstall

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.