bunkerity / bunkerity/bunkerweb

[FEATURE] Make it more difficult to accidently enable USE_PROXY_PROTOCOL

Open
#3,596 0 comments 0 reactions 0 assignees View on GitHub
core enhancement
Dominant language
Python
Stars
10.9k
Forks
643
Avg merge
1d 10h
Merged PRs (30d)
42

Description

### What's needed and why?

It's too easy to enable USE_PROXY_PROTOCOL without understanding the consequences.

Setting this while messing with settings will likely result in the user loosing access to the web ui, forcing them to edit the database to recover.

### Implementations ideas (optional)

It would be nice to have a dialogue pop-up that explains the consequences of setting it (ie that if you're not using a reverse proxy you'll loose access to the web UI) and asks the user to confirm that's what they want.

Additionally, having a built in recovery mechanism that sets it to false would be nice. Something like a script in the docker container that can be run from a docker compose exec or similar.

### Code of Conduct

- [x] I agree to follow this project's Code of Conduct

Contributor guide

Open the contributing guide

Research direction

Start by locating the web UI control for USE_PROXY_PROTOCOL and the Docker container entry points available through docker compose exec. Review how settings are persisted and recovered; done means enabling the setting requires an explicit consequence warning and users have a documented way to restore it to false without editing the database.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker
Domain
cli, devops, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.