Troubleshooting

Since shuttle v0.12.0, protoc is a requirement to install cargo-shuttle and to use cargo-runtime. To install protoc, check out our installation guide.

If you’ve recently updated shuttle, in order to get your project back up, you need to run: cargo shuttle project rm followed by cargo shuttle project new and everything should be back in working order.

There’s a known bug with arm64 because of the openssl crates being built for x86, rather than arm64. In order to get around that issue, you can either run:

cargo install --features vendored-openssl cargo-shuttle

or install it via binary:

cargo binstall cargo-shuttle

CustomError is an alias for anyhow::Error, the simplest way to output a relevant message here is by using anyhow::Context like this:

pool.execute(include_str!("../schema.sql"))
    .await
    .context("failed to run migrations")?;

Add shuttle-secrets to the dependencies for your service, and add a Secrets.toml to the root of your project with the secrets you’d like to store. Make sure to add Secrets*.toml to your .gitignore to omit your secrets from version control.

Next, pass #[shuttle_secrets::Secrets] secret_store: SecretStore as an argument to your shuttle_runtime::main function. SecretStore::get can now be called to retrieve your API keys and other secrets at runtime.

For more details, and an explanation on how to use local secrets, head on over here: shuttle secrets.