Merge pull request #1257 from makeplane/stage-release

promote: stage release to production

Author: vamsi

.env.example

@@ -1,20 +1,68 @@
-# Replace with your instance Public IP
+# Frontend
+# Extra image domains that need to be added for Next Image
 NEXT_PUBLIC_EXTRA_IMAGE_DOMAINS=
+# Google Client ID for Google OAuth
 NEXT_PUBLIC_GOOGLE_CLIENTID=""
-NEXT_PUBLIC_GITHUB_APP_NAME=""
+# Github ID for Github OAuth
 NEXT_PUBLIC_GITHUB_ID=""
+# Github App Name for GitHub Integration
+NEXT_PUBLIC_GITHUB_APP_NAME=""
+# Sentry DSN for error monitoring
 NEXT_PUBLIC_SENTRY_DSN=""
+# Enable/Disable OAUTH - default 0 for selfhosted instance 
 NEXT_PUBLIC_ENABLE_OAUTH=0
+# Enable/Disable sentry
 NEXT_PUBLIC_ENABLE_SENTRY=0
+# Enable/Disable session recording 
 NEXT_PUBLIC_ENABLE_SESSION_RECORDER=0
+# Enable/Disable event tracking
 NEXT_PUBLIC_TRACK_EVENTS=0
+# Slack for Slack Integration
 NEXT_PUBLIC_SLACK_CLIENT_ID=""
+
+# Backend
+
+# Database Settings
+PGUSER="plane"
+PGPASSWORD="plane"
+PGHOST="plane-db"
+PGDATABASE="plane"
+
+# Email Settings
 EMAIL_HOST=""
 EMAIL_HOST_USER=""
 EMAIL_HOST_PASSWORD=""
+EMAIL_PORT=587
+EMAIL_FROM="Team Plane <[email protected]>"
+EMAIL_USE_TLS="1"
+
+# AWS Settings
 AWS_REGION=""
-AWS_ACCESS_KEY_ID=""
-AWS_SECRET_ACCESS_KEY=""
-AWS_S3_BUCKET_NAME=""
+AWS_ACCESS_KEY_ID="access-key"
+AWS_SECRET_ACCESS_KEY="secret-key"
+AWS_S3_ENDPOINT_URL="http://plane-minio:9000"
+# Changing this requires change in the nginx.conf for uploads if using minio setup
+AWS_S3_BUCKET_NAME="uploads"
+# Maximum file upload limit
+FILE_SIZE_LIMIT=5242880
+
+# GPT settings
 OPENAI_API_KEY=""
-GPT_ENGINE=""
+GPT_ENGINE=""
+
+# Github
+GITHUB_CLIENT_SECRET="" # For fetching release notes
+
+# Settings related to Docker
+DOCKERIZED=1
+# set to 1 If using the pre-configured minio setup 
+USE_MINIO=1
+
+# Nginx Configuration
+NGINX_PORT=80
+
+# Default Creds
+DEFAULT_EMAIL="[email protected]"
+DEFAULT_PASSWORD="password123"
+
+# Auto generated and Required that will be generated from setup.sh

Dockerfile

@@ -1,6 +1,5 @@
 FROM node:18-alpine AS builder
 RUN apk add --no-cache libc6-compat
-RUN apk update
 # Set working directory
 WORKDIR /app
 ENV NEXT_PUBLIC_API_BASE_URL=http://NEXT_PUBLIC_API_BASE_URL_PLACEHOLDER
@@ -13,9 +12,7 @@ RUN turbo prune --scope=app --docker
 # Add lockfile and package.json's of isolated subworkspace
 FROM node:18-alpine AS installer
 
-
 RUN apk add --no-cache libc6-compat
-RUN apk update
 WORKDIR /app
 ARG NEXT_PUBLIC_API_BASE_URL=http://localhost:8000
 # First install the dependencies (as they change less often)
@@ -44,10 +41,12 @@ FROM python:3.11.1-alpine3.17 AS backend
 ENV PYTHONDONTWRITEBYTECODE 1
 ENV PYTHONUNBUFFERED 1
 ENV PIP_DISABLE_PIP_VERSION_CHECK=1 
+ENV DJANGO_SETTINGS_MODULE plane.settings.production
+ENV DOCKERIZED 1
 
 WORKDIR /code
 
-RUN apk --update --no-cache add \
+RUN apk --no-cache add \
     "libpq~=15" \
     "libxslt~=1.1" \
     "nodejs-current~=19" \
