Sentry integration, Epics endpoints, SSL configuration, and other fixes #173

Author: sriramveeraghanta

api-reference/epics/get-epic-detail.mdx

@@ -0,0 +1,20 @@
+---
+title: Retrieve an epic
+description: Retrieves the details of an existing epic by its ID.
+api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/epics/{epic_id}/
+---
+
+## Path parameters
+
+<ParamField path="workspace_slug" type="string" required>
+The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
+</ParamField>
+
+<ParamField path="project_id" type="string" required>
+  The unique identifier for the project.
+</ParamField>
+
+<ParamField path="epic_id" type="string" required>
+  The unique identifier for the epic.
+</ParamField>
+

api-reference/epics/list-epics.mdx

@@ -0,0 +1,26 @@
+---
+title: List all epics
+description: Returns a list of all epics in a project.
+api: GET /api/v1/workspaces/{workspace_slug}/projects/{project_id}/epics/
+---
+
+## Path parameters
+
+<ParamField path="workspace_slug" type="string" required>
+The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL `https://app.plane.so/my-team/projects/`, the workspace slug is `my-team`.
+</ParamField>
+
+<ParamField path="project_id" type="string" required>
+  The unique identifier for the project.
+</ParamField>
+
+## Query parameters
+
+<ParamField query="limit" type="number">
+Number of results to return per page.
+</ParamField>
+
+<ParamField query="offset" type="number">
+Number of results to skip for pagination.
+</ParamField>
+

api-reference/epics/overview.mdx

@@ -0,0 +1,169 @@
+---
+title: Overview
+---
+
+Epics help you group related tasks into a larger work item, providing a hierarchical structure for managing complex projects. Use epics to break down major objectives into smaller, manageable pieces while keeping everything organized.
+[Learn more about Epics](https://docs.plane.so/core-concepts/issues/epics).
+
+## The Epics object
+**Attributes**
+
+- `id` string
+
+    Unique identifier for the epic.
+
+- `name` string
+
+    Name of the epic.
+
+- `description` object
+
+    JSON representation of the epic description.
+
+- `description_html` string
+
+    HTML-formatted description of the epic.
+
+- `description_stripped` string
+
+    Plain text version of the description.
+
+- `description_binary` string
+
+    Binary representation of the description.
+
+- `state` string
+
+    ID of the state (status) of the epic.
+
+- `priority` string
+
+    Priority level. Possible values: `none`, `urgent`, `high`, `medium`, `low`.
+
+- `assignees` array
+
+    Array of user IDs assigned to the epic.
+
+- `labels` array
+
+    Array of label IDs applied to the epic.
+
+- `type` string
+
+    ID of the work item type for the epic.
+
+- `estimate_point` string
+    
+    ID of the estimate point, or null if not estimated.
+
+- `point` integer
+
+    Point value for the epic, or null.
+
+- `start_date` string
+    
+    Start date of the epic in YYYY-MM-DD format.
+
+- `target_date` string
+
+    Target completion date in YYYY-MM-DD format.
+
+- `parent` string
+    
+    ID of the parent work item, or null if no parent.
+
+- `sequence_id` integer
+    
+    Auto-generated sequential identifier for the epic within the project.
+
+- `sort_order` number
+
+    Auto-generated sort order for display purposes.
+
+- `is_draft` boolean
+
+    Whether the epic is a draft.
+
+- `completed_at` timestamp
+
+    Time at which the epic was completed, or null if not completed.
+
+- `archived_at` timestamp
+
+    Time at which the epic was archived, or null if not archived.
+
+- `project` string
+    
+    ID of the project containing this epic.
+
+- `workspace` string
+    
+    ID of the workspace containing this epic.
+
+- `external_id` string
+
+    External identifier if imported from another system, or null.
+
+- `external_source` string
+
+    Name of the source system if imported, or null.
+
+- `deleted_at` timestamp
+
+    Time at which the epic was deleted, or null if not deleted.
+
+- `created_at` timestamp
+    
+    Time at which the epic was created.
+
+- `updated_at` timestamp
+
+    Time at which the epic was last updated.
+
+- `created_by` string
+
+    ID of the user who created the epic.
+
+- `updated_by` string
+
+    ID of the user who last updated the epic.
+
+<ResponseExample>
+```json EPICS OBJECT
+{
+  "id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+  "name": "Develop Mobile Application Framework",
+  "description": {},
+  "description_html": "<p class=\"editor-paragraph-block\">Create a cross-platform mobile application framework that supports all core system functionalities with native-like performance and user experience</p>",
+  "description_stripped": "Create a cross-platform mobile application framework that supports all core system functionalities with native-like performance and user experience",
+  "description_binary": null,
+  "state": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+  "priority": "medium",
+  "assignees": [],
+  "labels": [
+    "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+    "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+  ],
+  "type": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+  "estimate_point": null,
+  "point": null,
+  "start_date": "2025-02-28",
+  "target_date": "2025-06-20",
+  "parent": null,
+  "sequence_id": 57,
+  "sort_order": 605535.0,
+  "is_draft": false,
+  "completed_at": null,
+  "archived_at": null,
+  "project": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+  "workspace": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+  "external_id": null,
+  "external_source": null,
+  "deleted_at": null,
+  "created_at": "2025-03-01T21:23:54.645263+05:30",
+  "updated_at": "2025-03-03T10:38:44.667276+05:30",
+  "created_by": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+  "updated_by": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
+}
+```
+</ResponseExample>

api-reference/initiative/overview.mdx

@@ -6,7 +6,7 @@ Initiatives are high-level strategic goals that help organize and track work acr
 
 [Learn more about Initiatives](https://docs.plane.so/core-concepts/projects/initiatives)
 
-## The Initiative object
+## The Initiatives object
 
 **Attributes**
 

mint.json

@@ -115,13 +115,15 @@
         "self-hosting/govern/configure-dns-email-service",
         "self-hosting/govern/database-and-storage",
         "self-hosting/govern/custom-domain",
+        "self-hosting/govern/configure-ssl",
         "self-hosting/govern/private-bucket",
         {
           "group": "Integrations",
           "pages": [
               "self-hosting/govern/integrations/github",
-              "self-hosting/govern/integrations/slack",
-              "self-hosting/govern/integrations/gitlab"
+              "self-hosting/govern/integrations/gitlab",
+              "self-hosting/govern/integrations/sentry",
+              "self-hosting/govern/integrations/slack"
             ]
         },
         "self-hosting/govern/external-secrets",
@@ -358,6 +360,14 @@
             "api-reference/worklogs/delete-worklog"
           ]
         },
