55 lines
1.9 KiB
Markdown
55 lines
1.9 KiB
Markdown
|
# Command-line Usage
|
||
|
|
|
||
|
|
This documents provides examples of how to accomplish various tasks from Isle's
|
||
|
|
command-line interface.
|
||
|
|
|
||
|
|
Isle network members 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 decide which
|
||
|
|
documents they need to care about.
|
||
|
|
|
||
|
|
### User Docs
|
||
|
|
|
||
|
|
Users are members who use network resources, but do not provide any network
|
||
|
|
resources themselves. Users may be accessing the network from a mobile device,
|
||
|
|
and so are not expected to be online at any particular moment.
|
||
|
|
|
||
|
|
Documentation for users:
|
||
|
|
|
||
|
|
* [Joining a Network](./user/join-a-network.md)
|
||
|
|
* [Using DNS](./user/using-dns.md) (advanced)
|
||
|
|
* Restic example (TODO)
|
||
|
|
|
||
|
|
### Operator Docs
|
||
|
|
|
||
|
|
Operators are members who own a dedicated host which they can expect to be
|
||
|
|
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 1GB 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](./operator/contributing-storage.md)
|
||
|
|
* [Contributing a Lighthouse](./operator/contributing-a-lighthouse.md)
|
||
|
|
* [Managing garage](./operator/managing-garage.md)
|
||
|
|
* [Firewalls](./operator/firewall.md)
|
||
|
|
|
||
|
|
[ddns]: https://www.cloudflare.com/learning/dns/glossary/dynamic-dns/
|
||
|
|
|
||
|
|
### Admin Docs
|
||
|
|
|
||
|
|
Admins are members who control membership within the network. They are likely
|
||
|
|
operators as well.
|
||
|
|
|
||
|
|
Documentation for admins:
|
||
|
|
|
||
|
|
* [Creating a New Network](./admin/creating-a-new-network.md)
|
||
|
|
* [Adding a Host to the Network](./admin/adding-a-host-to-the-network.md)
|
||
|
|
* Removing a Host From the Network (TODO)
|