Files
plane/deploy/cli-install/README.md
Akshat Jain 6adf38a6c6 infra: external deployments for commercial edition (#2523)
* restructured Proxy, Deploy/CLI-install contents

* removed caddy assets fron release

* fixed changes in variables.env

* fixed action

* test build

* testing release

* finalize the caddy changes

* renamed proxy-ee to proxy.

* chore: changed docker compose file swarm compatible

* fix: added port no in proxy configuration

* added Replica Envs for services

* compose file for coolify

* updated docker-compose

* fix changes

* updated docker-compose.yml

* updated monitor to handle COOLIFY

* updated deploy_platform value

* pulled latest preview

* updated variables env

* fix merge conflicts

* fix changes

* fix changes

* chore: coolify compose file

* chore: added github action to upload coolify compose file on s3

* fixed monitor build

* testing release build

* updated branch-build-ee

---------

Co-authored-by: Manish Gupta <manish@plane.so>
Co-authored-by: Manish Gupta <59428681+mguptahub@users.noreply.github.com>
2025-03-04 01:47:29 +05:30

2.4 KiB

External Deployment

Portainer

Download the required assets as below

Edit the variables.env in your favourite editor for

  • DOMAIN_NAME: The domain name of your application
  • APP_RELEASE_VERSION: The version of the application you want to deploy
  • SITE_ADDRESS: The FQDN of your application
  • CERT_EMAIL: The email address of your SSL certificate (only if you want to generate SSL certificate)
  • MACHINE_SIGNATURE: A unique identifier for your machine ( this can be generated in terminal using command openssl rand -hex 16 or uuidgen)

With above mentioned changes, you are ready to deploy Plane. Create a new stack in Portainer and use the downloaded file to setup Plane (Commercial)

Coolify

Download the required assets as below

Coolify allows you to directly deploy applications using Docker Compose. To deploy Plane on Coolify:

  1. Add a new service in Coolify.
  2. Select Docker Compose Empty as the deployment method.
  3. Upload the above downloaded coolify-compose.yml file
  4. Configure environment variables using their UI.
  5. Deploy the application.

Swarm

To deploy Plane using Docker Swarm:

Download the required assets as below

Edit the variables.env in your favourite editor for

  • DOMAIN_NAME: The domain name of your application
  • APP_RELEASE_VERSION: The version of the application you want to deploy
  • SITE_ADDRESS: The FQDN of your application
  • CERT_EMAIL: The email address of your SSL certificate (only if you want to generate SSL certificate)
  • MACHINE_SIGNATURE: A unique identifier for your machine ( this can be generated in terminal using command openssl rand -hex 16 or uuidgen)
  1. Load your environment variables before running the deployment:

    set -o allexport; source <path-to variables.env>; set +o allexport;
    
  2. Deploy the stack:

    docker stack deploy -c deploy/cli-install/docker-caddy.yml plane
    

This will deploy the application as a Swarm stack