For AI agents: visit https://documentation.bunnyshell.com/llms.txt for an index of all pages formatted in Markdown and endpoints in OpenAPI.
Jump to Content
Documentation
API Reference
Changelog
v1.5.1
v1.5.2
Log In
Documentation
Log In
v1.5.2
Documentation
API Reference
Changelog
Bunnyshell Requirements
INTRODUCTION
What is Bunnyshell
Bunnyshell Requirements
Basic Terminology
How Bunnyshell works
QUICKSTART GUIDE
USING BUNNYSHELL
Organizations
Projects
Project Settings
Environments
Environment View
Environment Actions
Environment definition - bunnyshell.yaml
Settings
Workspaces
Creating and Connecting a Workspace to Your IDE
Components
Docker Compose
Health checks for Docker Compose
CronJobs for Docker Compose
Volumes for Docker Compose
Ingress for Docker Compose
Horizontal Pod Autoscaling for Docker Compose
Docker Image
Custom Docker Image
Docker build
Gradle Jib build
Helm
Kubernetes Manifest
Terraform
Generic Component
Static Application
Environment workflows & Pipelines
Deploy
Destroy
Start
Stop
Variables
Variable Interpolation
Variable Groups
Variable Interpolation Filters
Data seeding
Container database
Cloud-managed database
SaaS / serverless database
URLs
Exposing URLs
Customizing URLs
Custom domains
Custom Load Balancer Configuration
Securing access for certain IPs
Troubleshooting
Troubleshooting workflows
Troubleshooting components
Public API
SDK
Whitelisting Bunnyshell IP Addresses
BUNNYSHELL CLI
Bunnyshell CLI Overview
Install the CLI
CLI Authentication
Shell Autocomplete
Secrets
Port Forwarding
SSH
Debug
CLI Profiles
Variables Import
REMOTE DEVELOPMENT
Remote Development Overview
Start Remote Development
Obtain the Component ID
Sync files from local
Exclusive remote files
Sharing the configuration
Debugging remotely with VS Code
Pre-requisites
Start Remote Development
Configure the connection
Develop (Edit Files)
Debug
Debug node.js
Debug PHP
Debug Java
Debugging locally with port forwarding
Debugging node.js
Debugging PHP
Debugging Java
Debugging frontend apps
Debugging frontend in VS Code
Debugging frontend in Jetbrains
Stop Remote Development
Prevent Remote Development
TEMPLATES
What are Templates
Use Templates in Bunnyshell
Clone Template repositories
Add your own Templates
Prepare repository for Custom Templates
Configurable Templates with Variables
Sync Environment with Template
Common configurations
Build Settings
Resource Allocation
Namespace isolation
Ingress Controller Service Type
INTEGRATIONS
Git Providers
GitHub
Self-hosted GitHub
Self-hosted GitLab
Self-hosted Azure DevOps
Git ChatOps
Kubernetes clusters
Bunnyshell Kubernetes Cluster
AWS Kubernetes Cluster
Azure Kubernetes Cluster
GCP Kubernetes Cluster
DigitalOcean Kubernetes Cluster
Scaleway Kubernetes Cluster
DT Cloud Kubernetes Cluster
Private Kubernetes Cluster
Kubernetes Cluster Changes
Image Registries
AWS ECR
Azure Container Registry
Docker Hub
GitHub Container Registry
GitLab Container Registry
Google Container Registry
Google Artifact Registry - Docker Repository
Harbor
JFrog Artifactory
Scaleway Registry
Sonatype Nexus Registry
Private Image Registry
Slack
Microsoft Teams
CONNECTORS
What are connectors
Neon database (Postgres)
PlanetScale database (MySQL)
Xata data platform
KUBERNETES CLUSTERS
Create a cluster
Create an AWS Kubernetes Cluster
Create an Azure Kubernetes Cluster
Create a GCP Kubernetes Cluster
Private and Air-Gapped Cluster
Prepare the cluster
Building images
AWS Docker-compose volumes
Azure Docker-compose volumes
GCP Docker-compose volumes
DigitalOcean Docker-compose volumes
Scaleway docker-compose volumes
DT Cloud docker-compose volumes
Private Cluster docker-compose volumes
COSTS
Cost Tracking
Activate Cost Tracking
Cost Reporting
METRICS
Engineering Metrics
Metrics explained
Bunnyshell in 5 minutes
Creating and Deploying your first Environment
Creating and Deploying your first Ephemeral Environment
Destroying Ephemeral Environments
Keeping your environment up-to-date
Limited environment availability
QUICKSTART GUIDE
Quickstart Overview
Bunnyshell use cases
Create & Deploy the Environment
Common configuration
How to edit bunnyshell.yaml
Change the branch for an app
Environment Auto-Update
Environment Start/Stop
Ephemeral Environments
Create & Destroy an Ephemeral Environment
Remote Development
Troubleshooting
Troubleshooting in Bunnyshell
Troubleshooting in Kubernetes
CLI, API & SDK
Completed Quickstart Guide
QUICKSTART : DEPLOY : HELM
Helm Overview
Deploying the Application
Fork the project repository
Create the Environment
Define the Environment
Deploy the Environment
Understand how Bunnyshell works
Components & workflows
Workflow Runner
Export Variables
DNS Records & Ingresses
Continue Quickstart Guide
QUICKSTART : DEPLOY : DOCKER-COMPOSE
Docker-compose Overview
Deploying the Application
Fork the project repository
Create the Environment
Define the Environment
Deploy the Environment
Understand how Bunnyshell works
Connect services
Expose ports
Expose public endpoints
Use Persistent Volumes
Workflow details
Best practices for docker-compose
Continue Quickstart Guide
TERRAFORM QUICKSTART GUIDE
Terraform Overview
Pre-requisites
Terraform use cases
Application changes
Using Terraform modules in Environments
Troubleshooting
REFERENCE GUIDE
Environment definition file (bunnyshell.yaml)
components
deployment
environmentVariables
environmentVariablesGroups
security
dev
Docker compose conversion support
MCP Server
MCP
Powered by
Bunnyshell Requirements
Copy Page
