Customizing Webhooks
Layer5 Cloud uses webhooks to automate approval flows and email notifications. This guide will help you customize and add your own custom webhooks.
Self-Hosted
Keep your Kanvas designs internal to your workplace. Get remote support from Layer5 when you need it.
Categories:
On-premises Deployment of Layer5 Cloud 🔗
A self-hosted deployment runs the same Layer5 Cloud that Layer5 operates, on infrastructure you control. Your users sign in against your identity services, your organizations and designs live in your database, and Meshery Servers in your network connect to your deployment as their remote provider.
One Helm chart, layer5-cloud, installs the application and its two identity services. You supply the database, the ingress, and the TLS certificate.
| Component | Provided by | What it does |
|---|---|---|
| Layer5 Cloud server | layer5-cloud chart | Serves the web UI and the API, enforces organizations, teams, roles, and keys, and runs the signaling endpoint for real-time co-editing. Listens on port 9876. |
| Kratos | Subchart | Owns accounts: password sign-in, social sign-in, email verification, and account recovery. |
| Hydra | Subchart | Issues OAuth2 tokens to the UI, to Meshery Servers, and to API clients. |
| PostgreSQL | You | Holds three databases on one server: meshery, kratos, and hydra. |
| Ingress controller and TLS | You | Publishes one hostname. Routes / to the server, /kratos to Kratos, /hydra to Hydra, and passes WebSocket upgrades on /collaboration. |
| SMTP relay | You | Sends invitations, notifications, and identity mail (verification and recovery). |
| Webhook receivers | You | Optional endpoints that receive support requests, signup decisions, and Kanvas entitlement events. |
Meshery Server is deployed separately and is not part of this chart. See Meshery Server registration.
| Area | On your deployment |
|---|---|
| Provider administration | Your operators hold the Provider Admin role. They create the first organization, assign custom roles, and approve signup requests. See Default Permissions. |
| Default sign-in providers | You register the Google and GitHub OAuth applications that every organization without its own credentials uses. See Identity Services. |
| The shared relay is yours. Organizations can still register their own. See Email / SMTP Troubleshooting. | |
| Branding and domains | Organizations apply their own theme and domain; you set the provider-level defaults. See White-labeling. |
| Upgrades | You choose when to upgrade. The server applies database migrations at startup. |
| GitHub | You register your own GitHub App. See Self-hosted GitHub App requirements. |
Considerations of Self-Hosted Deployments 🔗
- Planning. Decide on the database, hostname, identity providers, mail relay, provider administrator, and network paths.
- Deploying Layer5 Cloud. Install with Helm, create the Hydra client, and confirm the deployment is ready.
- Configure. Set chart values, provider initialization, and webhooks.
- Operate. Watch health and logs and diagnose mail delivery.
Real-time co-editing has one network dependency outside your cluster: browsers must reach public STUN and TURN hosts to connect to each other. See Networking before you deploy into a restricted network. A self-hosted provider is its own signaling host. Users connected to your deployment never signal through Layer5’s hosted service.
For help with a deployment, see Support.
White-labeling (Rebranding)
Customize the appearance and branding of your engineering platform powered by Layer5 Cloud.
Deploying Layer5 Cloud
Layer5 Cloud is a collection of services that can be deployed on-premises using Helm.
Planning
Plan your self-hosted Layer5 Cloud deployment
Email / SMTP Troubleshooting
This guide explains how to diagnose email sending issues in Layer5 Cloud deployments using the enhanced debug logging and testing features.