Shuttle - Deploy Rust apps with a single Cargo subcommand

Hello, and welcome to the shuttle API documentation!

Shuttle is an open-source app platform that uses traits and annotations to configure your backend deployments.

Usage

Start by installing the cargo shuttle subcommand by runnning the following in a terminal:

$ cargo install cargo-shuttle

Now that shuttle is installed, you can create your first project using:

$ cargo shuttle init --rocket my-rocket-app

By looking at the Cargo.toml file of the generated my-rocket-app project you will see it has been made to be a library crate with a shuttle-service dependency with the web-rocket feature on the shuttle-service dependency.

shuttle-service = { version = "0.5.0", features = ["web-rocket"] }

A boilerplate code for your rocket project can also be found in src/lib.rs:

#[macro_use]
extern crate rocket;

use shuttle_service::ShuttleRocket;

#[get("/hello")]
fn hello() -> &'static str {
"Hello, world!"
}

#[shuttle_service::main]
async fn init() -> ShuttleRocket {
let rocket = rocket::build().mount("/", routes![hello]);

Ok(rocket)
}

See the [shuttle_service::main][main] macro for more information on supported services - such as axum. Or look at more complete examples in the repository, but take note that the examples may update before official releases.

Running locally

To test your app locally before deploying, use:

$ cargo shuttle run

You should see your app build and start on the default port 8000. You can test this using;

$ curl http://localhost:8000/hello
Hello, world!

Deploying

You can deploy your service with the cargo shuttle subcommand too. But, you will need to authenticate with the shuttle service first using:

$ cargo shuttle login

this will open a browser window and prompt you to connect using your GitHub account.

Then, deploy the service with:

$ cargo shuttle deploy

Your service will immediately be available at {crate_name}.shuttleapp.rs. For example:

$ curl https://my-rocket-app.shuttleapp.rs/hello
Hello, world!

Using `sqlx`

Here is a quick example to deploy a service that uses a postgres database and sqlx:

Add the sqlx-postgres feature to the shuttle-service dependency, and add sqlx as a dependency with the runtime-tokio-native-tls and postgres features inside Cargo.toml:

shuttle-service = { version = "0.5.0", features = ["web-rocket", "sqlx-postgres"] }
sqlx = { version = "0.5", features = ["runtime-tokio-native-tls", "postgres"] }

Now update the #[shuttle_service::main] function to take in a PgPool:

#[macro_use]
extern crate rocket;

use rocket::State;
use sqlx::PgPool;
use shuttle_service::ShuttleRocket;

struct MyState(PgPool);

#[get("/hello")]
fn hello(state: &State<MyState>) -> &'static str {
// Do things with `state.0`...
"Hello, Postgres!"
}

#[shuttle_service::main]
async fn rocket(#[shared::Postgres] pool: PgPool) -> ShuttleRocket {
let state = MyState(pool);
let rocket = rocket::build().manage(state).mount("/", routes![hello]);

Ok(rocket)
}

For a local run, shuttle will automatically provision a Postgres instance inside a Docker container on your machine and connect it to the PgPool.

For deploys, shuttle will provision a database for your application and connect it to the PgPool on your behalf.

To learn more about shuttle managed services, see [shuttle_service::main][main#getting-shuttle-managed-services].

Configuration

The cargo shuttle command can be customised by creating a Shuttle.toml in the same location as your Cargo.toml.

Change the name of your service

To have your service deployed with a different name, add a name entry in the Shuttle.toml:

name = "hello-world"

If the name key is not specified, the service's name will be the same as the crate's name.

Alternatively, you can override the project name on the command-line, by passing the --name argument:

cargo shuttle deploy --name=$PROJECT_NAME

Using Podman instead of Docker

If you are using Podman instead of Docker, then cargo shuttle run will give got unexpected error while inspecting docker container: error trying to connect: No such file or directory error.

To fix this error you will need to expose a rootless socket for Podman first. This can be done using:

podman system service --time=0 unix:///tmp/podman.sock

Now set the DOCKER_HOST environment variable to point to this socket using:

export DOCKER_HOST=unix:///tmp/podman.sock

Now all cargo shuttle run commands will work against Podman.

Getting API keys

After you've installed the cargo-shuttle command, run:

$ cargo shuttle login

this will open a browser window and prompt you to connect using your GitHub account.

We're in alpha 🤗

Thanks for using shuttle! We're very happy to have you with us!

During our alpha period, API keys are completely free and you can deploy as many services as you want.

Just keep in mind that there may be some kinks that require us to take all deployments down once in a while. In certain circumstances we may also have to delete all the data associated with those deployments.

To stay updated with the release status of shuttle, join our Discord!

Join Discord

If you have any questions, join our Discord server. There's always someone on there that can help!

You can also open an issue or a discussion on GitHub.

shuttle-service 0.5.0