Get Involved

Shuttle Docs

Begin your Shuttle journey with our comprehensive documentation. Learn how Shuttle simplifies Rust cloud development through easy-to-follow guides.

Start Building Backends Fast

Shuttle is a Rust-native cloud development platform that lets you deploy your app while also taking care of all of your infrastructure.

What is Shuttle?

How Shuttle works

How to install the Shuttle Command Line Interface (CLI)

Installation

Fire upp your first project after installation 🚀

Quick Start

Projects

How to configure your Rust project for running on Shuttle

Project configuration

Local Run

How to add or ignore files in Shuttle deployments

Deployment files

Details about the environment your app is built in

Builds

Details about the environment your app runs in

Deployment environment

Logs

Domain names

Account

Teams

Learn about the resources that are officially supported by Shuttle.

Resources

Secrets

Learn about Shuttle's OpenAI resource annotation.

OpenAI

This example shows how you can make a custom Shuttle resource annotation.

Custom Resources

Streamline your Rust projects with Shuttle CI/CD

GitHub Actions

Upgrade Shuttle version

Migrate Postgres Data

Plans overview

Usage & Billing

Scaling & Limits

Upgrading

How to reach the Shuttle team for support

Support

Learn about the most frequently asked questions from Shuttle users.

Frequently Asked Questions

Learn about how to solve common problems you might run into while using Shuttle.

Troubleshooting

Learn about the best way to get started with contributing to Shuttle.

Contributing

Learn about how to get involved with the open source side of Shuttle.

Open Source

Shuttle Examples - Overview

Overview

This section contains examples for the following frameworks: Tower, Warp, Salvo, Poem, Thruster, and Tide.

Other Examples

All Examples

Learn more about the official Shuttle templates.

Shuttle Templates - Overview

Learn how you can deploy a fully working SaaS template using Next.js & Rust.

SaaS Starter Template

Learn how to write a REST HTTP service with Axum.

Writing a Rest HTTP Service with Axum

Learn how to write a Discord bot that can get the weather forecast.

Discord Weather Forecast Bot

Learn how to work with databases using Rust.

Working with Databases in Rust

Learn how to build a serverless calendar application with Matthias.

Serverless Calendar App

Learn how to write a URL shortener with Terrence.

URL Shortener

Learn how to implement authentication using Rust.

Authentication

Learn how to send your logs to Datadog with Roberto.

Using Shuttle with Datadog

Learn how to write a Rust chat application with React on the frontend.

Chat app with React & Rust

This example will explain how to create a custom Shuttle service using Poise and Axum.

Custom Service

How to migrate to Shuttle

How to know if your project will migrate to Shuttle

Will my project run on Shuttle?

Short guide on how to migrate your existing project over to Shuttle

Migration quickstart example

Telemetry overview

How to set up Better Stack monitoring with Shuttle

Better Stack

Learn about the Shuttle Shared Database resource.

Shuttle Shared Databases

Learn about how to use Shuttle with Turso, a distributed SQLite cloud service.

Turso

Integrate vector search capabilities into your Rust projects with Shuttle Qdrant. Our documentation outlines the process, simplifying your journey.

Qdrant

Learn about Shuttle's OpenDAL resource annotation.

Apache OpenDAL

In Q4 2024, Shuttle launched a new and improved platform

Overview & Changelog

How to transfer projects from shuttle.rs to shuttle.dev

Transfer to the new platform

Axum is a web application framework that focuses on ergonomics and modularity.

Hello World with Axum - Shuttle Docs

Hello World

This article walks you through how you can easily set up a simple to-do app using Axum and SQLx with PostgresQL.

Postgres Todo App with Axum - Shuttle Docs

Postgres Todo App

This article walks you through setting up static files with Axum, a powerful Rust framework maintained by the Tokio-rs team.

Static Files with Axum - Shuttle Docs

Static Files

Learn how websockets can upgrade your web service by providing live update functionality, using Axum.

WebSockets

Learn how you can secure your Axum web application by using JWT tokens.

JWT Authentication with Axum

JWT Authentication

Actix Web is a powerful, pragmatic, and extremely fast web framework for Rust.

Hello World with Actix Web - Shuttle Docs

This article walks you through how you can easily set up a simple to-do app using Actix Web and SQLx with PostgresQL.

Postgres Todo App with Actix Web - Shuttle Docs

This article walks you through setting up static files with Actix Web, a powerful Rust framework for battle-hardened web applications.

Static Files with Actix Web - Shuttle Docs

Learn how websockets can upgrade your web service by providing live update functionality, using Actix Web.

Actix WebSocket Actorless

Explore how you can secure your Actix Web application by using cookies.

Cookie Authentication with Actix Web

Cookie Authentication

Rocket is an async web framework for Rust with a focus on usability, security, extensibility, and speed.

Hello World with Rocket - Shuttle Docs

This article walks you through how you can easily set up a simple to-do app using Rocket and SQLx with PostgresQL.

Postgres Todo App with Rocket - Shuttle Docs

This article walks you through setting up static files with Rocket, an ergonomic framework for simple web applications.

Static Files with Rocket - Shuttle Docs

Learn how you can secure your Rocket web application by using JWT tokens.

JWT Authentication with Rocket - Shuttle Docs

Serenity is a Rust library for the Discord API.

Hello World Bot

Learn how to write a Serenity bot that can manage a to-do list.

Todo List Bot

Poise is an opinionated Discord bot framework based on Serenity with good support for slash commands.

Introduction

Getting Started

Shuttle

Resources

Integrations

Guides

Pricing

Support

Community

Get Involved

Give us a star on GitHub

Join our Discord server

Follow us on Twitter

Contribute to the project