Docker compose Local

Run the interactive installer:

curl -fsSL https://raw.githubusercontent.com/getplumber/platform/main/install.sh | bash

Choose “Local” when prompted. The installer will guide you through:

1. GitLab OIDC application setup
2. Secrets: automatically generated

At the end, Plumber will start on http://localhost:3000.

git clone https://github.com/getplumber/platform.git plumber-platform
cd plumber-platform
./install.sh

Step 1: Create GitLab Application

On your GitLab instance, open the Applications page: Your picture > Preferences > Applications (example: gitlab.com)

Create an application with the following information:

1. Name: Plumber
2. Redirect URI: http://localhost:3001/api/auth/gitlab/callback
3. Confidential: true (keep the box checked)
4. Scopes: api

Click on Save Application. Keep this GitLab tab open, the Application ID and Secret will be used in the configuration step.

Step 2: Setup your environment

Clone the repository locally

git clone https://github.com/getplumber/platform.git plumber-platform
cd plumber-platform

Create your configuration file

cp .env.local.example .env
cat versions.env >> .env

Step 3: Update the configuration

Edit the .env file:

• Copy/paste the Application ID and the Secret from the GitLab application you just created

  GITLAB_OAUTH2_CLIENT_ID="<application-id>"
  GITLAB_OAUTH2_CLIENT_SECRET="<application-secret>"

• Replace <your-gitlab-url> by domain of your GitLab server

  JOBS_GITLAB_URL="https://<your-gitlab-url>"

• If you want to connect Plumber to a specific GitLab group only: add the path of the group in ORGANIZATION variable (to run the onboarding, you must be at least Maintainer in this group)

  ORGANIZATION="<group-path>"

• If you want to connect Plumber to the whole GitLab instance: let the ORGANIZATION variable empty (to run the onboarding, you must be a GitLab instance Admin)

  ORGANIZATION=""

Step 4: Generate secrets

Generate random secrets and set them in your .env file:

sed -i."" "s/^SECRET_KEY=.*/SECRET_KEY=\"$(openssl rand -hex 32)\"/" .env
sed -i."" "s/^JOBS_DB_PASSWORD=.*/JOBS_DB_PASSWORD=\"$(openssl rand -hex 16)\"/" .env
sed -i."" "s/^JOBS_REDIS_PASSWORD=.*/JOBS_REDIS_PASSWORD=\"$(openssl rand -hex 16)\"/" .env

Step 5: Launch Plumber

docker compose -f compose.local.yml up -d

Open your Plumber test instance at http://localhost:3000