generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 5
add compatibility information #39
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.
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
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
2ca5079
add compatibility information
okdistribute 9616e0c
add page
okdistribute 7b29624
Revise compatibility page introduction
okdistribute 9b71e31
Update compatibility.mdx
okdistribute 6213d8a
Update WebAssembly compatibility link format
okdistribute File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| --- | ||
| title: "Compatibility" | ||
| --- | ||
|
|
||
| Send data to and from any device running anywhere, big or small — cloud servers, tablets, or embedded systems. The core peer-to-peer technology is open source and built on open standards, so you're never locked in. | ||
|
|
||
| ## Operating Systems | ||
|
|
||
| iroh supports all major operating systems: | ||
|
|
||
| | OS | Supported | | ||
| |----|-----------| | ||
| | Linux | Yes | | ||
| | macOS | Yes | | ||
| | Windows | Yes | | ||
| | Android | Yes | | ||
| | iOS | Yes | | ||
| | WebAssembly (browser) | [Yes](/deployment/other-languages#webassembly-and-browsers) | | ||
| | FreeRTOS | Yes | | ||
|
|
||
| ## Hardware | ||
|
|
||
| iroh runs on a wide range of hardware, from servers to microcontrollers. | ||
|
|
||
| ### Tested Platforms | ||
|
|
||
| | Hardware | Notes | | ||
| |----------|-------| | ||
| | x86\_64 servers & desktops | Fully supported | | ||
| | Apple Silicon (M-series) | Fully supported | | ||
| | Raspberry Pi | Fully supported | | ||
| | ESP32 | Supported with caveats | | ||
|
|
||
| ### ESP32 Resource Requirements | ||
|
|
||
| We have built a version of iroh which has been tested on ESP32 with very constrained resources: | ||
|
|
||
| - **4 MiB Flash / 4 MiB RAM** — working, though 4 MiB flash is right at the limit | ||
| - **4 MiB Flash / 2 MiB RAM** — also works in testing | ||
|
|
||
| To use iroh on ESP32 in production, [contact us for support & licensing options](https://cal.com/team/number-0/n0-protocol-services?overlayCalendar=true). | ||
|
|
||
| ## Network Transports | ||
|
|
||
| | Transport | Status | | ||
| |-----------|--------| | ||
| | UDP / IP (internet) | Yes | | ||
| | WiFi / LAN | Yes | | ||
| | Ethernet | Yes | | ||
| | Bluetooth (BLE) | [In progress](/transports/bluetooth) | | ||
| | Tor | [Yes](/transports/tor) | | ||
| | Nym | [Yes](/transports/nym) | | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.