@@ -59,8 +58,8 @@ RUN apk --update --no-cache add \
 
 COPY apiserver/requirements.txt ./
 COPY apiserver/requirements ./requirements
-RUN apk add libffi-dev
-RUN apk --update --no-cache --virtual .build-deps add \
+RUN apk add --no-cache libffi-dev
+RUN apk add --no-cache --virtual .build-deps \
     "bash~=5.2" \
     "g++~=12.2" \
     "gcc~=12.2" \
@@ -81,18 +80,13 @@ COPY apiserver/plane plane/
 COPY apiserver/templates templates/
 
 COPY apiserver/gunicorn.config.py ./
-RUN apk --update --no-cache add "bash~=5.2"
+RUN apk --no-cache add "bash~=5.2"
 COPY apiserver/bin ./bin/
 
 RUN chmod +x ./bin/takeoff ./bin/worker
 RUN chmod -R 777 /code
 
 # Expose container port and run entry point script
-EXPOSE 8000
-EXPOSE 3000
-EXPOSE 80
-
-
 
 WORKDIR /app
 
@@ -126,9 +120,6 @@ COPY start.sh /usr/local/bin/
 RUN chmod +x /usr/local/bin/replace-env-vars.sh
 RUN chmod +x /usr/local/bin/start.sh
 
+EXPOSE 80
 
 CMD ["supervisord","-c","/code/supervisor.conf"]
-
-
-
-

README.md

@@ -15,11 +15,18 @@
 </a>
 <img alt="Discord" src="https://img.shields.io/github/commit-activity/m/makeplane/plane?style=for-the-badge" />
 </p>
-<br />
+
 <p>
-    <a href="https://app.plane.so/" target="_blank">
+    <a href="https://app.plane.so/#gh-light-mode-only" target="_blank">
       <img
-        src="https://res.cloudinary.com/toolspacedev/image/upload/v1680599798/Plane/plane_1_1_tnb32j.png"
+        src="https://ik.imagekit.io/killbluedog/Plane_Screen.png?updatedAt=1684942001069"
+        alt="Plane Screens"
+        width="100%"
+      />
+    </a>
+    <a href="https://app.plane.so/#gh-dark-mode-only" target="_blank">
+      <img
+        src="https://ik.imagekit.io/killbluedog/Plane_Screens_Dark_Mode.png?updatedAt=1684942388044"
         alt="Plane Screens"
         width="100%"
       />
