Skip to content

Commit

Permalink
Update shuttle-shared-db.mdx
Browse files Browse the repository at this point in the history
Update docs, reflect the `rustls` implementation option in  `shuttle-shared-db`.

Re: shuttle-hq/shuttle-examples#43
Re: shuttle-hq/shuttle#870

cc @oddgrd
  • Loading branch information
utterstep authored May 8, 2023
1 parent a28b2ef commit a157322
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions resources/shuttle-shared-db.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,14 @@ This plugin manages databases that are shared with other services on [shuttle](h
will share a postgres server with other users, but it will not be accessible by other users.

## Usage
Add `shuttle-shared-db` to the dependencies for your service. Every type of shareable database is behind the following feature flag and attribute path

| Engine | Feature flag | Attribute path |
|----------|--------------|-----------------------------|
| Postgres | postgres | shuttle_shared_db::Postgres |
| MongoDB | mongodb | shuttle_shared_db::MongoDb |
Add `shuttle-shared-db` to the dependencies for your service. Every type of shareable database
is behind the following feature flag and attribute path. `*-rustls` feature enables `rustls`-based implementation,
otherwise some flavour of `native-tls` is used.

| Engine | Feature flags | Attribute path |
|----------|-------------------------------|-------------------------------|
| Postgres | `postgres`, `postgres-rustls` | `shuttle_shared_db::Postgres` |
| MongoDB | `mongodb` | `shuttle_shared_db::MongoDb` |

### Parameters
| Parameter | Type | Default | Description |
Expand Down

0 comments on commit a157322

Please sign in to comment.