micropelago/isle
4
1
Fork 0
Code Issues 1 Pull Requests Projects Releases 5 Activity
b7fb1d9c0a
isle/README.md

115 lines
4.0 KiB
Markdown
Raw Normal View History

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
Perform all in-code renames which don't affect actual functionality
2023-08-05 21:53:17 +00:00
The Isle project provides the foundation for an **autonomous community
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
cloud infrastructure**.
Streamline docs a bit
2022-10-07 12:38:39 +00:00
This project targets communities of individuals, where certain members of the
community would like to host services and applications from servers running in
their homes or offices. These servers can range from simple Raspberry Pis to
full-sized home PCs.
Perform all in-code renames which don't affect actual functionality
2023-08-05 21:53:17 +00:00
The core components of Isle, currently, are:
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
Streamline docs a bit
2022-10-07 12:38:39 +00:00
* A VPN which enables direct peer-to-peer communication. 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
Add Glossary, remove "participant" as a term
2022-11-05 11:03:51 +00:00
* An S3-compatible network filesystem. Each users 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
Updates to existing documentation
2022-10-30 00:22:03 +00:00
* A DNS server which provides automatic host and service (coming soon) discovery
within the network.
Streamline docs a bit
2022-10-07 12:38:39 +00:00
These components are wrapped into a single binary, with all setup being
Perform all in-code renames which don't affect actual functionality
2023-08-05 21:53:17 +00:00
automated. Isle takes "just works" very seriously.
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
Participants are able to build upon these foundations to host services for
themselves and others. They can be assured that their communications are private
and their storage is reliable, all with zero administrative overhead and zero
third parties involved.
## Documentation
Perform all in-code renames which don't affect actual functionality
2023-08-05 21:53:17 +00:00
Isle users fall into different roles, depending on their level of
involvement and expertise within their particular network. The documentation
is broken down by these categories, so that the reader can easily
Updates to existing documentation
2022-10-30 00:22:03 +00:00
decide which documents they need to care about.
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
### User Docs
Add Glossary, remove "participant" as a term
2022-11-05 11:03:51 +00:00
Users are participants who use network resources, but do not provide any network
or storage resources themselves. Users may be accessing the network from a
laptop, and so are not expected to be online at any particular moment.
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
Documentation for users:
* [Getting Started](docs/user/getting-started.md)
* [Creating a daemon.yml File](docs/user/creating-a-daemonyml-file.md)
* [Using DNS](docs/user/using-dns.md) (advanced)
* Restic example (TODO)
### Operator Docs
Add Glossary, remove "participant" as a term
2022-11-05 11:03:51 +00:00
Operators are users who own a dedicated host which they can expect to be
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
always-online (to the extent that's possible in a residential environment).
Operator hosts will need at least one of the following to be useful:
* A static public IP, or a dynamic public IP with [dDNS][ddns] set up.
* At least 100GB of unused storage which can be reserved for the network.
Operators are expected to be familiar with server administration, and to not be
afraid of a terminal.
Documentation for operators:
* [Contributing Storage](docs/operator/contributing-storage.md)
* [Contributing a Lighthouse](docs/operator/contributing-a-lighthouse.md)
* [Managing garage](docs/operator/managing-garage.md)
Add documentation related to firewalls
2022-11-05 16:16:25 +00:00
* [Firewalls](doc/operator/firewall.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
[ddns]: https://www.cloudflare.com/learning/dns/glossary/dynamic-dns/
### Admin Docs
Add Glossary, remove "participant" as a term
2022-11-05 11:03:51 +00:00
Admins are users who control membership within the network. They are likely
operators as well.
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
Documentation for admins:
Add documentation for admin create-network
2022-11-03 14:38:31 +00:00
* [Creating a New Network](docs/admin/creating-a-new-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
* [Adding a Host to the Network](docs/admin/adding-a-host-to-the-network.md)
* Removing a Host From the Network (TODO)
### Dev Docs
Perform all in-code renames which don't affect actual functionality
2023-08-05 21:53:17 +00:00
Devs may or may not be users in any particular isle network. They instead are
those who work on the actual code for 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
Documentation for devs:
* [Design Principles](docs/dev/design-principles.md)
Perform all in-code renames which don't affect actual functionality
2023-08-05 21:53:17 +00:00
* [`isle daemon` process tree](docs/dev/daemon-process-tree.svg): Diagram
cryptic-io org has been renamed to micropelago
2023-07-06 15:51:38 +00:00
describing the [pmux](https://code.betamike.com/micropelago/pmux) process tree
Perform all in-code renames which don't affect actual functionality
2023-08-05 21:53:17 +00:00
created by `isle daemon` at runtime.
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
* [Rebuilding Documentation](docs/dev/rebuilding-documentation.md)
Implement release script
2023-03-25 14:58:20 +00:00
* [Releases](docs/dev/releases.md)
Gateway doc
2023-04-24 19:31:59 +00:00
* [Gateway](docs/dev/gateway.md): Tentative spec for gateway functionality in
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
## Misc
Besides documentation, there are a few other pages which might be useful:
* [Roadmap][roadmap]
Add Glossary, remove "participant" as a term
2022-11-05 11:03:51 +00:00
* [Glossary](docs/glossary.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
[roadmap]: docs/roadmap.md
Reference in New Issue Copy Permalink