Plugin marketplace

The Plugin Marketplace is an opt-in feature that adds a browseable catalog of community-built Faheem Code plugins to your Enterprise deployment. Once enabled, users can discover and review plugins directly at /plugins on your application hostname.

Note

The Plugin Marketplace is an experimental feature. Enable it only after your Faheem Code Enterprise deployment is fully operational.

Screenshot: Plugin Marketplace demo.

Prerequisites

• A running Faheem Code Enterprise deployment. See Quick Start if you haven't already deployed.
• The bundled or external PostgreSQL database must be reachable. The marketplace creates a separate plugindir database to store plugin metadata.
• A Marketplace Source URI pointing to a plugin catalog (see Marketplace Source URI).

Enable the plugin marketplace

The Plugin Marketplace is configured through the Replicated Admin Console.

1. Open the Admin Console

Navigate to https://admin.<your-base-domain>:30000 and log in.

2. Open the configuration page

Click Config in the top navigation bar to open the application configuration page.

3. Enable the Plugin Directory

Scroll to the Experimental section near the bottom of the configuration page.

Check the Enable Plugin Directory box.

Screenshot: Enable Plugin Directory.

4. Set the Marketplace Source

Once Enable Plugin Directory is checked, a Marketplace Source field appears.

Enter the URI of the plugin catalog you want to load. For example:

github://AcmeCo/plugin-directory

To pin to a specific release of the catalog, append a @ref tag:

github://AcmeCo/plugin-directory@v1.0.0

See Marketplace Source URI for a full description of supported formats.

5. Save and deploy

Scroll to the bottom of the configuration page and click Save config, then click Deploy to apply the changes.

The deployment status will show Unavailable while the Plugin Directory pods start, then transition to Ready once all components are healthy.

If you deployed Faheem Code Enterprise into your own Kubernetes cluster using Helm, enable the Plugin Marketplace by adding the following values to your values.yaml override file.

Required values

plugin-directory:
  enabled: true

  # Full URL where the plugin catalog is served
  appUrl: "https://app.<your-base-domain>/plugins"

  # Base URL used in in-page curl examples
  curlApiUrl: "https://app.<your-base-domain>"

  appEnv:
    # URI of the plugin catalog to load (required)
    MARKETPLACE_SOURCE: "github://AcmeCo/plugin-directory"

  database:
    host: "<postgres-host>"
    name: "plugindir"
    # Name of the Kubernetes Secret that contains the PostgreSQL password
    secretName: "postgres-password"
    secretKey: "password"

  auth:
    # Secret created by the faheem-code-secrets chart
    existingSecret: plugin-directory-secrets

  oidc:
    # Keycloak issuer URL — must match your Keycloak realm
    issuerUrl: "https://auth.<your-base-domain>"
    realmSecretName: "keycloak-realm"

Required secrets

The Plugin Directory needs two shared secrets for inter-service authentication and session management. Add these to your faheem-code-secrets chart values:

plugin_directory_identity_shared_secret: "<random-32-character-string>"
plugin_directory_session_secret: "<random-32-character-string>"

Generate each value with:

openssl rand -hex 16

Apply the changes

helm upgrade faheemcode oci://registry.replicated.com/faheemcode/faheemcode \
  --namespace faheemcode \
  --values values.yaml

Database migration

On first deployment, init containers automatically create the plugindir database and run Alembic migrations. No manual database setup is required.

Note

If you use an external PostgreSQL instance with databaseMigrations.createDatabases: false, create the plugindir database manually before deploying.

Marketplace source URI

The MARKETPLACE_SOURCE value (or Marketplace Source field in the Admin Console) tells the Plugin Directory server where to load its plugin catalog from.

Format	Example	Notes
github://owner/repo	github://AcmeCo/plugin-directory	Loads from the default branch of the repository
github://owner/repo@ref	github://AcmeCo/plugin-directory@v1.2.0	Loads from a specific branch, tag, or commit SHA
https://example.com/catalog.json	https://cdn.example.com/plugins/catalog.json	Loads a catalog JSON file over HTTPS

To host a private or curated catalog, point the URI to a GitHub repository or an HTTPS URL that serves a compatible catalog JSON file.

Accessing the marketplace

Once the deployment is complete and shows Ready, the Plugin Marketplace is available at:

https://app.<your-base-domain>/plugins

Users authenticate through the same Keycloak SSO used for the rest of Faheem Code Enterprise. The Plugin Directory API is also available at:

https://app.<your-base-domain>/api/plugins

Disabling the plugin marketplace

Open the Admin Console, navigate to Config, uncheck Enable Plugin Directory in the Experimental section, click Save config, then Deploy.

Set plugin-directory.enabled: false in your values.yaml and run helm upgrade.

Next steps

Quick start

Install or review the full Faheem Code Enterprise deployment guide.

External PostgreSQL

Configure an external PostgreSQL database for Faheem Code Enterprise.

Kubernetes installation

Deploy Faheem Code Enterprise into your own Kubernetes cluster using Helm.

Enterprise overview

Learn about all Faheem Code Enterprise features and deployment options.