Podman

📥 Setup your environment

Clone the repository on your server

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

Create your configuration file

cp .env.example .env

📋 Configure Organization

In your .env file:

• 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=""

📄 Configure Domain name

Edit the .env file by updating value of DOMAIN_NAME and JOBS_GITLAB_URL variables

DOMAIN_NAME="<plumber_domain_name>"
JOBS_GITLAB_URL="https://<url_of_your_gitlab_instance>"

DOMAIN_NAME="plumber.mydomain.com"
JOBS_GITLAB_URL="https://gitlab.mydomain.com"

Create DNS record:

• Name: <plumber_domain_name>
• Type: A
• Content: <your-server-public-ip>

🦊 Configure GitLab OIDC

Plumber uses GitLab as an OAuth2 provider to authenticate users.

Create an application on your GitLab instance. Choose any group, then navigate to Settings > Applications.

Create an application with the following information:

Click on Save Application, then copy the credentials into your .env file:

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

🔐 Generate secrets

Generate random secrets for all components:

sed -i "s/REPLACE_ME_BY_SECRET_KEY/$(openssl rand -hex 32)/g" .env
sed -i "s/REPLACE_ME_BY_JOBS_DB_PASSWORD/$(openssl rand -hex 16)/g" .env
sed -i "s/REPLACE_ME_BY_JOBS_REDIS_PASSWORD/$(openssl rand -hex 16)/g" .env

📋 (Optional) Add your custom CA

If your GitLab instance is using a TLS certificate signed with your own Certificate authority (CA), add the CA certificate file in the appropriate directory.

📄 Prepare podman for launch

Generate podman network:

podman network create intranet

Generate podman socket:

systemctl --user start podman.socket
systemctl --user enable podman.socket

If you encounter the error Failed to connect to bus: No medium found, use these commands with your user as sudoer:

sudo loginctl enable-linger <your_local_user>
sudo systemctl --user -M <your_local_user>@ start podman.socket
sudo systemctl --user -M <your_local_user>@ enable podman.socket

Generate podman config files:

set -a; source .env; set +a
export uid=$(id -u)
envsubst < podman.yml.example > podman.yml
envsubst < configmap.yml.example > configmap.yml

Allow port 80 and above in system for local user:

Add this line to /etc/sysctl.conf as sudo user or root:

net.ipv4.ip_unprivileged_port_start=80

Restart sysctl:

sudo systemctl restart systemd-sysctl

🚀 Launch the application

podman play kube podman.yml --configmap configmap.yml --network intranet

podman play kube podman.yml --replace --configmap configmap.yml --network intranet

🦊 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:

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

📥 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

📚 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

  ORGANIZATION="<group-path>"

• If you want to connect Plumber to the whole GitLab instance: let the ORGANIZATION variable empty

  ORGANIZATION=""

Run the following commands to generate random secrets for all components:

sed -i "s/REPLACE_ME_BY_SECRET_KEY/$(openssl rand -hex 32)/g" .env
sed -i "s/REPLACE_ME_BY_JOBS_DB_PASSWORD/$(openssl rand -hex 16)/g" .env
sed -i "s/REPLACE_ME_BY_JOBS_REDIS_PASSWORD/$(openssl rand -hex 16)/g" .env

📄 Prepare podman for launch

Generate podman network:

podman network create intranet

Generate podman socket:

systemctl --user start podman.socket
systemctl --user enable podman.socket

Generate podman config files:

set -a; source .env; set +a
export uid=$(id -u)
envsubst < podman.local.yml.example > podman.yml
envsubst < configmap.local.yml.example > configmap.yml

🚀 Launch Plumber!

Start Plumber

podman play kube podman.yml --configmap configmap.yml --network intranet

Open your Plumber test instance 👉 click here 🎉

Navigate to the location of your platform git repository

Update it

git pull

Open the .env.example file and copy the values of FRONTEND_IMAGE_TAG and BACKEND_IMAGE_TAG variables

Edit the .env file by updating those values

FRONTEND_IMAGE_TAG="<new frontend version>"
BACKEND_IMAGE_TAG="<new backend version>"

Regenerate config files and restart

set -a; source .env; set +a
export uid=$(id -u)
envsubst < podman.yml.example > podman.yml
envsubst < configmap.yml.example > configmap.yml
podman play kube podman.yml --replace --configmap configmap.yml --network intranet

You have successfully updated Plumber 🎉

Navigate to the location of your platform git repository

Update it

git pull

Open the .env.local.example file and copy the values of FRONTEND_IMAGE_TAG and BACKEND_IMAGE_TAG variables

Edit the .env file by updating those values

FRONTEND_IMAGE_TAG="<new frontend version>"
BACKEND_IMAGE_TAG="<new backend version>"

Update local yaml files and restart

set -a; source .env; set +a
export uid=$(id -u)
envsubst < podman.local.yml.example > podman.yml
envsubst < configmap.local.yml.example > configmap.yml
podman play kube podman.yml --replace --configmap configmap.yml --network intranet

You have successfully updated Plumber 🎉