isle/README.md

47 lines
1.8 KiB
Markdown
Raw Normal View History

**_This project is currently in early-access deep-alpha testing phase. Do not
rely on it for anything._**
-----
# Isle
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].
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.
2022-10-07 12:38:39 +00:00
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:
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.
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.
2024-10-03 16:59:48 +00:00
* A DNS server which provides automatic host discovery within the network.
2022-10-30 00:22:03 +00:00
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.
2024-10-03 16:59:48 +00:00
[isle]: http://portal.mozz.us/gemini/micropelago.net/isle/
2024-10-03 16:59:48 +00:00
## Getting Started
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.
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)
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).