Skip to content

fix broken docs link ticket #319

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

Merged
merged 1 commit into from
Apr 12, 2025
Merged

fix broken docs link ticket #319

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
4 changes: 2 additions & 2 deletions src/app/docs/concepts/tickets/page.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Currently, there are three kinds of tickets:
| --- | --- | --- |
| `node` | A token for connecting to an iroh node | `Node Address` |
| `blob` | A token for fetching a [blob](/docs/layers/blobs) or [collection](/docs/layers/blobs#collections) | `Hash`, `HashOrCollection`, `Node Address` |
| `ticket` | A read/write access token to a [document](/docs/layers/document), plus a node address | `DocID`, `Read/Write Capability`, `[Node Address]` |
| `document` | A read/write access token to a [document](/proto/iroh-docs), plus a node address | `DocID`, `Read/Write Capability`, `[Node Address]` |

Tickets always start with an ascii string that describes the type of ticket (eg: `blob`), followed by a base32-lowercase-encoded payload. The payload is [postcard-encoded data](https://postcard.jamesmunns.com/wire-format.html) that contains the information needed to use the ticket. We chose postcard because it's extremely succinct.

Expand All @@ -43,4 +43,4 @@ When you create a document ticket, you're creating a secret that allows someone
## Tickets in Apps
Using tickets in your app comes down to what you're trying to accomplish. For short-lived sessions where both devices are online at the same time, tickets are an incredibly powerful way to bootstrap connections, and require no additinonal servers for coordination.

If you have any means of automating (like, a central database or server to bootstrap from) we recommend you _do not_ use tickets in your app, and instead program around the idea that you can _dial by NodeID_. Tickets can contain information that can go stale quickly. instead focus on caching `nodeIDs`, and letting iroh transparently resolve dialing details at runtime.
If you have any means of automating (like, a central database or server to bootstrap from) we recommend you _do not_ use tickets in your app, and instead program around the idea that you can _dial by NodeID_. Tickets can contain information that can go stale quickly. instead focus on caching `nodeIDs`, and letting iroh transparently resolve dialing details at runtime.
Loading