thunderstrike/plane
thunderstrike/plane
2
0
Fork 0
forked from github/plane
Code Pull Requests Activity
d34df5c805
plane/deploy/1-click
History
sriram veeraghanta 3d09a69d58
fix: eslint issues and reconfiguring (#3891) 
* fix: eslint fixes

---------

Co-authored-by: gurusainath <gurusainath007@gmail.com>
2024-03-06 18:39:14 +05:30
..
images [INFRA-10] feat: self host log view (#3824) 2024-02-28 16:31:49 +05:30
install.sh improvement: 1 click deployment (#3794) 2024-02-26 15:29:20 +05:30
plane-app improvement: 1 click deployment (#3794) 2024-02-26 15:29:20 +05:30
README.md fix: eslint issues and reconfiguring (#3891) 2024-03-06 18:39:14 +05:30

README.md

1-Click Self-Hosting

In this guide, we will walk you through the process of setting up a 1-click self-hosted environment. Self-hosting allows you to have full control over your applications and data. It's a great way to ensure privacy, control, and customization.

Let's get started!

Installing Plane

Installing Plane is a very easy and minimal step process.

Prerequisite

  • Operating System (latest): Debian / Ubuntu / Centos
  • Supported CPU Architechture: AMD64 / ARM64 / x86_64 / aarch64

Downloading Latest Stable Release

curl -fsSL https://raw.githubusercontent.com/makeplane/plane/master/deploy/1-click/install.sh | sh -
Downloading Preview Release 
export BRANCH=preview

curl -fsSL https://raw.githubusercontent.com/makeplane/plane/preview/deploy/1-click/install.sh | sh -

NOTE: Preview builds do not support ARM64/AARCH64 CPU architecture

--

Expect this after a successful install

Install Output

Access the application on a browser via http://server-ip-address

Get Control of your Plane Server Setup

Plane App is available via the command plane-app. Running the command plane-app --help helps you to manage Plane

Plane Help

Basic Operations:

  1. Start Server using plane-app start
  2. Stop Server using plane-app stop
  3. Restart Server using plane-app restart

Advanced Operations:

  1. Configure Plane using plane-app --configure. This will give you options to modify

    • NGINX Port (default 80)
    • Domain Name (default is the local server public IP address)
    • File Upload Size (default 5MB)
    • External Postgres DB Url (optional - default empty)
    • External Redis URL (optional - default empty)
    • AWS S3 Bucket (optional - to be configured only in case the user wants to use an S3 Bucket)

  2. Upgrade Plane using plane-app --upgrade. This will get the latest stable version of Plane files (docker-compose.yaml, .env, and docker images)

  3. Updating Plane App installer using plane-app --update-installer will update the plane-app utility.

  4. Uninstall Plane using plane-app --uninstall. This will uninstall the Plane application from the server and all docker containers but do not remove the data stored in Postgres, Redis, and Minio.

  5. Plane App can be reinstalled using plane-app --install.

Application Data is stored in the mentioned folders:

  1. DB Data: /opt/plane/data/postgres
  2. Redis Data: /opt/plane/data/redis
  3. Minio Data: /opt/plane/data/minio