[chore] Updated web and deploy backend configuration for reverse proxy & decoupled Plane Deploy URL generation for web by henit-chobisa · Pull Request #2135 · makeplane/plane

henit-chobisa · 2023-09-10T19:26:26Z

Tasks accomplished:

Changed the request URL for web and deploy containers from "localhost:8000" and arbitrary URLs to the same URL the application is running on.
Updated the docker-compose configuration to use reverse proxy for backend requests.
Decoupled the URL for Plane Deploy in the web environment variable.
Generated the Plane Deploy link using the host URL of the web project with a suffix, If the URL is explicitly specified, the web project will use that URL for Plane Deploy.

Previous state:

Containers in the docker-compose configuration did not use reverse proxy for backend requests.
The web and deploy containers made requests to "localhost:8000" and arbitrary URLs.
The URL for Plane Deploy had to be manually specified in the web environment variable.

Current state:

The web and plane deploy projects has been updated to use reverse proxy for backend requests, making request to /api on the same host .
The web and deploy containers now make request on the same host.
The URL for Plane Deploy is decoupled from the web project and is generated using the host URL of the web project with a suffix spaces in case if the URL is explicitly specified, the web project will use that URL for Plane Deploy.

How I tested the changes

✅ Ran Individual Builds for all three projects
✅ Ran Individual Containers and tested them with environment variables provided and without giving any environment variables for self hosted deployments
✅ Built Individual Docker Compose Services for testing individually with the given environment variables
✅ Built complete docker compose with the given set of environment variables.

Keep this in mind

When working with self hosted part, the NEXT_PUBLIC_API_BASE_URL and NEXT_PUBLIC_DEPLOY_URL are given as empty strings at the time of the build, which means that the request for both API and DEPLOY should be made on the same host as web.
In case of changes in the above two variables, or defining explicit endpoint for NEXT_PUBLIC_API_BASE_URL & NEXT_PUBLIC_DEPLOY_URL, these envs can be passed as build args in docker-compose file.

…base

…Deploy URL for deploy

vercel · 2023-09-10T19:26:35Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

6 Ignored Deployments

Name	Status	Preview	Updated (UTC)
plane	⬜️ Ignored (Inspect)	Visit Preview	Sep 12, 2023 0:36am
plane-dev	⬜️ Ignored (Inspect)	Visit Preview	Sep 12, 2023 0:36am
plane-sh	⬜️ Ignored (Inspect)	Visit Preview	Sep 12, 2023 0:36am
plane-sh-dev	⬜️ Ignored (Inspect)	Visit Preview	Sep 12, 2023 0:36am
plane-sh-stage	⬜️ Ignored (Inspect)	Visit Preview	Sep 12, 2023 0:36am
plane-staging	⬜️ Ignored (Inspect)	Visit Preview	Sep 12, 2023 0:36am

sriramveeraghanta · 2023-09-12T09:48:57Z

setup.sh

-echo -e "\nNEXT_PUBLIC_API_BASE_URL=$1\nWEB_URL=$1"  >> ./space/.env
+if [ -n "$1" ]
+then
+    echo "hello"


please remove hello

