isle/README.md


**_This project is currently in early-access deep-alpha testing phase. Do not
rely on it for anything._**

-----

# Isle

Welcome to Isle's technical documentation. You can find a less technical
entrypoint to Isle on [the Micropelago website][isle].

Isle runs on a host as a server daemon, and connects to other isle instances to
form a peer-to-peer network. Isle networks are completely self-hosted; no
third-parties are required for a network to function.

Members of a network are able to build upon the capabilities provided by Isle to
host services for themselves and others. These capabilities include:

* A VPN which enables direct peer-to-peer communication between network members.
  Even if most hosts in the network are on a private LAN (e.g. their home WiFi
  network) or have a dynamic IP, they can still communicate directly with each
  other.

* An S3-compatible network filesystem. Each member can provide as much storage
  as they care to, if any. Stored data is sharded and replicated across all
  hosts that choose to provide storage.

* A DNS server which provides automatic host discovery within the network.

Every isle daemon is able to create or join multiple independent networks. In
this case the networks remain siloed from each other, such that members of one
network are unable to access resources or communicate with members of the other.

[isle]: https://micropelago.net/isle/

## Getting Started

The following pages will guide you through setup of Isle, joining an existing
network, and all other functionality available via the command-line.

* [Installation](./docs/install.md)
* [Command-line Usage](./docs/command-line.md)
    * [Join a Network](./docs/user/join-a-network.md)

Those who want to dive in and contribute to the Isle codebase should check out
the [Developer Documentation](./docs/dev/index.md).
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
			`**_This project is currently in early-access deep-alpha testing phase. Do not`
			`rely on it for anything._**`

			`-----`

Perform all in-code renames which don't affect actual functionality 2023-08-05 21:53:17 +00:00			`# Isle`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
Update documentation 2024-10-03 16:59:48 +00:00			`Welcome to Isle's technical documentation. You can find a less technical`
			`entrypoint to Isle on [the Micropelago website][isle].`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
Update documentation 2024-10-03 16:59:48 +00:00			`Isle runs on a host as a server daemon, and connects to other isle instances to`
			`form a peer-to-peer network. Isle networks are completely self-hosted; no`
			`third-parties are required for a network to function.`
Streamline docs a bit 2022-10-07 12:38:39 +00:00
Update documentation 2024-10-03 16:59:48 +00:00			`Members of a network are able to build upon the capabilities provided by Isle to`
			`host services for themselves and others. These capabilities include:`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
Update documentation 2024-10-03 16:59:48 +00:00			`* A VPN which enables direct peer-to-peer communication between network members.`
			`Even if most hosts in the network are on a private LAN (e.g. their home WiFi`
			`network) or have a dynamic IP, they can still communicate directly with each`
			`other.`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
Update documentation 2024-10-03 16:59:48 +00:00			`* An S3-compatible network filesystem. Each member can provide as much storage`
			`as they care to, if any. Stored data is sharded and replicated across all`
			`hosts that choose to provide storage.`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
Update documentation 2024-10-03 16:59:48 +00:00			`* A DNS server which provides automatic host discovery within the network.`
Updates to existing documentation 2022-10-30 00:22:03 +00:00
Update documentation 2024-10-03 16:59:48 +00:00			`Every isle daemon is able to create or join multiple independent networks. In`
			`this case the networks remain siloed from each other, such that members of one`
			`network are unable to access resources or communicate with members of the other.`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
Update isle link in README 2024-11-05 10:23:28 +00:00			`[isle]: https://micropelago.net/isle/`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
Update documentation 2024-10-03 16:59:48 +00:00			`## Getting Started`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
Update documentation 2024-10-03 16:59:48 +00:00			`The following pages will guide you through setup of Isle, joining an existing`
			`network, and all other functionality available via the command-line.`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
Update documentation 2024-10-03 16:59:48 +00:00			`* [Installation](./docs/install.md)`
			`* [Command-line Usage](./docs/command-line.md)`
			`* [Join a Network](./docs/user/join-a-network.md)`
First public commit There has been over 1 year of commit history leading up to this point, but almost all of that has had some kind network configuration or secrets built into the code. As of today all of that has been removed, and the codebase can finally be published! I am keeping a private copy of the previous commit history, though it's unclear if it will ever be able to be published. 2021-04-20 21:31:37 +00:00
Update documentation 2024-10-03 16:59:48 +00:00			`Those who want to dive in and contribute to the Isle codebase should check out`
			`the [Developer Documentation](./docs/dev/index.md).`