π₯π₯π₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.
TypeScript boardsbug-trackerdjangodockerganttissue-trackerjirajira-alternativekanbanlinearpostgresqlproduct-managementproject-managementproject-planningpythonreactredistypesciptvitework-management
[WEB-1904] chore: updated setup env (#5082)
Bavisetti Narayan6b12c78ceaef
diff --git a/ENV_SETUP.md b/ENV_SETUP.mdindex df05683efd..cdcf6be370 100644--- a/ENV_SETUP.md+++ b/ENV_SETUP.md@@ -1,6 +1,5 @@# Environment Variables-βEnvironment variables are distributed in various files. Please refer them carefully.## {PROJECT_FOLDER}/.env@@ -9,17 +8,13 @@ File is available in the project root folderβ```# Database Settings-PGUSER="plane"-PGPASSWORD="plane"-PGHOST="plane-db"-PGDATABASE="plane"-DATABASE_URL=postgresql://${PGUSER}:${PGPASSWORD}@${PGHOST}/${PGDATABASE}-β+POSTGRES_USER="plane"+POSTGRES_PASSWORD="plane"+POSTGRES_DB="plane"+PGDATA="/var/lib/postgresql/data"# Redis SettingsREDIS_HOST="plane-redis"REDIS_PORT="6379"-REDIS_URL="redis://${REDIS_HOST}:6379/"-β# AWS SettingsAWS_REGION=""AWS_ACCESS_KEY_ID="access-key"@@ -29,63 +24,39 @@ AWS_S3_ENDPOINT_URL="http://plane-minio:9000"AWS_S3_BUCKET_NAME="uploads"# Maximum file upload limitFILE_SIZE_LIMIT=5242880-β# GPT settingsOPENAI_API_BASE="https://api.openai.com/v1" # deprecatedOPENAI_API_KEY="sk-" # deprecatedGPT_ENGINE="gpt-3.5-turbo" # deprecated-β+# Settings related to Docker+DOCKERIZED=1 # deprecated# set to 1 If using the pre-configured minio setupUSE_MINIO=1-β# Nginx ConfigurationNGINX_PORT=80```-β--## {PROJECT_FOLDER}/web/.env.example--β--```-# Public boards deploy URL-NEXT_PUBLIC_DEPLOY_URL="http://localhost/spaces"-```-## {PROJECT_FOLDER}/apiserver/.env-β-```# Backend# Debug value for api server use it as 0 for production useDEBUG=0-β+CORS_ALLOWED_ORIGINS="http://localhost"# Error logsSENTRY_DSN=""-β+SENTRY_ENVIRONMENT="development"# Database Settings-PGUSER="plane"-PGPASSWORD="plane"-PGHOST="plane-db"-PGDATABASE="plane"-DATABASE_URL=postgresql://${PGUSER}:${PGPASSWORD}@${PGHOST}/${PGDATABASE}-β+POSTGRES_USER="plane"+POSTGRES_PASSWORD="plane"+POSTGRES_HOST="plane-db"+POSTGRES_DB="plane"+POSTGRES_PORT=5432+DATABASE_URL=postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@${POSTGRES_HOST}:${POSTGRES_PORT}/${POSTGRES_DB}# Redis SettingsREDIS_HOST="plane-redis"REDIS_PORT="6379"REDIS_URL="redis://${REDIS_HOST}:6379/"-β-# Email Settings-EMAIL_HOST=""-EMAIL_HOST_USER=""-EMAIL_HOST_PASSWORD=""-EMAIL_PORT=587-EMAIL_FROM="Team Plane <[email protected]>"-EMAIL_USE_TLS="1"-EMAIL_USE_SSL="0"-β# AWS SettingsAWS_REGION=""AWS_ACCESS_KEY_ID="access-key"@@ -95,35 +66,25 @@ AWS_S3_ENDPOINT_URL="http://plane-minio:9000"AWS_S3_BUCKET_NAME="uploads"# Maximum file upload limitFILE_SIZE_LIMIT=5242880-β-# GPT settings-OPENAI_API_BASE="https://api.openai.com/v1" # deprecated-OPENAI_API_KEY="sk-" # deprecated-GPT_ENGINE="gpt-3.5-turbo" # deprecated-β# Settings related to Docker-DOCKERIZED=1 # Deprecated--# Github-GITHUB_CLIENT_SECRET="" # For fetching release notes-β+DOCKERIZED=1 # deprecated# set to 1 If using the pre-configured minio setupUSE_MINIO=1-β# Nginx ConfigurationNGINX_PORT=80-β-β-# SignUps-ENABLE_SIGNUP="1"-β-# Email Redirection URL+# Email redirections and minio domain settingsWEB_URL="http://localhost"+# Gunicorn Workers+GUNICORN_WORKERS=2+# Base URLs+ADMIN_BASE_URL=+SPACE_BASE_URL=+APP_BASE_URL=+SECRET_KEY="gxoytl7dmnc1y37zahah820z5iq3iozu38cnfjtu3yaau9cd9z"```## Updatesβ-- The environment variable NEXT_PUBLIC_API_BASE_URL has been removed from both the web and space projects.- The naming convention for containers and images has been updated.- The plane-worker image will no longer be maintained, as it has been merged with plane-backend.- The Tiptap pro-extension dependency has been removed, eliminating the need for Tiptap API keys.