|
|
|
@ -8,7 +8,6 @@ supported: |
|
|
|
|
|
|
|
|
|
- `x86_64` / `amd64` |
|
|
|
|
- `aarch64` / `arm64` |
|
|
|
|
- `armv7l` (Raspberry Pi) |
|
|
|
|
- `i686` |
|
|
|
|
|
|
|
|
|
(Only `x86_64` has been tested.) |
|
|
|
@ -17,18 +16,12 @@ More OSs and architectures coming soon! |
|
|
|
|
|
|
|
|
|
## Obtaining an isle Binary |
|
|
|
|
|
|
|
|
|
Every host can have a binary built for it which has all configuration for that |
|
|
|
|
host embedded directly into it. Such binaries require no extra configuration by |
|
|
|
|
the user to use, and have no dependencies on anything else in the user's system. |
|
|
|
|
### The Easy Way |
|
|
|
|
|
|
|
|
|
The process of obtaining a custom binary for your host is quite simple: ask an |
|
|
|
|
admin of your network to give you one! |
|
|
|
|
Download the latest binary for your platform from |
|
|
|
|
[this link](https://code.betamike.com/micropelago/isle/releases/latest). |
|
|
|
|
|
|
|
|
|
Note that if you'd like to join the network on multiple devices, each device |
|
|
|
|
will needs its own binary, so be sure to tell your admin how many you want to |
|
|
|
|
add and their names. |
|
|
|
|
|
|
|
|
|
### Obtaining an isle Binary, the Hard Way |
|
|
|
|
### The Hard Way |
|
|
|
|
|
|
|
|
|
Alternatively, you can build your own binary by running the following from the |
|
|
|
|
project's root: |
|
|
|
@ -46,24 +39,28 @@ variable for `nix-daemon` (see [this github issue][tmpdir-gh].)) |
|
|
|
|
|
|
|
|
|
The resulting binary can be found in the `result` directory which is created. |
|
|
|
|
|
|
|
|
|
In this case you will need an admin to provide you with a `bootstrap.yml` for |
|
|
|
|
your host, rather than a custom binary. When running the daemon in the following |
|
|
|
|
steps you will need to provide the `--bootstrap-path` CLI argument to the daemon |
|
|
|
|
process. |
|
|
|
|
|
|
|
|
|
[tmpdir-gh]: https://github.com/NixOS/nix/issues/2098#issuecomment-383243838 |
|
|
|
|
|
|
|
|
|
## Obtaining Your Bootstrap File |
|
|
|
|
|
|
|
|
|
The `bootstrap.yml` file contains all information required for your particular |
|
|
|
|
host to join the network, and must be generated and provided to you by an admin |
|
|
|
|
for the network. |
|
|
|
|
|
|
|
|
|
## Running the Daemon |
|
|
|
|
|
|
|
|
|
Once you have a binary, you will need to run the `daemon` sub-command as the |
|
|
|
|
root user. This can most easily be done using the `sudo` command, in a terminal: |
|
|
|
|
Once you have a binary and bootstrap file, you will need to run the `daemon` |
|
|
|
|
sub-command as the root user. This can most easily be done using the `sudo` |
|
|
|
|
command, in a terminal: |
|
|
|
|
|
|
|
|
|
``` |
|
|
|
|
sudo /path/to/isle daemon |
|
|
|
|
sudo /path/to/isle daemon --bootstrap-path /path/to/bootstrap.yml |
|
|
|
|
``` |
|
|
|
|
|
|
|
|
|
This will start the daemon process, which will keep running until you kill it |
|
|
|
|
with `ctrl-c`. |
|
|
|
|
with `ctrl-c`. The `--bootstrap-path /path/to/bootstrap.yml` argument is only |
|
|
|
|
required the first time the daemon is run, it will be ignored on subsequent |
|
|
|
|
runs. |
|
|
|
|
|
|
|
|
|
You can double check that the daemon is running properly by pinging a private IP |
|
|
|
|
from the network in a separate terminal: |
|
|
|
|