Skip to content

armgit / plane

Public Imported from GitHub
0

πŸ”₯πŸ”₯πŸ”₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.

Chore: self host enhancements (#4091)

Manish Gupta86715f5b20d6
diff --git a/deploy/selfhost/docker-compose.yml b/deploy/selfhost/docker-compose.yml
index b8d50177cc..522baf63d5 100644
--- a/deploy/selfhost/docker-compose.yml
+++ b/deploy/selfhost/docker-compose.yml
@@ -5,11 +5,11 @@ x-app-env: &app-env
- NGINX_PORT=${NGINX_PORT:-80}
- WEB_URL=${WEB_URL:-http://localhost}
- DEBUG=${DEBUG:-0}
- - SENTRY_DSN=${SENTRY_DSN:-""}
+ - SENTRY_DSN=${SENTRY_DSN}
- SENTRY_ENVIRONMENT=${SENTRY_ENVIRONMENT:-"production"}
- - CORS_ALLOWED_ORIGINS=${CORS_ALLOWED_ORIGINS:-""}
+ - CORS_ALLOWED_ORIGINS=${CORS_ALLOWED_ORIGINS}
# Gunicorn Workers
- - GUNICORN_WORKERS=${GUNICORN_WORKERS:-2}
+ - GUNICORN_WORKERS=${GUNICORN_WORKERS:-1}
#DB SETTINGS
- PGHOST=${PGHOST:-plane-db}
- PGDATABASE=${PGDATABASE:-plane}
@@ -17,11 +17,11 @@ x-app-env: &app-env
- POSTGRES_PASSWORD=${POSTGRES_PASSWORD:-plane}
- POSTGRES_DB=${POSTGRES_DB:-plane}
- PGDATA=${PGDATA:-/var/lib/postgresql/data}
- - DATABASE_URL=${DATABASE_URL:-postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${PGHOST}/${PGDATABASE}}
+ - DATABASE_URL=${DATABASE_URL:-postgresql://plane:plane@plane-db/plane}
# REDIS SETTINGS
- REDIS_HOST=${REDIS_HOST:-plane-redis}
- REDIS_PORT=${REDIS_PORT:-6379}
- - REDIS_URL=${REDIS_URL:-redis://${REDIS_HOST}:6379/}
+ - REDIS_URL=${REDIS_URL:-redis://plane-redis:6379/}
# Application secret
- SECRET_KEY=${SECRET_KEY:-60gp0byfz2dvffa45cxl20p1scy9xbpf6d8c5y0geejgkyp1b5}
# DATA STORE SETTINGS
@@ -39,7 +39,7 @@ x-app-env: &app-env
services:
web:
<<: *app-env
- image: ${DOCKERHUB_USER:-makeplane}/plane-frontend:${APP_RELEASE:-latest}
+ image: ${DOCKERHUB_USER:-makeplane}/plane-frontend:${APP_RELEASE:-stable}
pull_policy: ${PULL_POLICY:-always}
restart: unless-stopped
command: /usr/local/bin/start.sh web/server.js web
@@ -51,7 +51,7 @@ services:
space:
<<: *app-env
- image: ${DOCKERHUB_USER:-makeplane}/plane-space:${APP_RELEASE:-latest}
+ image: ${DOCKERHUB_USER:-makeplane}/plane-space:${APP_RELEASE:-stable}
pull_policy: ${PULL_POLICY:-always}
restart: unless-stopped
command: /usr/local/bin/start.sh space/server.js space
@@ -64,7 +64,7 @@ services:
api:
<<: *app-env
- image: ${DOCKERHUB_USER:-makeplane}/plane-backend:${APP_RELEASE:-latest}
+ image: ${DOCKERHUB_USER:-makeplane}/plane-backend:${APP_RELEASE:-stable}
pull_policy: ${PULL_POLICY:-always}
restart: unless-stopped
command: ./bin/takeoff
@@ -78,7 +78,7 @@ services:
worker:
<<: *app-env
- image: ${DOCKERHUB_USER:-makeplane}/plane-backend:${APP_RELEASE:-latest}
+ image: ${DOCKERHUB_USER:-makeplane}/plane-backend:${APP_RELEASE:-stable}
pull_policy: ${PULL_POLICY:-always}
restart: unless-stopped
command: ./bin/worker
@@ -91,7 +91,7 @@ services:
beat-worker:
<<: *app-env
- image: ${DOCKERHUB_USER:-makeplane}/plane-backend:${APP_RELEASE:-latest}
+ image: ${DOCKERHUB_USER:-makeplane}/plane-backend:${APP_RELEASE:-stable}
pull_policy: ${PULL_POLICY:-always}
restart: unless-stopped
command: ./bin/beat
@@ -104,7 +104,7 @@ services:
migrator:
<<: *app-env
- image: ${DOCKERHUB_USER:-makeplane}/plane-backend:${APP_RELEASE:-latest}
+ image: ${DOCKERHUB_USER:-makeplane}/plane-backend:${APP_RELEASE:-stable}
pull_policy: ${PULL_POLICY:-always}
restart: no
command: >
@@ -118,7 +118,7 @@ services:
plane-db:
<<: *app-env
- image: postgres:15.2-alpine
+ image: postgres:15.5-alpine
pull_policy: if_not_present
restart: unless-stopped
command: postgres -c 'max_connections=1000'
@@ -126,7 +126,7 @@ services:
- pgdata:/var/lib/postgresql/data
plane-redis:
<<: *app-env
- image: redis:6.2.7-alpine
+ image: redis:7.2.4-alpine
pull_policy: if_not_present
restart: unless-stopped
volumes:
@@ -144,7 +144,7 @@ services:
# Comment this if you already have a reverse proxy running
proxy:
<<: *app-env
- image: ${DOCKERHUB_USER:-makeplane}/plane-proxy:${APP_RELEASE:-latest}
+ image: ${DOCKERHUB_USER:-makeplane}/plane-proxy:${APP_RELEASE:-stable}
pull_policy: ${PULL_POLICY:-always}
ports:
- ${NGINX_PORT}:80
diff --git a/deploy/selfhost/install.sh b/deploy/selfhost/install.sh
index 16b6ea7c39..fdedf370e5 100755
--- a/deploy/selfhost/install.sh
+++ b/deploy/selfhost/install.sh
@@ -17,16 +17,16 @@ function print_header() {
clear
cat <<"EOF"
----------------------------------------
- ____ _
-| _ \| | __ _ _ __ ___
-| |_) | |/ _` | '_ \ / _ \
-| __/| | (_| | | | | __/
-|_| |_|\__,_|_| |_|\___|
-
----------------------------------------
+--------------------------------------------
+ ____ _ /////////
+| _ \| | __ _ _ __ ___ /////////
+| |_) | |/ _` | '_ \ / _ \ ///// /////
+| __/| | (_| | | | | __/ ///// /////
+|_| |_|\__,_|_| |_|\___| ////
+ ////
+--------------------------------------------
Project management tool from the future
----------------------------------------
+--------------------------------------------
EOF
}
@@ -66,7 +66,7 @@ function buildLocalImage() {
cd $PLANE_TEMP_CODE_DIR
if [ "$BRANCH" == "master" ];
then
- export APP_RELEASE=latest
+ export APP_RELEASE=stable
fi
docker compose -f build.yml build --no-cache >&2
@@ -99,17 +99,17 @@ function download() {
curl -H 'Cache-Control: no-cache, no-store' -s -o $PLANE_INSTALL_DIR/docker-compose.yaml https://raw.githubusercontent.com/makeplane/plane/$BRANCH/deploy/selfhost/docker-compose.yml?$(date +%s)
curl -H 'Cache-Control: no-cache, no-store' -s -o $PLANE_INSTALL_DIR/variables-upgrade.env https://raw.githubusercontent.com/makeplane/plane/$BRANCH/deploy/selfhost/variables.env?$(date +%s)
- if [ -f "$PLANE_INSTALL_DIR/.env" ];
+ if [ -f "$DOCKER_ENV_PATH" ];
then
- cp $PLANE_INSTALL_DIR/.env $PLANE_INSTALL_DIR/archive/$TS.env
+ cp $DOCKER_ENV_PATH $PLANE_INSTALL_DIR/archive/$TS.env
else
- mv $PLANE_INSTALL_DIR/variables-upgrade.env $PLANE_INSTALL_DIR/.env
+ mv $PLANE_INSTALL_DIR/variables-upgrade.env $DOCKER_ENV_PATH
fi
if [ "$BRANCH" != "master" ];
then
cp $PLANE_INSTALL_DIR/docker-compose.yaml $PLANE_INSTALL_DIR/temp.yaml
- sed -e 's@${APP_RELEASE:-latest}@'"$BRANCH"'@g' \
+ sed -e 's@${APP_RELEASE:-stable}@'"$BRANCH"'@g' \
$PLANE_INSTALL_DIR/temp.yaml > $PLANE_INSTALL_DIR/docker-compose.yaml
rm $PLANE_INSTALL_DIR/temp.yaml
@@ -131,9 +131,9 @@ function download() {
fi
echo ""
- echo "Latest version is now available for you to use"
+ echo "Most recent Stable version is now available for you to use"
echo ""
- echo "In case of Upgrade, your new setting file is availabe as 'variables-upgrade.env'. Please compare and set the required values in '.env 'file."
+ echo "In case of Upgrade, your new setting file is availabe as 'variables-upgrade.env'. Please compare and set the required values in 'plane.env 'file."
echo ""
}
@@ -144,7 +144,7 @@ function startServices() {
if [ -n "$migrator_container_id" ]; then
local idx=0
while docker inspect --format='{{.State.Status}}' $migrator_container_id | grep -q "running"; do
- local message=">>> Waiting for Data Migration to finish"
+ local message=">> Waiting for Data Migration to finish"
local dots=$(printf '%*s' $idx | tr ' ' '.')
echo -ne "\r$message$dots"
((idx++))
@@ -152,13 +152,18 @@ function startServices() {
done
fi
printf "\r\033[K"
+ echo ""
+ echo " Data Migration completed successfully βœ…"
# if migrator exit status is not 0, show error message and exit
if [ -n "$migrator_container_id" ]; then
local migrator_exit_code=$(docker inspect --format='{{.State.ExitCode}}' $migrator_container_id)
if [ $migrator_exit_code -ne 0 ]; then
echo "Plane Server failed to start ❌"
- stopServices
+ # stopServices
+ echo
+ echo "Please check the logs for the 'migrator' service and resolve the issue(s)."
+ echo "Stop the services by running the command: ./setup.sh stop"
exit 1
fi
fi
@@ -167,26 +172,35 @@ function startServices() {
local idx2=0
while ! docker logs $api_container_id 2>&1 | grep -m 1 -i "Application startup complete" | grep -q ".";
do
- local message=">>> Waiting for API Service to Start"
+ local message=">> Waiting for API Service to Start"
local dots=$(printf '%*s' $idx2 | tr ' ' '.')
echo -ne "\r$message$dots"
((idx2++))
sleep 1
done
printf "\r\033[K"
+ echo " API Service started successfully βœ…"
+ source "${DOCKER_ENV_PATH}"
+ echo " Plane Server started successfully βœ…"
+ echo ""
+ echo " You can access the application at $WEB_URL"
+ echo ""
+
}
function stopServices() {
docker compose -f $DOCKER_FILE_PATH --env-file=$DOCKER_ENV_PATH down
}
function restartServices() {
- docker compose -f $DOCKER_FILE_PATH --env-file=$DOCKER_ENV_PATH restart
+ # docker compose -f $DOCKER_FILE_PATH --env-file=$DOCKER_ENV_PATH restart
+ stopServices
+ startServices
}
function upgrade() {
echo "***** STOPPING SERVICES ****"
stopServices
echo
- echo "***** DOWNLOADING LATEST VERSION ****"
+ echo "***** DOWNLOADING STABLE VERSION ****"
download
echo "***** PLEASE VALIDATE AND START SERVICES ****"
@@ -303,15 +317,15 @@ function askForAction() {
elif [ "$ACTION" == "2" ] || [ "$DEFAULT_ACTION" == "start" ]
then
startServices
- askForAction
+ # askForAction
elif [ "$ACTION" == "3" ] || [ "$DEFAULT_ACTION" == "stop" ]
then
stopServices
- askForAction
+ # askForAction
elif [ "$ACTION" == "4" ] || [ "$DEFAULT_ACTION" == "restart" ]
then
restartServices
- askForAction
+ # askForAction
elif [ "$ACTION" == "5" ] || [ "$DEFAULT_ACTION" == "upgrade" ]
then
upgrade
@@ -343,7 +357,7 @@ fi
if [ "$BRANCH" == "master" ];
then
- export APP_RELEASE=latest
+ export APP_RELEASE=stable
fi
# REMOVE SPECIAL CHARACTERS FROM BRANCH NAME
@@ -354,7 +368,21 @@ fi
mkdir -p $PLANE_INSTALL_DIR/archive
DOCKER_FILE_PATH=$PLANE_INSTALL_DIR/docker-compose.yaml
-DOCKER_ENV_PATH=$PLANE_INSTALL_DIR/.env
+DOCKER_ENV_PATH=$PLANE_INSTALL_DIR/plane.env
+
+# BACKWARD COMPATIBILITY
+OLD_DOCKER_ENV_PATH=$PLANE_INSTALL_DIR/.env
+if [ -f "$OLD_DOCKER_ENV_PATH" ];
+then
+ mv "$OLD_DOCKER_ENV_PATH" "$DOCKER_ENV_PATH"
+ OS_NAME=$(uname)
+ if [ "$OS_NAME" == "Darwin" ];
+ then
+ sed -i '' -e 's@APP_RELEASE=latest@APP_RELEASE=stable@' "$DOCKER_ENV_PATH"
+ else
+ sed -i -e 's@APP_RELEASE=latest@APP_RELEASE=stable@' "$DOCKER_ENV_PATH"
+ fi
+fi
print_header
askForAction $@
diff --git a/deploy/selfhost/variables.env b/deploy/selfhost/variables.env
index 9a755d012c..e37350cf40 100644
--- a/deploy/selfhost/variables.env
+++ b/deploy/selfhost/variables.env
@@ -1,4 +1,4 @@
-APP_RELEASE=latest
+APP_RELEASE=stable
WEB_REPLICAS=1
SPACE_REPLICAS=1
@@ -18,12 +18,12 @@ POSTGRES_USER=plane
POSTGRES_PASSWORD=plane
POSTGRES_DB=plane
PGDATA=/var/lib/postgresql/data
-DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${PGHOST}/${PGDATABASE}
+DATABASE_URL=
# REDIS SETTINGS
REDIS_HOST=plane-redis
REDIS_PORT=6379
-REDIS_URL=redis://${REDIS_HOST}:6379/
+REDIS_URL=
# Secret Key
SECRET_KEY=60gp0byfz2dvffa45cxl20p1scy9xbpf6d8c5y0geejgkyp1b5
@@ -41,4 +41,4 @@ BUCKET_NAME=uploads
FILE_SIZE_LIMIT=5242880
# Gunicorn Workers
-GUNICORN_WORKERS=2
+GUNICORN_WORKERS=1
diff --git a/nginx/nginx.conf.template b/nginx/nginx.conf.template
index 4775dcbfad..780093b3ba 100644
--- a/nginx/nginx.conf.template
+++ b/nginx/nginx.conf.template
@@ -30,7 +30,7 @@ http {
}
location /${BUCKET_NAME}/ {
- proxy_pass http://plane-minio:9000/uploads/;
+ proxy_pass http://plane-minio:9000/${BUCKET_NAME}/;
}
}
}