47 lines
1.8 KiB
Markdown
47 lines
1.8 KiB
Markdown
|
|
**_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]: http://portal.mozz.us/gemini/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).
|