isle/docs/command-line.md

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
• Using DNS (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 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
• Contributing a Lighthouse
• Managing garage
• Firewalls

Admin Docs

Admins are members who control membership within the network. They are likely operators as well.

Documentation for admins:

• Creating a New Network
• Adding a Host to the Network
• Removing a Host From the Network (TODO)