Plane (Community Edition)
Generated on 4 Nov 2024 from the Plane (Community Edition) catalog page
We’re excited to offer the Plane.so Community Edition as a DigitalOcean Droplet. This pre-configured image allows you to easily set up and deploy Plane.so on your own DigitalOcean account. With just a few clicks, you can have Plane.so Community Edition up and running, ready to help you manage your projects efficiently.
Features:
- Easy Setup: No complicated configurations needed. Simply select the Plane.so image and deploy.
- Pre-configured: Comes with all necessary dependencies and optimizations for smooth performance.
- Scalable: Built to handle your growing project management needs.
- Community Edition: Enjoy the core features of Plane.so, designed for community collaboration and productivity.
Software Included
Package | Version | License |
---|---|---|
Postgresql | 15.7 | MIT |
MinIO | RELEASE.2024-10-29T16-01-48Z | GNU Affero GPL |
Valkey | 7.2.5 | BSD 3-Clause |
Caddy | 2.8.4 | Apache-2.0 |
RabbitMQ | 3.13.6 | MIT |
Creating an App using the Control Panel
Click the Deploy to DigitalOcean button to create a Droplet based on this 1-Click App. If you aren’t logged in, this link will prompt you to log in with your DigitalOcean account.
Creating an App using the API
In addition to creating a Droplet from the Plane (Community Edition) 1-Click App using the control panel, you can also use the DigitalOcean API. As an example, to create a 4GB Plane (Community Edition) Droplet in the SFO2 region, you can use the following curl
command. You need to either save your API access token) to an environment variable or substitute it in the command below.
curl -X POST -H 'Content-Type: application/json' \
-H 'Authorization: Bearer '$TOKEN'' -d \
'{"name":"choose_a_name","region":"sfo2","size":"s-2vcpu-4gb","image": "planesoftware-planecommunityed"}' \
"https://api.digitalocean.com/v2/droplets"
Getting Started After Deploying Plane (Community Edition)
Default Settings
- Default working folder is
/opt/plane
where the application is installed. ./setup.sh
is the command to be used to manage the environment.
Configure Domain
Login to the droplet terminal, and execute the below code with your own domain name. This will set the global environment variable at OS level along with updating the plane.env
APP_DOMAIN=plane.example.com
sudo grep -q '^APP_DOMAIN=' /etc/environment && sudo sed -i 's/^APP_DOMAIN=.*/APP_DOMAIN='$APP_DOMAIN'/' /etc/environment || echo 'APP_DOMAIN='$APP_DOMAIN | sudo tee -a /etc/environment
sudo grep -q '^APP_DOMAIN=' /opt/plane/plane-app/plane.env && sudo sed -i 's/^APP_DOMAIN=.*/APP_DOMAIN='$APP_DOMAIN'/' /opt/plane/plane-app/plane.env || echo 'APP_DOMAIN='$APP_DOMAIN | sudo tee -a /opt/plane/plane-app/plane.env
After executing the above script, logout
from ssh shell and then re-login.
Now restart the Plane services using ./setup.sh restart
Configure SSL
To configure SSL, edit the file /opt/plane/Caddyfile
. Change :80
with your domain e.g plane.example.com
Then restart Caddy Server using command service caddy restart
If all goes well, you should be able to access Plane on https://plane.example.com