Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
48 changes: 20 additions & 28 deletions .env.example
Original file line number Diff line number Diff line change
Expand Up @@ -3,35 +3,27 @@
# Documentation: https://getplumber.io/docs/installation/docker-compose/ #
##########################################################################

# Main
DOMAIN_NAME="plumber.<domain_name>"
CERTIFICATE_EMAIL="tech@getplumber.io"
JOBS_GITLAB_URL="https://<url_of_your_gitlab_instance>"
FRONTEND_IMAGE_TAG="v2.32.5"
BACKEND_IMAGE_TAG="v2.36.4"
# Required configuration
DOMAIN_NAME=""
JOBS_GITLAB_URL=""
ORGANIZATION=""
GITLAB_OAUTH2_CLIENT_ID=""
GITLAB_OAUTH2_CLIENT_SECRET=""

# Secrets
GITLAB_OAUTH2_CLIENT_ID="REPLACE_ME_BY_CLIENT_ID"
GITLAB_OAUTH2_CLIENT_SECRET="REPLACE_ME_BY_CLIENT_SECRET"
SECRET_KEY="REPLACE_ME_BY_SECRET_KEY"
JOBS_DB_PASSWORD="REPLACE_ME_BY_JOBS_DB_PASSWORD"
JOBS_REDIS_PASSWORD="REPLACE_ME_BY_JOBS_REDIS_PASSWORD"
# Auto-generated secrets (populated by install script)
SECRET_KEY=""
JOBS_DB_PASSWORD=""
JOBS_REDIS_PASSWORD=""

# Edit only if you use external database
JOBS_DB_USER="jobs"
JOBS_DB_NAME="jobs"
JOBS_DB_HOST="postgres"
JOBS_DB_PORT="5432"
JOBS_DB_SSLMODE="disable"
JOBS_DB_TIMEZONE="Europe/Paris"
# Deployment profile (set by install script)
# Options: letsencrypt or custom-certs, combined with internal-db or omit for external
COMPOSE_PROFILES="letsencrypt,internal-db"
CERT_RESOLVER="le"

############################################
# Below configuration shouldn't be updated #
############################################

# Shared configuration
FRONTEND_DOMAIN="$DOMAIN_NAME"
API_DOMAIN="$DOMAIN_NAME"
API_PATH="/api"
API_URL="$API_DOMAIN$API_PATH"
# Optional: Override database defaults (only needed when NOT using internal-db profile)
# JOBS_DB_HOST="your-db-host"
# JOBS_DB_PORT="5432"
# JOBS_DB_USER="jobs"
# JOBS_DB_NAME="jobs"
# JOBS_DB_SSLMODE="disable"
# JOBS_DB_TIMEZONE="Europe/Paris"
33 changes: 9 additions & 24 deletions .env.local.example
Original file line number Diff line number Diff line change
@@ -1,30 +1,15 @@
###############################################################################
# Plumber configuration file #
# Plumber local configuration file #
# Documentation: https://getplumber.io/docs/installation/local-docker-compose #
###############################################################################

# Main
JOBS_GITLAB_URL="GITLAB_INSTANCE_URL"
FRONTEND_IMAGE_TAG="v2.32.5"
BACKEND_IMAGE_TAG="v2.36.4"
# Required configuration
JOBS_GITLAB_URL=""
ORGANIZATION=""
GITLAB_OAUTH2_CLIENT_ID=""
GITLAB_OAUTH2_CLIENT_SECRET=""

# Secrets
GITLAB_OAUTH2_CLIENT_ID="REPLACE_ME_BY_CLIENT_ID"
GITLAB_OAUTH2_CLIENT_SECRET="REPLACE_ME_BY_CLIENT_SECRET"
SECRET_KEY="REPLACE_ME_BY_SECRET_KEY"
JOBS_DB_PASSWORD="REPLACE_ME_BY_JOBS_DB_PASSWORD"
JOBS_REDIS_PASSWORD="REPLACE_ME_BY_JOBS_REDIS_PASSWORD"

############################################
# Below configuration shouldn't be updated #
############################################

# Shared configuration
FRONTEND_DOMAIN="localhost:3000"
API_DOMAIN="http://localhost:3001"
API_PATH="/api"

# Jobs database
JOBS_DB_USER="jobs"
JOBS_DB_NAME="jobs"
# Auto-generated secrets (populated by install script)
SECRET_KEY=""
JOBS_DB_PASSWORD=""
JOBS_REDIS_PASSWORD=""
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,16 @@ This project contains resources to setup a self-managed instance of [Plumber](ht

## Installation

Two installation methods:
- 🐳 **Docker Compose** — [Documentation](https://getplumber.io/docs/installation/docker-compose/)

- 🐳 [Docker compose](https://getplumber.io/docs/installation/docker-compose/)
- ☸️ [Kubernetes with Helm](https://getplumber.io/docs/installation/kubernetes/)
```bash
curl -fsSL https://raw.githubusercontent.com/getplumber/platform/main/install.sh | bash
```

- ☸️ **Kubernetes with Helm** — [Documentation](https://getplumber.io/docs/installation/kubernetes/)

## Contributions

You are welcome to help us improve this repository!

🎮 Open an Issue or create Pull Requests from your fork

For the [Helm chart](charts/plumber/README.md), there is a dedicated [contributing page](charts/plumber/CONTIBUTING.md).
🎮 Open an Issue or create Pull Requests from your fork
4 changes: 2 additions & 2 deletions charts/plumber/Chart.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ apiVersion: v2
name: plumber
description: Helm chart for Plumber
type: application
version: "1.0.2"
appVersion: "1.0.2"
version: "1.0.3"
appVersion: "1.0.3"
home: https://github.com/getplumber/platform/
maintainers:
- name: devpro
Expand Down
4 changes: 2 additions & 2 deletions charts/plumber/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ backend:
type: backend
name: plumber-backend
image: docker.io/getplumber/backend
tag: v2.36.4
tag: v2.36.5
replicaCount: 1
revisionHistoryLimit: 5
port: 3000
Expand Down Expand Up @@ -150,7 +150,7 @@ worker:
type: backend
name: plumber-worker
image: docker.io/getplumber/backend
tag: v2.36.4
tag: v2.36.5
replicaCount: 5
revisionHistoryLimit: 5
args:
Expand Down
166 changes: 0 additions & 166 deletions compose.custom_certs.yml

This file was deleted.

Loading