makeplane / makeplane/plane

[feature]: Update documentation to detail how to put Plane behind existing Nginx proxy for Plane self-hosted

Open
#3,873 3 comments 1 reaction 2 assignees View on GitHub

@srinivaspendem is already working on this.

Since Mar 5, 2024.

✨feature
Dominant language
TypeScript
Stars
59.6k
Forks
5.8k
Avg merge
1d 22h
Merged PRs (30d)
49

Description

Is there an existing issue for this?
  • I have searched the existing issues
Summary

Please provide documentation and changes (Nginx site template at least) to plane self-hosted detailing how to setup an external Nginx instance to act as reverse proxy for Plane self-hosted.

Why should this be worked on?

Plane self-hosted is so fantastically easy, providing Plane in all it's glory in a close to a single command on the NGINX_PORT.
Documentation, templates, and any changes required to Plane to enable the self-hosted Plane to be integrated into an existing environment would further increase usability.
For example, being able to provide Plane self-hosted on my existing FQDN or IP such as https://fqdn.blah/plane or http://192.168.1.10/plane with minimal fuss would be ideal.
Additionally, providing SSL on Plane is most elegantly done via an external (to Plane self-hosted) Nginx (or other) reverse proxy which is configured to serve HTTPS content.

MVP should be:

  • A section in the self-hosted README either containing the info or a link to a separate piece of documentation.
  • An Nginx template that can be placed, largely verbatim, into the likes of /etc/nginx/sites-enabled.
  • Additional changes required for this to work on both FQDN and IP.
  • Profit.

Contributor guide

Open the contributing guide

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.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.