…oject-level ENVs (#2115) * chore: Updated Setup Script for Splitting Env File * chore: updated dockerfile for using inproject env varaibles * chore: removed husky replacement script * chore: updated shell script using sed * chore: updated dockerfiles with removed cp statement * chore: added example env for apiserver * chore: refactored secret generation for backend * chore: removed replacement script * chore: updated docker-compose with removed env variables * chore: resolved comments in setup.sh and docker-compose * chore: removed secret key placeholder in apiserver example env * chore: updated root env for project less env variables * chore: removed project level env update from root env logic * chore: updated API_BASE_URL in .env.example * chore: restored docker argument as env NEXT_PUBLIC_API_BASE_URL * chore: added pg missing env variables * [chore] Updated web and deploy backend configuration for reverse proxy & decoupled Plane Deploy URL generation for web (#2135) * chore: removed api url build arg from compose * chore: set public api default argument to black string for self hosted * chore: updated web services to accept blank string as API URL * chore: added env variables for pg compose service * chore: modified space app services to use accept empty string as api base * chore: conditionally trigger web url value based on argument * fix: made web to use identical host with spaces suffix on absense of Deploy URL for deploy * chore: added example env for PUBLIC_DEPLOY Env * chore: updated web dockerfile with addition as PLANE_DEPLOY Argument * API BASE URL global update * API BASE URL replace with api server * api base url fixes * typo fixes --------- Co-authored-by: sriram veeraghanta <veeraghanta.sriram@gmail.com> * dev: remove API_BASE_URL from environment variable --------- Co-authored-by: sriram veeraghanta <veeraghanta.sriram@gmail.com> Co-authored-by: pablohashescobar <nikhilschacko@gmail.com>

leikoilja · 2023-10-29T08:09:31Z

@henit-chobisa, what is the reason/benefit to set NEXT_PUBLIC_API_BASE_URL as empty strings during the build process? is that some sort of a hack?
i m experiencing the same issue as #2434 describes, but looking at the PR changes, i can't quite understand how setting those build args in dockerfile would make container omit env variable.
I ssh'ed into my running web container on the latest v0.13.2-dev and can see that he container itself sees env variable just fine

however the API calls the frontend does goes to the same host as web is hosted on

henit-chobisa added 9 commits September 10, 2023 15:50

chore: removed api url build arg from compose

fdd1123

chore: set public api default argument to black string for self hosted

287bf3b

chore: updated web services to accept blank string as API URL

1cd5428

chore: added env variables for pg compose service

624f2f8

chore: modified space app services to use accept empty string as api …

9b5966e

…base

chore: conditionally trigger web url value based on argument

1dd88de

fix: made web to use identical host with spaces suffix on absense of …

152c803

…Deploy URL for deploy

chore: added example env for PUBLIC_DEPLOY Env

29dc96c

chore: updated web dockerfile with addition as PLANE_DEPLOY Argument

c551e8d

henit-chobisa requested review from pablohashescobar and sriramveeraghanta September 10, 2023 19:26

henit-chobisa mentioned this pull request Sep 10, 2023

[chore] Update setup.sh, with removed replacement script & added project-level ENVs #2115

Merged

4 tasks

henit-chobisa changed the title ~~[chore] Updated web and deploy backend configuration for reverse proxy & decoupled Plane Deploy URL generation~~ [chore] Updated web and deploy backend configuration for reverse proxy & decoupled Plane Deploy URL generation for web Sep 10, 2023

pablohashescobar added the 🐳docker label Sep 11, 2023

henit-chobisa mentioned this pull request Sep 12, 2023

[bug]: Recent change to docker-compose-hub.yml is targeting non existent container label for plane-deploy #2093

Closed

1 task

API BASE URL global update

8d741eb

sriramveeraghanta reviewed Sep 12, 2023

View reviewed changes

API BASE URL replace with api server

d3d1c66

sriramveeraghanta approved these changes Sep 12, 2023

View reviewed changes

TheZoker mentioned this pull request Sep 12, 2023

[bug]: Issue to login after update from 0.11 to 0.12.1 #2152

Closed

1 task

sriramveeraghanta added 2 commits September 12, 2023 17:58

api base url fixes

796cb4b

typo fixes

56cb564

sriramveeraghanta merged commit 3010107 into chore/update-setup-script Sep 12, 2023

sriramveeraghanta deleted the chore/api-url-docker branch September 12, 2023 12:42

jordibeen mentioned this pull request Oct 13, 2023

[bug]: Unable to run web and api on separate URLs when self-hosting (due to the removal of the NEXT_PUBLIC_API_BASE_URL env variable) #2434

Open

1 task

aaryan610 pushed a commit that referenced this pull request Apr 9, 2025

fix: updated issue cycle activity in issue create mutation (#2135)

2ee69da

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[chore] Updated web and deploy backend configuration for reverse proxy & decoupled Plane Deploy URL generation for web#2135

[chore] Updated web and deploy backend configuration for reverse proxy & decoupled Plane Deploy URL generation for web#2135
sriramveeraghanta merged 13 commits intochore/update-setup-scriptfrom
chore/api-url-docker

henit-chobisa commented Sep 10, 2023 •

edited by pablohashescobar

Loading

Uh oh!

vercel bot commented Sep 10, 2023 •

edited

Loading

Uh oh!

sriramveeraghanta Sep 12, 2023 •

edited

Loading

Uh oh!

leikoilja commented Oct 29, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Conversation

henit-chobisa commented Sep 10, 2023 • edited by pablohashescobar Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Tasks accomplished:

Previous state:

Current state:

How I tested the changes

Keep this in mind

Uh oh!

vercel bot commented Sep 10, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

sriramveeraghanta Sep 12, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

leikoilja commented Oct 29, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

henit-chobisa commented Sep 10, 2023 •

edited by pablohashescobar

Loading

vercel bot commented Sep 10, 2023 •

edited

Loading

sriramveeraghanta Sep 12, 2023 •

edited

Loading