deploy.party - quick deploy, party enjoy!

deploy.party is a simple and easy-to-use deployment tool for your applications.

Features

• 🎉 Deploy any application with a simple UI
• 🎉 Deploy directly from GitLab or GitHub
• 🎉 Deploy docker image to local registry or other registries
• 🎉 Start databases with a single click (MongoDB, MariaDB)
• 🎉 Create custom containers with custom docker-compose and Dockerfile
• 🎉 Split your containers into projects
• 🎉 Automatic SSL and www-redirect
• 🎉 Simple backups to S3 compatible storage
• 🎉 Integrated terminal for direct access to the container beta
• 🎉 See logs of your containers
• 🎉 See statistics of your containers

Requirements

• Server access with root permissions
• Configure DNS with A record for YOUR_URL and *.YOUR_URL to SERVER_IP.

Install

Replace follow placeholders with your values:
SERVER_IP: IP of the server

ssh root@SERVER_IP

Interactive Installation

bash -c "$(curl -fsSL https://raw.githubusercontent.com/lenneTech/deploy.party/main/install.sh)"

Automated Installation

For automated deployments, you can pass parameters directly to the install script:

# Download install script
curl -fsSL https://raw.githubusercontent.com/lenneTech/deploy.party/main/install.sh -o install.sh
chmod +x install.sh

# Local installation
./install.sh --local --name my-instance --username admin --password secret123

# Production installation  
./install.sh --name my-instance --url example.com --email [email protected] --username admin --password secret123

Available Parameters

• -l, --local - Run deploy.party locally (skips URL and email prompts)
• -n, --name NAME - Instance name
• -u, --url URL - Base URL (required for production setup)
• -e, --email EMAIL - Email for SSL certificates (required for production setup)
• --username USER - Username for Traefik dashboard
• --password PASS - Password for Traefik dashboard
• -h, --help - Show help message

Examples

# Minimal local setup
./install.sh -l -n dev-server --username admin --password mypassword

# Full production setup
./install.sh -n production \
             -u mydomain.com \
             -e [email protected] \
             --username traefik-admin \
             --password secure-password-123

# Get help
./install.sh --help

Note: Any missing parameters will be prompted interactively during installation.

Install fail2ban (optional)

https://www.digitalocean.com/community/tutorials/how-to-protect-ssh-with-fail2ban-on-ubuntu-22-04

Configuration

nano /var/opt/deploy-party/data/.env

After you have configured the .env file, you can reconfigure the deploy.party with the following command:

sh /var/opt/deploy-party/reconfigure.sh

Update

sh /var/opt/deploy-party/update.sh

URLs

Now Traefik UI will be available at lb.YOUR_URL and deploy.party at YOUR_URL. Traefik has basic auth lock and can be accessed with the USERNAME and PASSWORD you set in the init.sh script.

On local setup:

• Deploy Party: http://[IP]:3001
• Minio UI: http://[IP]:3004
• Deploy Party API: http://[IP]:3000
• Deploy Party Terminal API: http://[IP]:3002
• Minio API: http://[IP]:3003

First steps

Default credentails are:
[email protected]
deploy-party

Please create a new admin account and delete the old one.

Usage

Create new admin account or invite new users

1. Click on plus in topbar and create new member
2. Fill form and choose the right role
3. The invited user receives an e-mail with the request to set a password.

Create source

1. Go to sources
2. Click on plus in topbar and create new source
3. Enter name of source for example GitLab
4. Enter the URL of the GitLab instance for example https://gitlab.com
5. Enter the personal access token for the GitLab API GitLab Docs
   • Create personal access token with following scopes: api, read_api, read_registry, write_registry
   • Personal access token global (-/user_settings/personal_access_tokens) or Personal access token for project (/GROUP/PROJECT/-/settings/access_tokens)

Create your first project

1. Click on plus in topbar and create new project
2. Enter name for project

Create your first container

1. Click on plus in topbar and create new container
2. Select the created project
3. Enter the name of the container
4. Choose the kind of container (APPLICATION, DATABASE, SERVICE, CUSTOM)
   • APPLICATION: A normal application
   • DATABASE: A database
   • SERVICE: A service like a directus, ...
   • CUSTOM: A custom container with custom docker-compose and Dockerfile
5. Select the source
6. Enter the image name
7. Select registry
8. Enter commands
9. Enter environment variables
10. Enter ports
11. Start the container

Helpful commands

Restart traefik

docker stack rm traefik

Wait if traefik container not shown under docker ps before you run the next command.

cd /var/opt/deploy-party

export $(cat .env | grep -v '#' | awk '/=/ {print $1}') && docker stack deploy -c docker-compose.traefik.yml traefik

Restart deploy.party

cd /var/opt/deploy-party

sh reconfigure.sh

Migration to Traefik v3

As of the latest version, deploy.party uses Traefik v3 by default. If you have an existing installation running Traefik v2, please see the comprehensive migration guide:

📖 Complete Migration Guide (MIGRATION.md)

The guide includes:

• ✅ Automated migration script (recommended)
• ✅ Manual migration steps
• ✅ Rollback instructions
• ✅ Troubleshooting guide
• ✅ Post-migration checklist

Quick Start

For a quick automated migration:

cd /var/opt/deploy-party
curl -fsSL https://raw.githubusercontent.com/lenneTech/deploy.party/main/upgrade-traefik-v3.sh -o upgrade-traefik-v3.sh
chmod +x upgrade-traefik-v3.sh

# Interactive mode (prompts for API URL and token)
./upgrade-traefik-v3.sh

# Or with parameters for automation
./upgrade-traefik-v3.sh --api-url https://api.deploy.party --api-token dp-xxx...

# Skip container migration
./upgrade-traefik-v3.sh --skip-migration

# Skip deploy.party update
./upgrade-traefik-v3.sh --skip-deploy-party-update

What you'll need:

• 🌐 API URL (optional - auto-detected from APP_URL if available)
  • Format: https://api.YOUR_DOMAIN or https://YOUR_DOMAIN:3000
  • The script will try to auto-detect or prompt you
• 🔑 API Token (optional but recommended for automatic container migration)
  • Get it from: Settings → API Keys in your deploy.party UI
  • Starts with dp-
  • Can be passed via --api-token flag or entered interactively

What happens:

• ⚠️ Traefik v3 requires middleware syntax changes (@swarm suffix)
• 🔄 All deployed containers will be restarted with updated configuration (rolling update)
• ⏱️ Each container has ~5-10 seconds downtime during restart
• ✅ Docker Compose files are automatically regenerated
• 🚀 deploy.party is updated to the latest version