Custom Headers

[ChakshuGautam]

Is your feature request related to a problem? Please describe

Adding custom headers similar to how it is done for any reverse proxy. An example would be adding custom auth headers when developing applications. An alternative is to have a reverse proxy (like an nginx) in front of the application but since Gitpod is already proxying requests, it is best suited to have it in the same layer.

Describe the behaviour you'd like

The feature should allow for

1. Adding custom headers
2. Removing/modifying default Gitpod headers (useful when setting a cookie header)

Adding a header to service for all requests to a service could be something like

# Commands to start on workspace startup
tasks:
  - init: yarn install
    command: yarn build
# Ports to expose on workspace startup
ports:
  - port: 8000
    onOpen: open-preview
    headers:
      - X-my-header my-header-content;

Here, headers expects an array. Adding a header that is already part of the Gitpod headers will lead to an updated header. I am not sure how the delete feature can work.

Additional context

Related Issues

1. This issue was reported by myself on Discord [1].
2. [ws-proxy] Add X-Forwarded-Port header #11110.

[atduarte]

Hi @ChakshuGautam! Thanks for the suggestion. As you mentioned you can do this by adding the headers yourself (potentially via proxy), and would prefer to keep it that way to keep the .gitpod.yml as simple as possible and focused on what can't be done otherwise. We may make exceptions to the rule when a change benefits the experience of a large number of users, but at the moment I don't have that data.

[ChakshuGautam]

Got it. Would be great if you can keep the ticket open so that it can be voted upon. Is there a criteria on when a ticket gets picked up?

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.