# Shuttle Docs

> The Shuttle platform documentation

## Docs

- [Contributing](https://docs.shuttle.dev/community/contribute.md): Learn about the best way to get started with contributing to Shuttle.
- [Get Involved](https://docs.shuttle.dev/community/get-involved.md): Learn how to get involved with Shuttle.
- [Open Source](https://docs.shuttle.dev/community/open-source.md): Learn about how to get involved with the open source side of Shuttle.
- [Account](https://docs.shuttle.dev/docs/account.md): How Shuttle accounts work
- [Builds](https://docs.shuttle.dev/docs/builds.md): Details about the environment your app is built in
- [Deployment environment](https://docs.shuttle.dev/docs/deployment-environment.md): Details about the environment your app runs in
- [Domain names](https://docs.shuttle.dev/docs/domain-names.md): Add custom domains to your project
- [Deployment files](https://docs.shuttle.dev/docs/files.md): How to add or ignore files in Shuttle deployments
- [Local Run](https://docs.shuttle.dev/docs/local-run.md): Develop your Shuttle app locally
- [Logs](https://docs.shuttle.dev/docs/logs.md): Tracing or logging in Shuttle apps.
- [Project configuration](https://docs.shuttle.dev/docs/project-configuration.md): How to configure your Rust project for running on Shuttle
- [Projects](https://docs.shuttle.dev/docs/projects.md): Everything about Shuttle projects
- [Scaling](https://docs.shuttle.dev/docs/scaling.md): Adjusting the computational resources allocated to your application
- [Shuttle Shutdown](https://docs.shuttle.dev/docs/shuttle-shutdown.md): Shuttle is ceasing operations
- [Teams](https://docs.shuttle.dev/docs/teams.md): How Shuttle Teams work
- [Better Stack Integration](https://docs.shuttle.dev/docs/telemetry/betterstack.md): How to set up Better Stack monitoring with Shuttle
- [Custom Metrics Guide](https://docs.shuttle.dev/docs/telemetry/custom-metrics.md): How to add custom metrics and tracing events to your Shuttle application
- [Getting Started](https://docs.shuttle.dev/docs/telemetry/getting-started.md): Step-by-step guide to setting up telemetry in your Shuttle project
- [Overview](https://docs.shuttle.dev/docs/telemetry/overview.md): How Shuttle Telemetry integrations work
- [Hello World](https://docs.shuttle.dev/examples/actix.md): Actix Web is a powerful, pragmatic, and extremely fast web framework for Rust.
- [Cookie Authentication](https://docs.shuttle.dev/examples/actix-cookie-authentication.md): Explore how you can secure your Actix Web application by using cookies.
- [Postgres Todo App](https://docs.shuttle.dev/examples/actix-postgres.md): This article walks you through how you can easily set up a simple to-do app using Actix Web and SQLx with PostgresQL.
- [Static Files](https://docs.shuttle.dev/examples/actix-static-files.md): This article walks you through setting up static files with Actix Web, a powerful Rust framework for battle-hardened web applications.
- [Actix WebSocket Actorless](https://docs.shuttle.dev/examples/actix-websocket-actorless.md): Learn how websockets can upgrade your web service by providing live update functionality, using Actix Web.
- [Hello World](https://docs.shuttle.dev/examples/axum.md): Axum is a web application framework that focuses on ergonomics and modularity.
- [JWT Authentication](https://docs.shuttle.dev/examples/axum-jwt-authentication.md): Learn how you can secure your Axum web application by using JWT tokens.
- [Postgres Todo App](https://docs.shuttle.dev/examples/axum-postgres.md): This article walks you through how you can easily set up a simple to-do app using Axum and SQLx with PostgresQL.
- [Static Files](https://docs.shuttle.dev/examples/axum-static-files.md): This article walks you through setting up static files with Axum, a powerful Rust framework maintained by the Tokio-rs team.
- [WebSockets](https://docs.shuttle.dev/examples/axum-websockets.md): Learn how websockets can upgrade your web service by providing live update functionality, using Axum.
- [Loco](https://docs.shuttle.dev/examples/loco.md): Loco is Ruby on Rails but for Rust, a web framework with everything included.
- [Other Examples](https://docs.shuttle.dev/examples/other.md): This section contains examples for the following frameworks: Rama, Tower, Warp, Salvo, and Poem.
- [Overview](https://docs.shuttle.dev/examples/overview.md)
- [Poise](https://docs.shuttle.dev/examples/poise.md): Poise is an opinionated Discord bot framework based on Serenity with good support for slash commands.
- [Hello World](https://docs.shuttle.dev/examples/rocket.md): Rocket is an async web framework for Rust with a focus on usability, security, extensibility, and speed.
- [JWT Authentication](https://docs.shuttle.dev/examples/rocket-jwt-authentication.md): Learn how you can secure your Rocket web application by using JWT tokens.
- [Postgres Todo App](https://docs.shuttle.dev/examples/rocket-postgres.md): This article walks you through how you can easily set up a simple to-do app using Rocket and SQLx with PostgresQL.
- [Static Files](https://docs.shuttle.dev/examples/rocket-static-files.md): This article walks you through setting up static files with Rocket, an ergonomic framework for simple web applications.
- [Hello World Bot](https://docs.shuttle.dev/examples/serenity.md): Serenity is a Rust library for the Discord API.
- [Todo List Bot](https://docs.shuttle.dev/examples/serenity-todo.md): Learn how to write a Serenity bot that can manage a to-do list.
- [Installation](https://docs.shuttle.dev/getting-started/installation.md): How to install the Shuttle Command Line Interface (CLI)
- [Quick Start](https://docs.shuttle.dev/getting-started/quick-start.md): Get started with your first Shuttle project and deploy it to the cloud 🚀
- [CLI](https://docs.shuttle.dev/guides/cli.md): Overview of the Shuttle commands
- [Migrate Postgres Data](https://docs.shuttle.dev/guides/migrate-shared-postgres.md): Migrate Postgres data to shuttle.dev
- [Upgrade Shuttle version](https://docs.shuttle.dev/guides/upgrade.md): How to upgrade to newer Shuttle versions
- [GitHub Actions](https://docs.shuttle.dev/integrations/ci-cd.md): Streamline your Rust projects with Shuttle CI/CD
- [Custom Resources](https://docs.shuttle.dev/integrations/custom-resources.md): This example shows how you can make a custom Shuttle resource annotation.
- [GitHub Integration](https://docs.shuttle.dev/integrations/github.md): Connect a GitHub repository for automatic deployments
- [Shuttle MCP](https://docs.shuttle.dev/integrations/mcp-server.md): How to set up the Shuttle MCP server for use in AI coding assistants
- [OpenAI](https://docs.shuttle.dev/integrations/shuttle-openai.md): Learn about Shuttle's OpenAI resource annotation.
- [Apache OpenDAL](https://docs.shuttle.dev/integrations/shuttle-opendal.md): Learn about Shuttle's OpenDAL resource annotation.
- [Qdrant](https://docs.shuttle.dev/integrations/shuttle-qdrant.md): Integrate vector search capabilities into your Rust projects with Shuttle Qdrant. Our documentation outlines the process, simplifying your journey.
- [Turso](https://docs.shuttle.dev/integrations/shuttle-turso.md): Learn about how to use Shuttle with Turso, a distributed SQLite cloud service.
- [Migrate to Shuttle](https://docs.shuttle.dev/migration/guide.md): A comprehensive guide to migrating your existing Rust project to Shuttle
- [Transfer to the new platform](https://docs.shuttle.dev/platform-update/migration.md): How to transfer projects from shuttle.rs to shuttle.dev
- [Overview & Changelog](https://docs.shuttle.dev/platform-update/platform-update.md): In Q4 2024, Shuttle launched a new and improved platform
- [Usage & Billing](https://docs.shuttle.dev/pricing/billing.md)
- [FAQ](https://docs.shuttle.dev/pricing/faq.md): Frequently Asked Pricing Questions
- [Plans overview](https://docs.shuttle.dev/pricing/overview.md)
- [Scaling & Limits](https://docs.shuttle.dev/pricing/scaling.md)
- [Upgrading](https://docs.shuttle.dev/pricing/upgrading.md)
- [Resources](https://docs.shuttle.dev/resources/resources.md): Learn about the resources that are officially supported by Shuttle.
- [AWS RDS](https://docs.shuttle.dev/resources/shuttle-aws-rds.md): Connect AWS RDS dedicated databases with your Rust applications on Shuttle
- [Secrets](https://docs.shuttle.dev/resources/shuttle-secrets.md): Including secrets in your deployment
- [Shuttle Shared Databases](https://docs.shuttle.dev/resources/shuttle-shared-db.md): Learn about the Shuttle Shared Database resource.
- [Frequently Asked Questions](https://docs.shuttle.dev/support/faq.md): Learn about the most frequently asked questions from Shuttle users.
- [Support](https://docs.shuttle.dev/support/support.md): How to reach the Shuttle team for support
- [Troubleshooting](https://docs.shuttle.dev/support/troubleshooting.md): Learn about how to solve common problems you might run into while using Shuttle.
- [SaaS Starter Template](https://docs.shuttle.dev/templates/fullstack/saas-template.md): Learn how you can deploy a fully working SaaS template using Next.js & Rust.
- [Overview](https://docs.shuttle.dev/templates/overview.md): Learn more about the official Shuttle templates.
- [Authentication](https://docs.shuttle.dev/templates/tutorials/authentication.md): Learn how to implement authentication using Rust.
- [Custom Service](https://docs.shuttle.dev/templates/tutorials/custom-service.md): This example will explain how to create a custom Shuttle service using Poise and Axum.
- [Working with Databases in Rust](https://docs.shuttle.dev/templates/tutorials/databases-with-rust.md): Learn how to work with databases using Rust.
- [Discord Weather Forecast Bot](https://docs.shuttle.dev/templates/tutorials/discord-weather-forecast.md): Learn how to write a Discord bot that can get the weather forecast.
- [Writing a Rest HTTP Service with Axum](https://docs.shuttle.dev/templates/tutorials/rest-http-service-with-axum.md): Learn how to write a REST HTTP service with Axum.
- [Using Shuttle with Datadog](https://docs.shuttle.dev/templates/tutorials/send-your-logs-to-datadog.md): Learn how to send your logs to Datadog with Roberto.
- [Serverless Calendar App](https://docs.shuttle.dev/templates/tutorials/serverless-calendar-app.md): Learn how to build a serverless calendar application with Matthias.
- [URL Shortener](https://docs.shuttle.dev/templates/tutorials/url-shortener.md): Learn how to write a URL shortener with Terrence.
- [Chat app with React & Rust](https://docs.shuttle.dev/templates/tutorials/websocket-chat-app-js.md): Learn how to write a Rust chat application with React on the frontend.
- [Introduction to Shuttle](https://docs.shuttle.dev/welcome/introduction.md): Shuttle is a Rust-native cloud development platform that lets you deploy your app while also taking care of all of your infrastructure.

## Optional

- [GitHub](https://github.com/shuttle-hq/shuttle)
- [Community](https://discord.gg/shuttle)
- [Releases and Changelog](https://github.com/shuttle-hq/shuttle/releases)
- [Blog](https://www.shuttle.dev/blog/tags/all)