Skip to content

Commit

Permalink
Merge pull request #3 from Turtlepaw/main
Browse files Browse the repository at this point in the history
README.md fixes
  • Loading branch information
merlinfuchs authored Nov 29, 2022
2 parents e64246a + 97ff7ab commit eebf77b
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ This project was initially inspired by [zer0b.in](https://github.com/zer0bin-dev

## API Routes

| Route | Method | Description | Paramaters
| Route | Method | Description | Parameters
| --- | --- | --- | --- |
| `/pastes/{paste_id}` | `GET` | Get information about a paste | None
| `/api/pastes/{paste_id}/raw` | `GET` | Get the raw paste | None
Expand All @@ -40,13 +40,13 @@ You can find prebuilt binaries for the most common operating systems [here](http

To build this project from source you need [node](https://nodejs.org/en/download/) and [rust](https://www.rust-lang.org/tools/install) installed.

Build the frontend:
#### Build the frontend:
```shell
npm run install
npm run build
```

Build the backend:
#### Build the backend:
```shell
# just build
cargo build --release
Expand Down Expand Up @@ -77,9 +77,9 @@ per_second = 5 # seconds it takes to refill one request
reverse_proxy = false # if the backend is deployed behind a revers proxy -> this changes the way the peers IP is retrieved
```

In addition to creating a `Config.toml` file you can also override these values using environment variables:
For example:
In addition to creating a `Config.toml` file, you can also override these values using environment variables, for example:

```shell
VAULTBIN_HOST=0.0.0.0
VAULTBIN_DATABASE__CACHE_SIZE=9999999
```
```

0 comments on commit eebf77b

Please sign in to comment.