Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
djfarrelly committed Jan 20, 2025
1 parent 4f61f08 commit fcf83ce
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions pages/docs/dev-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,11 @@ You can now open the dev server's browser interface on [`http://localhost:8288`]

There are two ways to connect apps to the Dev Server:

1. Automatically. The Dev Server will keep detecting and attempting to connect to apps running in [common ports](https://github.com/inngest/inngest/blob/ea67219e7e7c33451416249f98fd5ca48e99ba28/pkg/devserver/discovery.go#L15-L30).
2. Manually. For apps running in other ports, you’ll need to paste the local URL to connect the app selecting one of two options:
- Using the CLI -u param
1. **Automatically**: The Dev Server will attempt to "auto-discover" apps running on common ports and endpoints (See "[Auto-discovery](#auto-discovery)").
2. **Manually**: You scan explicitly add the URL of the app to the Dev Server using one of the following options:
- Using the CLI `-u` param (ex. `npx inngest-cli@latest dev -u http://localhost:3000/api/inngest`)
- Adding the URL in the Dev Server Apps page. You can edit the URL or delete a manually added app at any point in time
- Using the `inngest.json` (or similar) configuration file (See "[Configuration file](#configuration-file)")

![Dev Server demo manually syncing an app](/assets/docs/local-development/dev-server-apps-demo-2025-01-15.gif)

Expand Down

0 comments on commit fcf83ce

Please sign in to comment.