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

Improve server onboarding #1095

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
Prev Previous commit
Next Next commit
wrap up readme changes
abooij committed Oct 9, 2023
commit 0cbb6400e905fe639771c0b6374c241ea7413a64
10 changes: 3 additions & 7 deletions server/README.md
Original file line number Diff line number Diff line change
@@ -25,13 +25,9 @@ You would need a working Rust complier in order to build Svix server.
The easiest way is to use [rustup](https://rustup.rs/).
Make sure you have a working Rust compiled (e.g. by using [rustup](https://rustup.rs/)).

Once rustup is installed make sure to set up the `stable` toolchain by running:
Once rustup is installed, switch to the `stable` toolchain and install required components:
```sh
rustup default stable
```

Afterwards please install the following components:
```sh
rustup component add clippy rust-src cargo rustfmt
```

@@ -71,9 +67,9 @@ Now generate an auth token, you can do it by running:
```sh
cargo run jwt generate
```
TODO: add instruction for adding auth token to configuration
Copy-paste this value into the value of `SVIX_JWT_SECRET` in `.env`.

See [the main README](../README.md) for instructions on how to generate it in production.
See [the main README](../README.md) for instructions on how to generate the auth token in production.

### Run the SQL migrations