- Resources
- Shuttle Static Folder
Resources
Shuttle Static Folder
This plugin allows services to get the path to a static folder at runtime
Usage
Add shuttle-static-folder
to the dependencies for your service. This resource can be using by the shuttle_static_folder::StaticFolder
attribute to get a PathBuf
with the location of the static folder.
An example using the Axum framework can be found on GitHub
#[shuttle_service::main]
async fn main(
#[shuttle_static_folder::StaticFolder] static_folder: PathBuf,
) -> __ { ... }
Parameters
Parameter | Type | Default | Description |
---|---|---|---|
folder | str | static | The relative path, from the crate root, to the directory containing static files to deploy |
Example: Using the public folder instead
Since this plugin defaults to the static
folder, the arguments can be used to use the public
folder instead.
#[shuttle_service::main]
async fn main(
#[shuttle_static_folder::StaticFolder(folder = "public")] public_folder: PathBuf,
) -> __ { ... }