Skip to content

Plane

In this article

Info

Plane is a project management and task platform built on modern technologies. Plane allows teams to track, plan, and manage projects with a flexible and intuitive interface. It is particularly useful for software developers, project managers, agile teams, and those working with various project management methodologies.

Plane. Main Features

  • Task and Project Management: Allows creating and tracking tasks, distributing them among team members, setting priorities, and deadlines.
  • Flexible Views: Supports different views (board, list, calendar) to match various planning and progress tracking approaches.
  • Team Collaboration: Built-in communication and collaboration tools help the team stay on the same page.
  • Microservices Architecture: Consists of several containers (frontend, backend, database, etc.), providing flexibility and scalability.
  • Integrations with External Systems: Enables connection to other tools and services for expanded functionality.
  • Notification Systems: Ensures timely information about important events and changes in projects.
  • Workspace Management: Allows organizing the work of different teams or projects within a single installation.

Deployment Features

ID Compatible OS VM BM VGPU GPU Min CPU (Cores) Min RAM (Gb) Min HDD/SDD (Gb) Active
277 Ubuntu 22.04 + - - - 2 4 15 No
  • Pre-installed Dependencies - The platform is delivered with Docker and all necessary containers: frontend, backend, database (PostgreSQL), Redis, RabbitMQ, Minio.
  • Key Containers:
    • plane-app-admin-1 - administrator panel;
    • plane-app-space-1 - workspace management component;
    • plane-app-api-1 - API server;
    • plane-app-plane-db-1 - PostgreSQL database;
    • plane-app-plane-mq-1 - RabbitMQ message queue;
    • plane-app-plane-redis-1 - Redis cache;
    • plane-app-plane-minio-1 - MinIO file storage;
    • nginx-nginx-1 - Nginx web server for proxying (jonasal/nginx-certbot:latest).
  • Key Directories:
    • /opt/plane - main installation directory;
    • /root/plane-app - directory with configuration files;
    • /root/plane-app/plane.env - file with environment variables for setup.

Note

Unless otherwise specified, we install the latest stable version of Plane from the project's official repository by default.

Getting Started After Deploying Plane

After payment, a notification about server readiness will be sent to your registered email address. It will include the VPS IP address and login credentials for connection. Our company clients manage the equipment through the server management panel and API — Invapi.

The access data, which can be found in either the Info >> Tags tab of the server management panel or in the sent email:

  • Link to Plane's control panel web interface: in the webpanel tag;
  • Login and Password for server management: received via email upon server delivery.

Creating an Administrator Account for Plane

After successful deployment of Plane on your server, you can start using the platform by following these steps:

  1. Open a web browser and navigate to the link from the webpanel tag;

  2. Upon first launch, you will be prompted to create an administrator account. On the "Setup your Plane Instance" page, fill out the following fields:

    • First name and Last name - Your first and last names
    • Email - Your email address
    • Company name - The name of your company
    • Set a password and Confirm password - Create and confirm a password
    • In the lower part of the form, you can allow Plane to anonymously collect usage data by checking the corresponding box. After filling out all fields, click the Continue button.

Plane's Start Menu

The side menu in the Plane administrator panel offers a wide range of operations. Users can access project management, system settings, activity monitoring, and other administrative functions through an easily organized menu structure.

Workspace Management

After successful authorization, you will be directed to the Settings section. In the General Settings tab, you can:

  • Change your instance name and administrator email address;
  • View your instance's unique ID;
  • Configure communication and telemetry options:
  • Enable/disable chat with the support team via Intercom;
  • Allow/block anonymous usage data collection.

After making changes, save them by clicking the Save Changes button.

In the Workspaces on this instance section, you can:

  • View all existing workspaces;
  • Manage permissions for creating workspaces;
  • Create new workspaces.

The Prevent anyone else from creating a workspace switch allows restricting workspace creation by other users. In this case, you will need to invite others to access new workspaces.

To create a new workspace, click the Create Workspace button.

Authentication Settings

In the Authentication section, you can:

  • Configure various authentication methods for your instance;
  • Allow/block registration of new users without an invitation.

Available authentication modes:

  • Unique codes - Login with unique codes sent via email;
  • Passwords - Login with email and password;
  • Google - Login through a Google account;
  • GitHub - Login through a GitHub account;
  • GitLab - Login through a GitLab account;
  • OIDC - Authentication using the OpenID Connect protocol (update required).

Creating a Workspace

When creating a new workspace, you need to specify:

  • Name your workspace - Workspace name;
  • Set your workspace's URL - Your workspace URL;
  • How many people will use this workspace? - Estimated number of users.

After filling out all fields, click the Create Workspace or Go Back button if you wish to return to the previous step.

Viewing Created Workspaces

After creating a workspace, you will return to the Workspaces on this instance section where you can see all created spaces. For each space, the following is displayed:

  • Name and URL;
  • Owner;
  • Number of projects and participants.

To switch to a specific workspace, click its name or icon.

Workspace Operations

After creating a workspace, you need to log in:

  1. Enter your email address into the appropriate field;
  2. Click the Continue button;
  3. Choose an authentication method (if multiple are set up).

Note

The path in the URL indicates a specific workspace (in this case, /team/).

User Profile Setup

Upon first login to Plane, you will be prompted to set up your profile:

  1. Upload a profile picture (optional);
  2. Enter your name and surname;
  3. Select your role (Individual contributor, Senior Leader, Manager, etc.);
  4. Indicate your area of expertise (Engineering, Product, Marketing, etc.).

After filling out all fields, click the Continue button.

Workspace Home Page

After completing all settings, you will be taken to your workspace's home page. Here you can see:

  • Quick Start Guide with four main actions:
  • Create a project (Create a Project);
  • Invite team members (Invite Your Team);
  • Set up your workspace (Set Up Your Workspace);
  • Personalize Plane (Make Plane Yours);
  • Quicklinks section for saving important resources.

On the left side of the screen is a navigation menu to access various sections of Plane:

  • Home (Home Page);
  • Inbox (Incoming);
  • Projects (Projects);
  • More (Additional Options).

Note

Detailed information on Plane's main settings can be found in the developer documentation.

Ordering a server with Plane using the API

To install this software using the API, follow these instructions