How to Deploy Plane – An Opensource Jira Alternative
Introduction
Plane is a highly extensible open-source project management tool that supports several types of frameworks such as Agile, Kanban, waterfall, and timelines. It’s an alternative to platforms such as Jira, Asana, and Linear that lets you self-host all application resources in a containerized environment using tools such as Docker or Kubernetes.
This guide explains how to deploy Plane on a Vultr cloud server and set up an issue-tracking environment with trusted SSL certificates, email notifications, and authentication methods to secure your application.
Prerequisites
Deploy a One-Click Docker Server using the Vultr marketplace application with at least
4 GBRAM.Deploy a Vultr Managed Database for PostgreSQL to use with Plane.
Deploy Vultr Object Storage to use as the default Plane storage.
Create a non-root user with sudo privileges.
Add the user to the Docker group. For example,
linuxuser.CONSOLESwitch to the non-root user account.
CONSOLE
Create the Plane Database
The default Plane PostgreSQL database installed within the application's Docker environment does not offer the best performance in production environments. Offload the Plane database privileges to a Vultr Managed Database for PostgreSQL to improve the application's availability and performance in addition to offsite data storage. Follow the steps below to create a new Plane database using your Vultr Managed Database for PostgreSQL.
Log in to your Vultr Managed Database for PostgreSQL using a connection string. Replace
abcd.vultrdb.comwith your actual database host URL.CONSOLEWhen prompted, enter your Vultr Managed Database for PostgreSQL user password to access the cluster.
Create a new database to use with Plane. For example,
planedb.POSTGRESQLSwitch to the database.
POSTGRESQLCreate a new sample table to verify that your PostgreSQL user has
CREATEpermissions on the database.POSTGRESQLExit the PostgreSQL console.
POSTGRESQLPlane requires a super user PostgreSQL account such as
vultradminto successfully migrate data and create all necessary resources in the database. Non-super user accounts are not compatible with Plane when using external databases due to required root-level permissions.
Install Plane on the Server
Create a new Plane project directory.
CONSOLESwitch to the directory.
CONSOLEDownload the latest Plane installation script using Curl.
CONSOLEGrant execute privileges on the script.
CONSOLERun the Plane installation script.
CONSOLEOutput:
Enter
1as the action value and press Enter to install the initial Plane configuration on your server.Verify that the process is successful similar to the output below:
Enter
7as the action value and press Enter to exit the installation script.List the project directory files and verify that a new
plane-appdirectory is available.CONSOLESwitch to the directory.
CONSOLEList all directory files to verify that new
docker-compose.yamland.envfiles are available.CONSOLEOutput:
Open the
.envenvironment variables file to modify the Plane installation values.CONSOLEFind the
NGINX_PORTfield and replace the default port80with another port such as8080.Save the file.
Find
WEB_URLand replacehttp://localhostwith your domain URL. For example,https://plane.example.com.Save the file.
Find the NEXT_PUBLIC_DEPLOY_URL field and change
http://localhost/spacesto your domain URL while maintaining the/spacespath.Save the file.
Scroll to the CORS_ALLOWED_ORIGINS field and change
http://localhostto your domain URL.Save the file.
Find the DB Settings section and replace all default variable values with your Vultr Managed Database for PostgreSQL details. In particular, replace the DATABASE_URL variable value with your full Vultr Managed Database for PostgreSQL connection string similar to the configuration below.
Save and close the file.
Replace the above Vultr Managed Database for PostgreSQL connection details with your matching values depending on the variable field:
- PGHOST: Your Vultr Managed Database for PostgreSQL URL.
- PGDATABASE: The target PostgreSQL database to use with Plane.
- POSTGRES_USER: Your PostgreSQL Database Username.
- POSTGRES_PASSWORD: Your PostgreSQL database user password
- POSTGRES_DB: The PostgreSQL Database to use with Plane.
- PGDATA: The host directory path to store your PostgreSQL data files.
- DATABASE_URL: The Vultr Managed Database for PostgreSQL connection string to use when connecting to the database.
Scroll to the DATA STORE SETTINGS section to set up the Plane connection to Vultr Object Storage.
Modify the default variable values with your Vultr Object Storage details to use with Plane.
Save and close the file.
Replace the above Vultr Object Storage example connection details with your actual values. Below is what each variable represents:
- USE_MINIO: The value
0disables the default MinIO object storage and enables external access variables. - AWS_REGION: Sets your Vultr Object Storage location. Replace
ewrwith your object storage location ID depending on the deployment region. - AWS_ACCESS_KEY_ID: Sets the Vultr Object Storage access key to use when connecting with Plane. Replace
example-access-keywith your actual object storage access key string. - AWS_SECRET_ACCESS_KEY: Sets the Vultr Object Storage secret key to authenticate with your access key. Replace
example-secretwith your actual secret key. - AWS_S3_ENDPOINT_URL: Sets the Vultr Object Storage host URL to store your Plane data files. Replace
ewr1.vultrobjects.comwith your actual object storage URL. - AWS_S3_BUCKET_NAME: Defines your Vultr Object Storage bucket to use with Plane. If the bucket does not exist, it’s auto-created upon installation. Replace the
planevalue with your desired bucket name.
- USE_MINIO: The value
Switch back to your main Plane project directory.
CONSOLERun the Plane installation script again.
CONSOLEEnter the action value
2(start) and press Enter to start the Plane installation.During installation, all database objects migrate to your Vultr Managed Database for PostgreSQL, and Vultr Object Storage is enabled as the default storage medium. When the installation is successful, your output should look like the one below:
Enter the action value
7and press Enter to close the Plane installation script and verify the installation.View the list of running Docker containers and verify all active Plane instances.
CONSOLEOutput:
Send an HTTP request to the Plane host port
8080and test access to the application interface.CONSOLEYour output should look like the one below:
Based on your Plane configuration, the application runs on the host port
8080defined by yourNGINX_PORTvalue in the.envfile. When the connection is successful, the request outputs HTML raw data that represents a successful connection to the Plane application.
Secure Plane
Plane is a project tracking platform normally used with specific teams, departments, or organizations. Secure Plane with production environment practices including secure firewall rules and trusted SSL certificates to expose the application using your domain name. Follow the sections below to generate valid SSL certificates using the Let’s Encrypt Certificate authority (CA) and allow connection-only ports through the default server firewall application.
Configure the Server Firewall
By default, Uncomplicated Firewall (UFW) is available and active as the default firewall package on Vultr Debian servers. Configure UFW to allow connection-only ports through the firewall to enable secure access to the Plane application resources.
Confirm the firewall status.
CONSOLEOutput:
If disabled, allow the SSH port
22and enable the firewall using the following commands.CONSOLEAllow the HTTP connection port
80through the firewall.CONSOLEAllow the HTTPS connection port
443to enable secure TLS/SSL connections.CONSOLEReload the firewall table to apply the new port changes.
CONSOLEView the firewall table to verify all available ports.
CONSOLEOutput:
Install the Nginx Proxy Manager to Expose Plane using a Domain Name
Nginx Proxy Manager is a reverse proxy application that securely exposes Docker applications for external access on a server. In the following steps, install the Nginx Proxy Manager and attach it to the internal Plane Docker network. In addition, enable access to Plane using the domain name URL plane.example.com you defined in your .env configuration.
Print your working directory and verify that you are actively using the Plane project directory.
CONSOLEOutput:
Create a new data directory to store your Docker files. For example,
nginx-proxy-man.CONSOLESwitch to the new data directory.
CONSOLECreate a new Docker Compose file.
CONSOLEOpen the file using a text editor of your choice such as Nano.
CONSOLEAdd the following contents to the file.
YAMLSave and close the file.
The above Docker configuration creates a new Nginx Proxy Manager container and exposes the application for access on the following host ports:
- 80: The default HTTP port used by the Nginx Proxy Manager to expose applications.
- 81: Enables access to the Nginx Proxy Manager control panel
- 443: Enables secure HTTPS access for exposed applications with valid SSL certificates generated by the Nginx Proxy Manager.
Test access to the HTTP and HTTPS host ports to verify that no existing conflicts are active on your server.
CONSOLEIf no application actively uses the ports, your output appears empty similar to the one below:
If any application is using the ports, stop the application using the
Killcommand to avoid port conflicts with the Nginx Proxy Manager. For example, stop the process ID1234.CONSOLEInstall the Nginx Proxy Manager using your Docker Compose file.
CONSOLEMonitor the installation and verify that it’s successful similar to the output below:
View all running Docker containers and verify that the Nginx Proxy Manager container is active.
CONSOLEOutput:
Verify the available Docker networks and keep note of the Plane network name.
CONSOLEOutput:
Attach Nginx Proxy Manager to the Plane network to enable internal access to the application.
CONSOLEAccess your server IP address on port
81to open the Nginx Proxy Manager control panel using a web browser such as Firefox. Replace172.16.0.2with your actual server IP address.Enter the following default administrator information to log in to the application:
- USER:
admin@example.com - PASSWORD:
changeme
Change the administrative user details or close the Edit User dialog to access the application control panel.
- USER:
Click Hosts on the application navigation menu and select Proxy Hosts to create a new host configuration.
Click Add Proxy Host to open the host configuration page.
Enter your domain name in the Domain Names field and click the Add overlay to save your host domain.
Click the Scheme field and keep http as the connection type to access the internal Plane network.
Enter your main Plane container name
plane-app-proxy-1in the Forward Hostname/IP field.Enter the internal Plane proxy container port
80in the Forward Port field.Keep Publicly Accessible as the access list value and click Save to apply the new host changes.
Open a new web browser tab and visit your domain to verify access to the Plane application interface.
Generate Trusted SSL Certificates to use with Plane
Nginx Proxy Manager uses Let’s Encrypt as the default SSL certificate authority. In the following steps, modify the Plane host configuration and generate trusted SSL certificates to use with your domain name.
Login to the Nginx Proxy Manager control panel.
Click Hosts to access your host configurations.
Click the options : symbol next to Status and select Edit from the list to modify the host configuration.
Click the SSL tab in the Edit Host pop-up dialog.
Click the SSL Certificate field and select
Request a new SSL certificate with Let's Encryptfrom the list.Toggle Force SSL to enable automatic redirections from HTTP to HTTPS.
Enter your email address to associate with the Let’s Encrypt certificate request.
Toggle I Agree to the Let’s Encrypt Terms of Service option to agree to the SSL certificate authority terms.
Click Save to apply the host configuration changes.
Open a new web browser tab and visit your domain over HTTPS to verify access to the Plane application using a secure connection.
Configure Plane
Plane requires additional configurations when installed on your server to set up your application structure and invite additional users. In the following steps, configure the Plane interface and enable global options to activate with additional users for access on your server.
Open a new web browser window and access your Plane domain using the
/god-modepath to access the application configuration screen.Enter your email address in the
name@company.comfield.Enter a strong password in the
Enter passwordfield to associate with the administrator email.Click Sign in to create your Plane administrator account.
Click Go to God Mode to access the Plane instance configuration page.
Enter your desired Plane application name in the Name of instance field and click Save Changes to save your instance details.
Click Email on the navigation bar to modify your Plane email notification settings and assign the application an SMTP host and a from address to send user emails.
Click Save Changes to apply your Plane application settings.
Click the Exit symbol on the top bar to exit God Mode and access your Plane instance.
Enter your new workspace name in the Name it field, verify your domain URL, and click Make it live to create the workspace.
Enter your first user name in the
Enter your full namefield, select your plane usage category to personalize the workspace, and click Continue to apply the new changes.Enter your team email addresses and select the appropriate permissions to assign the new workspace users.
Click Invite members to send email notifications to the user email addresses or click Do this later to skip the invitation process depending on your email server settings.
Confirm your new Plane instance workspace and click Take a Product Tour to explore all application features such as cycles, views, modules, analytics, and issues.
Click Create my first project to set up the first workspace project and access the main application interface.
To invite additional team members to the Plane application, click the Workspace name and select Settings to access the project Members list.
To modify your application settings, click your username icon on the top left bar and select Enter God Mode to access the instance configuration page.
Conclusion
In this guide, you have successfully deployed Plane on a Vultr cloud server and configured the application with production environment settings. The Vultr Managed Database for PostgreSQL works as the main database while Vultr Object Storage stores all Plane application assets. This improves the instance availability and performance similar to closed-source applications such as Jira and Linear. For more information, visit the official Plane documentation.
0 Comments
Be the first to comment and share your perspective with the community.