Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
6 changes: 3 additions & 3 deletions src/content/docs/quickstart.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ Every Sprite has a unique HTTP URL and can serve traffic. This makes it perfect
First, get your Sprite's public URL:

```bash
sprite url
sprite info
```

Then start a simple Python server:
Expand All @@ -141,10 +141,10 @@ Visit the URL in your browser—you'll see Python's directory listing page. Pres
By default, your Sprite's URL requires authentication. To make it publicly accessible, run:

```bash
sprite url update --auth public
sprite config update --url-auth public
```

The `default` auth mode requires a Sprite token with Bearer authentication.
The `sprite` auth mode (the default) requires a Sprite token with Bearer authentication.
</Callout>

### Test on-demand wake-up
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/reference/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,10 @@ Configure HTTP access to your Sprite:

```bash
# Make URL public
sprite url update --auth public
sprite config update --url-auth public

# Require authentication
sprite url update --auth default
# Require authentication (the default)
sprite config update --url-auth sprite
```

For the REST API and Go SDK, use `sprite` or `public` for `url_settings.auth`.
Expand Down
6 changes: 3 additions & 3 deletions src/content/docs/sprites.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -571,13 +571,13 @@ Every Sprite has a unique URL for HTTP access:
<TabItem label="CLI">
```bash
# Get sprite URL
sprite url
sprite info

# Make URL public (no auth required)
sprite url update --auth public
sprite config update --url-auth public

# Make URL require sprite auth (default)
sprite url update --auth default
sprite config update --url-auth sprite
```
</TabItem>

Expand Down
8 changes: 4 additions & 4 deletions src/content/docs/working-with-sprites.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -101,14 +101,14 @@ Your Sprite stays awake while there's activity, and sleeps when there isn't. Act

## Networking: URLs and Port Forwarding

Every Sprite gets a URL: `https://<name>.sprites.app`
Every Sprite gets a URL: `https://<name>-<org-id>.sprites.app`, where the org ID is a short generated identifier, not your org's name. Run `sprite info` to get the exact URL.

### HTTP Access

```bash
sprite url # see URL
sprite url update --auth public # make public
sprite url update --auth default # make private again
sprite info # see URL and auth setting
sprite config update --url-auth public # make public
sprite config update --url-auth sprite # back to org-only (the default)
```

- Routes to port 8080 by default (or first HTTP port opened)
Expand Down
Loading