Jump to Content
Bunnyshell Docs
DocumentationAPI ReferenceChangelog
Log InBunnyshell Docs
Log In
DocumentationAPI ReferenceChangelog

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
  • Components
    • Docker Compose
    • Docker Image
    • Helm
    • Kubernetes Manifest
    • Terraform
    • Generic Component
  • Environment workflows & Pipelines
    • Deploy
    • Destroy
    • Start
    • Stop
  • Variables
    • Variable Interpolation
  • Volumes for Docker Compose
  • CronJobs for Docker Compose
  • Health checks for Docker Compose
  • Data seeding
    • Container database
    • Cloud-managed database
    • SaaS / serverless database
  • Custom domains
  • Troubleshooting
    • Troubleshooting workflows
    • Troubleshooting components
  • Public API
  • SDK

BUNNYSHELL CLI

  • Bunnyshell CLI Overview
  • Install the CLI
  • CLI Authentication
  • Shell Autocomplete
  • Port Forwarding
  • SSH
  • CLI Profiles

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
  • Sync Environment with Template

Common configurations

  • Build Settings
    • Resource Allocation
  • Customizing URLs
  • Exposing URLs
  • Securing access for certain IPs
  • Namespace isolation
  • Ingress Controller Service Type

INTEGRATIONS

  • Git Providers
    • GitHub
    • Self-hosted GitHub
    • Self-hosted GitLab
  • Kubernetes clusters
    • Bunnyshell Kubernetes Cluster
    • AWS Kubernetes Cluster
    • Azure Kubernetes Cluster
    • DigitalOcean Kubernetes Cluster
    • GCP Kubernetes Cluster
    • Private Kubernetes Cluster
  • Image Registries
    • AWS ECR
    • JFrog Artifactory
    • Docker Hub
    • Google Container Registry
  • Slack

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
  • Prepare the cluster
    • Building images
    • AWS Docker-compose volumes
    • Azure Docker-compose volumes
    • DigitalOcean Docker-compose volumes
    • GCP 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
    • security
    • dev
  • Docker compose conversion support
Powered by 

Common configuration

Suggest Edits

This section presents configuration options which are frequently used by Bunnyshell users.

How to edit bunnyshell.yaml

Change branch for an app

Secure your Environment

Environment auto-update

Environment start/stop

Best practices for docker-compose

Updated 7 months ago

  • Table of Contents
    • How to edit bunnyshell.yaml
    • Change branch for an app
    • Secure your Environment
    • Environment auto-update
    • Environment start/stop
    • Best practices for docker-compose