Skip to content

QSTH-916: Expose configuration option for Events Server port #673

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.

Sign up for GitHub

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

Open
mehmettokgoz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

QSTH-916: Expose configuration option for Events Server port #673

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
18 changes: 17 additions & 1 deletion qstash/howto/local-development.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ npx @upstash/qstash-cli dev

// Start on a different port
npx @upstash/qstash-cli dev -port=8081

// Start with a custom log server port
npx @upstash/qstash-cli dev -port=8081 -log-port=9000
```

Once you start the local server, you can go to the QStash tab on Upstash Console and enable local mode, which will allow you to publish requests and monitor messages with the local server.
Expand Down Expand Up @@ -60,12 +63,25 @@ Currently, the only available command for QStash CLI is `dev`, which starts a de
```
$ ./qstash dev --help
Usage of dev:
-log-port int
Port to run the QStash log server on [env QSTASH_DEV_LOG_PORT]
-port int
The port to start HTTP server at [env QSTASH_DEV_PORT] (default 8080)
Port to run the QStash server on [env QSTASH_DEV_PORT] (default 8080)
-quota string
The quota of users [env QSTASH_DEV_QUOTA] (default "payg")
```

### Server Components

Running `qstash dev` starts two components:

- **QStash server** — the main API server, defaults to port `8080`. Use `-port` or `QSTASH_DEV_PORT` to change it.
- **Log server** — serves logs and is used by the Upstash Console and Logs API. Defaults to `port + 1` (i.e., `8081` when using the default port). Use `-log-port` or `QSTASH_DEV_LOG_PORT` to change it.

```
# Start with custom ports for both components
$ ./qstash dev -port=8080 -log-port=9000
```

There are predefined test users available. You can configure the quota type of users using the `-quota` option, with available options being `payg` and `pro`.
These quotas don't affect performance but allow you to simulate different server limits based on the subscription tier.
Expand Down