@@ -38,22 +45,18 @@ The easiest way to get started with Plane is by creating a [Plane Cloud](https:/
 
 ### Docker Compose Setup
 
-- Clone the Repository
+- Clone the repository
 
 ```bash
 git clone https://github.com/makeplane/plane
-```
-
-- Change Directory
-
-```bash
 cd plane
+chmod +x setup.sh
 ```
 
 - Run setup.sh
 
 ```bash
-./setup.sh localhost 
+./setup.sh http://localhost 
 ```
 
 > If running in a cloud env replace localhost with public facing IP address of the VM
@@ -69,7 +72,7 @@ set +a
 - Run Docker compose up
 
 ```bash
-docker-compose -f docker-compose-hub.yml up
+docker compose up -d
 ```
 
 <strong>You can use the default email and password for your first login `[email protected]` and `password123`.</strong> 
@@ -89,42 +92,63 @@ docker-compose -f docker-compose-hub.yml up
 ## 📸 Screenshots
 
 <p>
-    <a href="https://app.plane.so/" target="_blank">
+    <a href="https://plane.so" target="_blank">
       <img
-        src="https://res.cloudinary.com/toolspacedev/image/upload/v1680601719/Plane/plane_2_iqao52.png"
-        alt="Plane Issue Details"
+        src="https://ik.imagekit.io/killbluedog/Plane_Views_Dark_Mode.png?updatedAt=1684943050275"
+        alt="Plane Views"
         width="100%"
       />
     </a>
-</p>
+  </p>
 <p>
-    <a href="https://app.plane.so/" target="_blank">
+    <a href="https://plane.so" target="_blank">
       <img
-        src="https://res.cloudinary.com/toolspacedev/image/upload/v1680604273/Plane/plane_5_1_nwsl3a.png"
+        src="https://ik.imagekit.io/killbluedog/Plane_Issue_Detail_Dark_Mode.png?updatedAt=1684943050202"
+        alt="Plane Issue Details"
+        width="100%"
+      />
+    </a>
+  </p>
+  <p>
+    <a href="https://plane.so" target="_blank">
+      <img
+        src="https://ik.imagekit.io/killbluedog/Plane_Cycles___Modules_Dark_Mode.png?updatedAt=1684943050281"
         alt="Plane Cycles and Modules"
         width="100%"
       />
     </a>
-</p>
-<p>
-    <a href="https://app.plane.so/" target="_blank">
+  </p>
+  <p>
+    <a href="https://plane.so" target="_blank">
       <img
-        src="https://res.cloudinary.com/toolspacedev/image/upload/v1680601713/Plane/plane_4_cqm0g8.png"
-        alt="Plane Quick Lists"
+        src="https://ik.imagekit.io/killbluedog/Plane_Analytics_Dark_Mode.png?updatedAt=1684944596824"
+        alt="Plane Analytics"
         width="100%"
       />
     </a>
+  </p>
+   <p>
+    <a href="https://plane.so" target="_blank">
+      <img
+        src="https://ik.imagekit.io/killbluedog/Plane_Pages_Dark_Mode.png?updatedAt=1684943050202"
+        alt="Plane Pages"
+        width="100%"
+      />
+    </a>
+  </p>
 </p>
-<p>
-    <a href="https://app.plane.so/" target="_blank">
+   <p>
+    <a href="https://plane.so" target="_blank">
       <img
-        src="https://res.cloudinary.com/toolspacedev/image/upload/v1680601712/Plane/plane_3_1_cu4fsc.png"
-        alt="Plane Command K"
+        src="https://ik.imagekit.io/killbluedog/Plane_Commad_K_Dark_Mode.png?updatedAt=1684943050312"
+        alt="Plane Command Menu"
         width="100%"
       />
     </a>
+  </p>
 </p>
 
+
 ## 📚Documentation
 
 For full documentation, visit [docs.plane.so](https://docs.plane.so/)

apiserver/Dockerfile.api

@@ -7,16 +7,16 @@ ENV PIP_DISABLE_PIP_VERSION_CHECK=1
 
 WORKDIR /code
 
-RUN apk --update --no-cache add \
+RUN apk --no-cache add \
     "libpq~=15" \
     "libxslt~=1.1" \
     "nodejs-current~=19" \
     "xmlsec~=1.2"
 
 COPY requirements.txt ./
 COPY requirements ./requirements
-RUN apk add libffi-dev
-RUN apk --update --no-cache --virtual .build-deps add \
+RUN apk add --no-cache libffi-dev
+RUN apk add --no-cache --virtual .build-deps \
     "bash~=5.2" \
     "g++~=12.2" \
     "gcc~=12.2" \
@@ -46,7 +46,7 @@ COPY templates templates/
 
 COPY gunicorn.config.py ./
 USER root
-RUN apk --update --no-cache add "bash~=5.2"
+RUN apk --no-cache add "bash~=5.2"
 COPY ./bin ./bin/
 
 RUN chmod +x ./bin/takeoff ./bin/worker

apiserver/plane/api/serializers/issue.py

@@ -1,3 +1,6 @@
+# Django imports
+from django.utils import timezone
+
 # Third Party imports
 from rest_framework import serializers
 
@@ -251,6 +254,7 @@ def update(self, instance, validated_data):
                 batch_size=10,
             )
 
+        instance.updated_at = timezone.now()
         return super().update(instance, validated_data)
 
 

apiserver/plane/api/serializers/user.py

@@ -25,6 +25,10 @@ class Meta:
         ]
         extra_kwargs = {"password": {"write_only": True}}
 
+        # If the user has already filled first name or last name then he is onboarded
+        def get_is_onboarded(self, obj):
+            return bool(obj.first_name) or bool(obj.last_name)
+
 
 class UserLiteSerializer(BaseSerializer):
     class Meta:

apiserver/plane/api/serializers/workspace.py

@@ -44,6 +44,8 @@ class Meta:
 
 class WorkSpaceMemberInviteSerializer(BaseSerializer):
     workspace = WorkSpaceSerializer(read_only=True)
+    total_members = serializers.IntegerField(read_only=True)
+    created_by_detail = UserLiteSerializer(read_only=True, source="created_by")
 
     class Meta:
         model = WorkspaceMemberInvite