+        {
+          "group": "Epics",
+          "pages": [
+            "api-reference/epics/overview",
+            "api-reference/epics/list-epics",
+            "api-reference/epics/get-epic-detail"
+          ]
+        },
         {
           "group": "Initiatives",
           "pages": [

self-hosting/govern/configure-ssl.mdx

@@ -0,0 +1,104 @@
+---
+title: Set up SSL • Commercial Edition
+sidebarTitle: Configure SSL
+---
+
+This guide shows you how to configure SSL/TLS certificates for your self-hosted Plane instance. Plane handles certificate provisioning and renewal automatically using Let's Encrypt.
+
+<Note>
+**Applies to:** Docker deployments of Plane Commercial Edition without an external reverse proxy.
+
+If you're using an external reverse proxy (nginx, Caddy, Traefik) or a load balancer, configure SSL there instead and skip this guide.
+</Note>
+
+## Before you begin
+
+Ensure you have:
+- A registered domain name pointing to your Plane server
+- DNS records configured (A or CNAME record pointing to your server's IP)
+- Ports 80 and 443 open on your server's firewall
+- Prime CLI installed (included with Plane Commercial Edition)
+
+<Warning>
+**DNS must be configured first.** Let's Encrypt validates domain ownership by making HTTP requests to your domain. Ensure your domain resolves to your server's IP address before proceeding.
+</Warning>
+
+## Configure SSL settings
+
+### Open the configuration file
+
+Edit your Plane environment configuration:
+```bash
+vim /opt/plane/plane.env
+```
+
+### Set required variables
+
+Add or update these environment variables:
+```bash
+# SSL Configuration
+[email protected]
+SITE_ADDRESS=plane.yourcompany.com
+WEB_URL=https://plane.yourcompany.com
+```
+
+**Variable explanations:**
+
+**CERT_EMAIL**  
+A valid email address for Let's Encrypt certificate registration. Let's Encrypt uses this to send renewal reminders and important notices about your certificates.
+
+**SITE_ADDRESS**  
+Your domain name **without** protocol. Use only the domain (e.g., `plane.company.com`), not `https://plane.company.com`. Plane's built-in proxy uses this to request certificates from Let's Encrypt.
+
+**WEB_URL**  
+Your full Plane URL **with** the `https://` protocol. This tells Plane services how to construct URLs for redirects, emails, and API responses.
+
+### DNS provider configuration (optional)
+
+If you're using Cloudflare or another DNS provider with API access, you can use DNS validation instead of HTTP validation. This is useful if:
+- Your server is behind a firewall that blocks port 80
+- You need wildcard certificates
+- HTTP validation isn't working due to network restrictions
+
+**For Cloudflare:**
+```bash
+CERT_ACME_DNS=acme_dns cloudflare <cloudflare-api-token>
+```
+
+Replace `<cloudflare-api-token>` with your Cloudflare API token. Create one at **Cloudflare Dashboard** → **My Profile** → **API Tokens** with **Zone:DNS:Edit** permissions.
+
+**For other DNS providers:**
+
+Check the [acme.sh DNS API documentation](https://github.com/acmesh-official/acme.sh/wiki/dnsapi) for provider-specific configuration.
+
+## Apply SSL configuration
+
+Restart Plane to apply the SSL settings:
+```bash
+sudo prime-cli restart
+```
+
+Prime CLI will:
+1. Stop all Plane services
+2. Request a new SSL certificate from Let's Encrypt
+3. Configure the built-in proxy to use HTTPS
+4. Restart all services with SSL enabled
+
+This process typically takes 30-60 seconds.
+
+## Verify SSL is working
+
+Check that your Plane instance is accessible via HTTPS:
+```bash
+curl -I https://plane.yourcompany.com
+```
+
+You should see a response with `HTTP/2 200` or `HTTP/1.1 200` and SSL-related headers.
+
+Visit your Plane instance in a browser at `https://plane.yourcompany.com`. You should see a secure connection (padlock icon) without certificate warnings.
+
+
+## Using custom SSL certificates
+
+Custom SSL certificates (from a corporate CA or purchased certificates) are not currently supported in Plane's deployment.
+

self-hosting/govern/database-and-storage.mdx

@@ -6,7 +6,12 @@ sidebarTitle: External database and storage
 
 The Prime CLI lets you easily configure your Commercial Edition instance, providing options to customize the PostgreSQL database, Redis, external storage, and other advanced settings.
 
-1.  Run the Prime CLI with ↓:
+<Warning>
+**Prime CLI is for Docker installations only.** These commands only work on Plane instances originally installed using `prime-cli`.
+</Warning>
+
+1.  Run the Prime CLI with ↓: 
+
     ```sudo prime-cli``` 
 
 2. Once the CLI is running, enter `configure`, which will guide you through a step-by-step form where you can specify the following: