micropelago/isle
4
1
Fork 0
Code Issues 1 Pull Requests Projects Releases 6 Activity
0a2bad11f6
isle/docs/install.md

90 lines
2.3 KiB
Markdown
Raw Normal View History

Update documentation
2024-10-03 16:59:48 +00:00
# Installation
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
Update documentation
2024-10-03 16:59:48 +00:00
This document will guide you through the process of obtaining and installing
Isle on your machine.
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
Update docs a bit in light of the new architectures
2023-01-29 18:01:58 +00:00
NOTE currently only linux machines with the following architectures are
supported:
Update documentation
2024-07-07 11:37:26 +00:00
- `x86_64` (aka `amd64`)
- `aarch64` (aka `arm64`)
Update docs a bit in light of the new architectures
2023-01-29 18:01:58 +00:00
- `i686`
Got armv6l compiling, but it's not yet tested
2024-12-19 16:49:10 +00:00
- `armv6l` (For older Raspberry Pis)
Update docs a bit in light of the new architectures
2023-01-29 18:01:58 +00:00
Update documentation
2024-07-07 11:37:26 +00:00
(`i686` has not been tested.)
Update docs a bit in light of the new architectures
2023-01-29 18:01:58 +00:00
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
More OSs and architectures coming soon!
Update documentation
2024-07-07 11:37:26 +00:00
## Install 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
Update documentation
2024-07-07 11:37:26 +00:00
How isle gets installed depends on which Linux distribution you are using.
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
Update documentation
2024-07-07 11:37:26 +00:00
### Archlinux (also Manjaro)
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
Update documentation
2024-07-07 11:37:26 +00:00
Download the latest `.pkg.tar.zst` package file for your platform from
[this link][latest].
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
Update documentation
2024-07-07 11:37:26 +00:00
Install the package using pacman:
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
More documentation updates, notably filling out firewall configuration
2024-12-18 20:54:15 +00:00
```bash
Update documentation
2024-07-07 11:37:26 +00:00
sudo pacman -U /path/to/isle-*.pkg.tar.zst
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
```
Update documentation
2024-07-07 11:37:26 +00:00
### Other Distributions
Upgrade garage to 0.8.0-rc1 (untested still)
2022-10-07 19:05:51 +00:00
Update documentation
2024-07-07 11:37:26 +00:00
If a package file is not available for your distribution you can still install
an AppImage directly. It is assumed that all commands below are run as root.
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
Update documentation
2024-07-07 11:37:26 +00:00
Download the latest `.AppImage` binary for your platform from
[this link][latest], and place it in your `/usr/bin` directory.
Upgrade garage to 0.8.0-rc1 (untested still)
2022-10-07 19:05:51 +00:00
Update documentation
2024-07-07 11:37:26 +00:00
Create a `daemon.yml` file using default values by doing:
More documentation updates, notably filling out firewall configuration
2024-12-18 20:54:15 +00:00
```bash
Update documentation
2024-07-07 11:37:26 +00:00
mkdir -p /etc/isle/
isle daemon --dump-config > /etc/isle/daemon.yml
```
Update docs for obtaining a binary
2023-12-23 16:06:16 +00:00
Update documentation
2024-07-07 11:37:26 +00:00
Create a system user for the isle daemon to run as:
More documentation updates, notably filling out firewall configuration
2024-12-18 20:54:15 +00:00
```bash
Update documentation
2024-07-07 11:37:26 +00:00
useradd -r -s /bin/false -C "isle Daemon" isle
```
Update docs for obtaining a binary
2023-12-23 16:06:16 +00:00
Update documentation
2024-07-07 11:37:26 +00:00
If your distro uses systemd, download [the latest systemd service
file][serviceFile] and place it in `/etc/systemd/system`. Run `systemctl
daemon-reload` to ensure systemd has seen the new service file.
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
Update documentation
2024-07-07 11:37:26 +00:00
If your distro uses an init system other than systemd then you will need to
configure that yourself. You can use the systemd service file linked above as a
reference.
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
Update documentation
2024-10-03 16:59:48 +00:00
[latest]: https://code.betamike.com/micropelago/isle/releases/latest
Update documentation
2024-07-07 11:37:26 +00:00
[serviceFile]: https://code.betamike.com/micropelago/isle/src/branch/main/dist/linux/isle.service
### From Source
Update documentation
2024-10-03 16:59:48 +00:00
If you'd like to build your own `isle` binary from scratch, see the [Building
Isle](./dev/building.md) document.
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
Update documentation
2024-07-07 11:37:26 +00:00
## Add Users to the `isle` Group (Optional)
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
Update documentation
2024-07-07 11:37:26 +00:00
If you wish to run isle commands as a user other than root, you can add that
user to the `isle` group:
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
More documentation updates, notably filling out firewall configuration
2024-12-18 20:54:15 +00:00
```bash
Update documentation
2024-07-07 11:37:26 +00:00
sudo usermod -aG isle username
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
```
Update documentation
2024-07-07 11:37:26 +00:00
## Start the isle Service
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
Update documentation
2024-07-07 11:37:26 +00:00
Once installed and bootstrapped you can enable and start the isle service by
doing:
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
More documentation updates, notably filling out firewall configuration
2024-12-18 20:54:15 +00:00
```bash
Perform all in-code renames which don't affect actual functionality
2023-08-05 21:53:17 +00:00
sudo systemctl enable --now 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
```
Update documentation
2024-07-07 11:37:26 +00:00
(NOTE If your distro uses an init system other than systemd then you will need
to instead start isle according to that system's requirements.)
Reference in New Issue Copy Permalink