Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

various fixes & updates for 0.40.0 #265

Merged
merged 4 commits into from
Mar 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions _snippets/sqlx-macros.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
<Warning>Shuttle deployments do not currently support `sqlx` compile-time checked macros.</Warning>
2 changes: 1 addition & 1 deletion configuration/environment.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ Apart from what is already found in the Debian image [[1]](https://github.com/de
Additionally, these tools are installed:

- `cargo-binstall` (latest)
- `trunk 0.17.2`
- `trunk 0.18.8`
- `protoc 22.2`

*Installing more dependencies is not officially supported, but can be done with [a bit of tinkering](https://github.com/shuttle-hq/shuttle/issues/703#issuecomment-1515606621).*
Expand Down
6 changes: 3 additions & 3 deletions configuration/logs.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -40,10 +40,10 @@ in your project is add it to your `Cargo.toml`.

### Configuring the default subscriber

The global subscriber has an `env_filter` which defaults to the `INFO` log level if no `RUST_LOG` variable is set. You can change the
log level for local runs with `RUST_LOG="<crate-name>=trace" cargo shuttle run`.
The global subscriber has an `env_filter` which defaults to the `INFO` log level if no `RUST_LOG` variable is set.
You can change the log level for local runs with `RUST_LOG="..." cargo shuttle run`.

We do not currently allow changing the log level for deployments. Deployments use `RUST_LOG=debug,shuttle=trace,h2=warn` at the moment.
Deployments use `RUST_LOG="shuttle=debug,info"`, and this is not configurable at the moment. A custom subscriber can be set up instead.

## Custom logging setup

Expand Down
17 changes: 12 additions & 5 deletions getting-started/installation.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ curl -sSfL https://www.shuttle.rs/install | bash
Or on Windows with:

```powershell
iwr "https://www.shuttle.rs/install-win" | iex
iwr https://www.shuttle.rs/install-win | iex
```

### Pre-built binary
Expand All @@ -45,15 +45,23 @@ cargo install cargo-shuttle

<Note>Installing cargo-shuttle from source requires Rust 1.75+. You can verify by running `cargo --version`.</Note>

### Arch Linux
### Distro packages (unofficial)

`cargo-shuttle` can be installed from the [community repository](https://archlinux.org/packages/extra/x86_64/cargo-shuttle/) using [pacman](https://wiki.archlinux.org/title/Pacman):
`cargo-shuttle` is also packaged by community members for some distros:

[![Packaging status](https://repology.org/badge/vertical-allrepos/cargo-shuttle.svg)](https://repology.org/project/cargo-shuttle/versions)

Arch Linux: available on the [community repository](https://archlinux.org/packages/extra/x86_64/cargo-shuttle/).

```sh
pacman -S cargo-shuttle
```

> This is a community package maintained by [orhun](https://github.com/orhun).
Alpine Linux: available on [Alpine Edge](https://pkgs.alpinelinux.org/packages?name=cargo-shuttle&branch=edge) after enabling the [testing repository](https://wiki.alpinelinux.org/wiki/Repositories).

```sh
apk add cargo-shuttle
```

## Login

Expand All @@ -63,5 +71,4 @@ After installing, log in with:
cargo shuttle login
```

Once you've done this, you are good to go!
To get up and running, proceed to our [Quick Start](./quick-start) page!
2 changes: 2 additions & 0 deletions resources/shuttle-aws-rds.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,8 @@ async fn main(#[shuttle_aws_rds::Postgres] conn_str: String) -> ... { ... }
async fn main(#[shuttle_aws_rds::Postgres] pool: sqlx::PgPool) -> ... { ... }
```

<Snippet file="sqlx-macros.mdx" />

### Parameters

All of the AWS RDS macros take the same optional parameter:
Expand Down
2 changes: 2 additions & 0 deletions resources/shuttle-shared-db.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,8 @@ async fn main(#[shuttle_shared_db::Postgres] conn_str: String) -> ... { ... }
async fn main(#[shuttle_shared_db::Postgres] pool: sqlx::PgPool) -> ... { ... }
```

<Snippet file="sqlx-macros.mdx" />

### Parameters

Both the Postgres and MongoDB macros take the same optional parameter:
Expand Down
Loading