Easypanel Templates

The Budibase template deploys a multi-service architecture. Each service relies on specific environment variables and internal networking patterns using $(PROJECT_NAME) and $(EASYPANEL_DOMAIN) placeholders.

Services Deployed:

1. Redis (type: "redis")

   • Provides caching and session management.
   • Uses REDIS_URL and REDIS_PASSWORD for connection.

2. CouchDB (type: "app")

   • The primary database.
   • Image: budibase/couchdb:v3.3.3-sqs-v2.1.1.
   • Mounts: couchdb-data volume at /opt/couchdb/data.
   • Connection: COUCH_DB_URL (format: http://user:pass@$(PROJECT_NAME)_service-couchdb:5984).

3. MinIO (type: "app")

   • Object storage.
   • Image: quay.io/minio/minio:latest.
   • Mounts: data volume at /data.
   • Domains:
     • $(EASYPANEL_DOMAIN) on port 9000 (API).
     • console-$(EASYPANEL_DOMAIN) on port 9001 (Console).
   • Command: minio server /data --console-address ":9001".

4. Worker (type: "app")

   • Background task processor.
   • Image: Defined by input.workerServiceImage.
   • Key Envs: SELF_HOSTED=1, PORT=4003, MINIO_URL, COUCH_DB_URL, REDIS_URL.

5. App (type: "app")

   • The main Budibase application.
   • Image: Defined by input.appServiceImage.
   • Key Envs: BB_ADMIN_USER_EMAIL, BB_ADMIN_USER_PASSWORD, BUDIBASE_ENVIRONMENT=PRODUCTION, PORT=4002.

6. Proxy (type: "app")

   • The entrypoint for external traffic.
   • Image: budibase/proxy.
   • Domain: $(EASYPANEL_DOMAIN) on port 10000.
   • Upstream URLs: Routes traffic to app, worker, minio, and couchdb services using their internal network names.

The AdGuard Home Sync service is configured using a YAML file. The configuration supports cron scheduling, origin instance details, and replica management (single or multiple).

cron: "*/10 * * * "

origin:
  # url of the origin instance
  url: https://192.168.1.2:3000
  # apiPath: define an api path if other than "/control"
  # insecureSkipVerify: true # disable tls check
  username: username
  password: password

# replica instance (optional, if only one)
replica:
  # url of the replica instance
  url: http://192.168.1.3
  username: username
  password: password

# replicas instances (optional, if more than one)
# replicas:
#   - url: http://192.168.1.3
#     username: username
#     password: password
#   - url: http://192.168.1.4
#     username: ${input.apiUsername}
#     password: ${input.apiPassword}

# Configure the sync API server, disabled if api port is 0
api:
  # Port, default 8080
  port: 8080
  # if username and password are defined, basic auth is applied to the sync API
  username: username
  password: password

The Libredesk application is configured using a config.toml file mounted at /libredesk/config.toml. The template automatically populates several key sections:

Key Configuration Sections

• [app]: Contains log_level, env (default prod), check_updates, and the encryption_key.
• [app.server]: Configures the HTTP server (default address 0.0.0.0:9000, timeouts, and max body size).
• [upload]: Defines the provider (fs or s3). The template defaults to fs with an upload_path of uploads.
• [db]: Configures Postgres connection details. The host is automatically set to $(PROJECT_NAME)_${input.appServiceName}-db.
• [redis]: Configures Redis connection details. The address is set to $(PROJECT_NAME)_${input.appServiceName}-redis:6379.
• [message], [notification], [automation], [autoassigner], [webhook], [conversation], [sla]: Various worker counts, queue sizes, and interval settings for application logic.

The generate function is the entrypoint for the Infisical template. It takes an Input object and returns an Output object containing a list of configured services.

When called, it performs the following actions:

1. Generates random passwords for the PostgreSQL and Redis services using randomPassword().
2. Generates 32-character random strings for ENCRYPTION_KEY and AUTH_SECRET using randomString(32).
3. Constructs a set of common_envs containing database URIs, Redis URLs, and various placeholder environment variables for SMTP, OAuth providers (GitHub, Vercel, etc.), Sentry, PostHog, and OpenTelemetry.
4. Defines three specific services:
   • Migration App: An app type service running npm run migration:latest using the provided input.appServiceImage.
   • Web App: An app type service running the provided input.appServiceImage on port 80, mapped to the $(EASYPANEL_DOMAIN).
   • PostgreSQL: A postgres type service with a generated password.
   • Redis: A redis type service with a generated password.

Note: The database and redis connection strings use the pattern $(PROJECT_NAME)_${input.appServiceName}-db and $(PROJECT_NAME)_${input.appServiceName}-redis respectively.

import { generate } from './templates/infisical/index';

// Example usage (conceptual)
const output = generate({
  appServiceName: 'my-app',
  appServiceImage: 'infisical/infisical:latest'
});

console.log(output.services);