Install Plane with Docker, with one command and Prime CLI

Install Plane with Docker

0:02A Docker install runs self-hosted Plane on one Linux server. Prime CLI, Plane's command line tool, installs and manages it.

0:13One command installs Prime CLI. It adds Docker if the server needs it, pulls Plane's images, and starts Plane behind a built-in proxy at your domain.

0:24You'll prepare the server, run the install, become the instance admin, and create the first workspace. Let's take a closer look.

Prepare the server

0:37Start with a Linux server, such as Ubuntu, with at least two cores and four gigabytes of memory, or eight gigabytes for production.

0:46Sign in over SSH as root, or as a user with sudo, because the installer uses sudo.

0:54Point your domain at the server with a DNS A record. Plane builds its links from that domain, so pick the one your team will keep.

1:03The built-in proxy listens on ports 80 and 443, so open both. Setup stops at its port check if another program already holds port 80.

1:14You don't need to install Docker first. If it's missing, setup installs it on Ubuntu, Debian, CentOS, and Amazon Linux.

1:24Setup registers the instance with prime.plane.so and pulls images from Docker Hub, so the server needs outbound access to both.

Run the install

1:37Run the one-line installer from prime.plane.so, and pass your domain with --domain.

1:45The installer puts Prime CLI on the server and starts its setup with your domain.

1:51Always pass the domain. Setup can't prompt through the pipe, so without the flag, it uses the server's IP address instead.

2:00Setup first checks for an earlier install and a free port 80, then prepares Docker.

2:07It downloads the configuration for the latest release and pulls Plane's images, several at a time.

2:14With the images pulled, setup starts the containers and waits for the migrator to prepare the database. The last five lines of its log show the progress.

2:24When the API answers, Prime CLI confirms that Plane is set up and running, and prints its address. The address uses plain HTTP until you turn on HTTPS.

2:37Plane's files live in /opt/plane. Its settings are in plane.env, and the compose file lists its services.

2:47The data folder holds the database and uploaded files, and the logs folder keeps logs from the API and its workers.

2:55For a first check, run prime-cli healthcheck. It lists every service, and each running one should read healthy.

3:04The migrator reads gracefully stopped because its work is done, and add-ons that start switched off, such as email, read disabled.

Finish setup in the browser

3:18Open your domain in a browser. Until an instance admin exists, every visitor sees Welcome to Plane, with one button, Get started.

3:28Get started opens God mode, the instance admin app at /god-mode. On a new instance, it shows a form titled Setup your Plane Instance.

3:39Enter your name and work email, then your company name, which Plane uses as the instance's name.

3:47Set a strong password and confirm it. Continue stays disabled until the password passes the strength check and both entries match.

3:56A checkbox lets Plane collect anonymous usage events. It starts checked, and you can change it later in General.

4:05Continue creates your account as the instance admin and opens God mode on General.

4:11Since no workspace exists yet, a Create workspace card appears. Its button opens the form for the first one.

4:20Name the workspace, and Plane fills in its URL. Choose how many people will use it, then select Create workspace.

4:29The workspace appears under Workspaces, with you as its owner.

4:34God mode keeps its own sign-in. Open the workspace from the list, and sign in with the same email and password.

4:44Plane asks for your profile once, then opens the workspace at your domain.

Recap

4:52One command installed Plane at your domain, God mode made you its instance admin, and the first workspace is in place.