# Deploio Guides

> Deploy and manage apps easily with Deploio

These are the user guides for Deploio, a container-based infrastructure platform. It's a collection of use cases which can be followed from A to Z.

## Table of Contents

### Introduction

- [What is Deploio?](https://guides.deplo.io/introduction/about-deploio.md): Introduction to Deploio, a container-based platform by Nine and Renuo that simplifies application deployment with seamless workflows and integrated solutions.
- [How Deploio Works](https://guides.deplo.io/introduction/how-deploio-works.md): Explains the repo-build-release process, workflow, and key concepts including projects, deployments, Cockpit, and nctl CLI in Deploio's Kubernetes infrastructure.
- [Our Stack](https://guides.deplo.io/introduction/our-stack.md): Overview of Deploio's technology stack including Nutanix infrastructure, Kubernetes orchestration, Swiss hosting (AS29691), Docker containers, and Heroku buildpacks.

### User Guides

- [Getting Started](https://guides.deplo.io/user-guide/getting-started.md): Complete guide for getting started with Deploio including nctl CLI installation, account setup, project creation, and best practices to avoid common pitfalls.
- [Code Repository Setup](https://guides.deplo.io/user-guide/code-repository-setup.md): Instructions for connecting Git repositories to Deploio using SSH keys or HTTPS for GitHub, GitLab, Bitbucket, and private Git servers.
- [Configuring Your Application](https://guides.deplo.io/user-guide/configuring-your-application.md): Complete reference for configuring applications on Deploio including environment variables, deploio.yaml, Procfile, worker jobs, deploy jobs, and resource sizing.
- [Configuring your Database](https://guides.deplo.io/user-guide/configuring-your-database.md): Comprehensive guide for creating and managing PostgreSQL and MySQL databases on Deploio including Economy and Business tiers, configuration, backups, monitoring, and troubleshooting.
- [Other Dependencies](https://guides.deplo.io/user-guide/other-dependencies.md): Guide for setting up Redis-compatible key-value stores, object storage, and persistent volumes as dependencies for Deploio applications.
- [Network & Deployment](https://guides.deplo.io/user-guide/network-and-deployment.md): Guide for setting up custom domains with DNS records (CNAME and TXT) and configuring automatic SSL certificates via Let's Encrypt on Deploio.
- [CI/CD Integration](https://guides.deplo.io/user-guide/ci-cd-integration.md): Instructions for automating deployments using nctl CLI in CI/CD pipelines with API service accounts, deployment triggers, and status feedback scripts.
- [Monitoring and Logs](https://guides.deplo.io/user-guide/monitoring-and-logs.md)
- [Security](https://guides.deplo.io/user-guide/security.md): Overview of Deploio's security model including TLS, access control, secrets, network boundaries, container isolation, and best practices.
- [Troubleshooting](https://guides.deplo.io/user-guide/troubleshooting.md)
- [FAQ](https://guides.deplo.io/user-guide/faq.md)
- [Tools](https://guides.deplo.io/user-guide/tools.md)
- [Claude Code Plugin](https://guides.deplo.io/user-guide/claude-plugin.md): Deploy and manage Deploio apps using plain English in Claude Code. No CLI commands to memorise.
- [Migrating from Other Platforms](https://guides.deplo.io/user-guide/migrating-from-other-platforms.md): Migration guide for moving applications to Deploio from Heroku and other platforms including database exports, environment variables, DNS updates, and CI/CD adaptation.

### Ruby on Rails

- [Create a Rails Application](https://guides.deplo.io/ruby/quick-start.md): Step-by-step guide for deploying Ruby on Rails applications on Deploio using Heroku buildpacks with nctl CLI and Git repositories.
- [Create a database for your Rails application](https://guides.deplo.io/ruby/database.md): Instructions for creating and configuring PostgreSQL or MySQL databases for Rails applications including connection setup, migrations, and troubleshooting.
- [Create a Key Value Store for your Ruby on Rails application](https://guides.deplo.io/ruby/key-value-storage.md): Guide for setting up Redis-compatible key-value stores for Rails applications to support caching and background job systems like Sidekiq.
- [Active Storage on Deploio](https://guides.deplo.io/ruby/active-storage.md): Complete guide for configuring Active Storage with S3-compatible object storage on Deploio including Nine S3 buckets, custom hostnames, and signed URLs.
- [Setup Background Jobs for your Rails application](https://guides.deplo.io/ruby/background-jobs.md): Instructions for adding background worker jobs to Rails applications using Solid Queue, GoodJob, or Sidekiq, including worker creation, monitoring, and removal.
- [Configure Continuous Deployment for Your Rails Application](https://guides.deplo.io/ruby/continuous-deployment.md): Guide for setting up continuous deployment pipelines for Rails applications using API service accounts, nctl CLI automation, and deployment status monitoring.

### PHP

- [Quick Start Guide for PHP Applications](https://guides.deplo.io/php/quick-start.md): Quick start guide for deploying plain PHP applications on Deploio using the Paketo PHP buildpack with configuration for web directories and Composer options.
- [Create a Database for Your PHP Application](https://guides.deplo.io/php/database.md): Instructions for creating and configuring PostgreSQL or MySQL databases for PHP applications including Doctrine integration, migrations, and connection troubleshooting.
- [Create a Key Value Store for your PHP application](https://guides.deplo.io/php/key-value-storage.md): Guide for setting up Redis-compatible key-value stores for PHP applications supporting caching and Symfony configurations with TLS connections.
- [Create an Object Storage for your PHP application](https://guides.deplo.io/php/object-storage.md): Guide for configuring S3-compatible object storage for PHP applications using Flysystem for file uploads and persistent storage needs.
- [Setup Background Jobs for your PHP application](https://guides.deplo.io/php/background-jobs.md): Instructions for adding background worker jobs to PHP applications for Symfony Scheduler or Messenger with worker creation, log monitoring, and removal.
- [Configure the CD for Your PHP Application](https://guides.deplo.io/php/continuous-deployment.md): Guide for setting up continuous deployment pipelines for PHP applications using API service accounts, nctl CLI automation, and deployment status monitoring.
- [Build Environment](https://guides.deplo.io/php/build-environment.md): Configuration guide for PHP build environment including web directory setup and web server selection (PHP built-in, Apache HTTPD, or NGINX).
- [Using Extensions](https://guides.deplo.io/php/extensions.md): Instructions for loading PHP extensions using Composer requirements or custom .ini files with the Paketo buildpack's pre-built extension support.
- [Setting up a Symfony Application](https://guides.deplo.io/php/symfony.md): Guide for deploying Symfony applications on Deploio with configurations for APP_SECRET, web directory, and Composer platform requirements.

### Python

- [Quick Start Guide for Python Applications](https://guides.deplo.io/python/quick-start.md): Quick start guide for deploying Python Django applications on Deploio using the Paketo Python buildpack with WSGI configuration and environment setup.

### Go

- [Quick Start Guide for Go Applications](https://guides.deplo.io/go/quick-start.md): Quick start guide for deploying Go applications on Deploio using the Heroku Go buildpack with Go Modules and version detection from go.mod.

### Docker

- [Quick Start Guide for Docker Apps (Beta)](https://guides.deplo.io/docker/quick-start.md): Quick start guide for deploying applications using custom Dockerfiles on Deploio with build context configuration, build arguments, and best practices for image optimization.

### Node.js

- [Quick Start Guide for Node.js Applications](https://guides.deplo.io/nodejs/quick-start.md): Quick start guide for deploying Node.js applications including Next.js on Deploio using the Paketo Node.js buildpack with npm/yarn build support.

### Static pages

- [Quick Start Guide for Static Sites](https://guides.deplo.io/static-pages/quick-start.md): Quick start guide for deploying static sites with pure HTML or NPM-based frontends on Deploio with automatic web server configuration and build directory setup.
- [Deploying Static Site Generators](https://guides.deplo.io/static-pages/static-site-generators.md): Comprehensive guide for deploying static site generators like VitePress, Docusaurus, Gatsby, and Astro on Deploio with build script configuration and output directory setup.

### Other

- [Markdown Extension Examples](https://guides.deplo.io/markdown-examples.md)
- [Runtime API Examples](https://guides.deplo.io/api-examples.md)
- [Untitled](https://guides.deplo.io/about.md)