Skip to content

Commit 72ed87d

Browse files
committed
Added FreeBSD install instructions
1 parent 8f37685 commit 72ed87d

File tree

1 file changed

+76
-46
lines changed

1 file changed

+76
-46
lines changed

docs/content/getting_started/_index.md

Lines changed: 76 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -15,67 +15,97 @@ Install Ruby
1515

1616
### Step 2 - Install Itsi
1717

18-
{{< tabs items="Linux,Mac,Windows" >}}
18+
{{< tabs items="Linux,Mac,Windows,FreeBSD" >}}
1919
{{< tab >}}
2020
**Prerequisites**
2121

22-
You'll need at least `build-essential` and `libclang-dev` installed to build Itsi on Linux.
23-
E.g.
24-
```bash
25-
apt-get install build-essential libclang-dev
26-
```
2722

28-
Then use `gem` to install Itsi, or its components based on your Ruby version.
29-
30-
**For Ruby >= 3.0**:
31-
```bash
32-
gem install itsi
33-
```
34-
*(Installs both `itsi-server` and `itsi-scheduler`)*
35-
36-
**For Ruby 2.7**:
37-
```bash
38-
gem install itsi-server
39-
```
40-
*(Installs `itsi-server` only; `itsi-scheduler` is not supported on Ruby 2.7)*
41-
42-
{{< callout type="info" >}}
43-
Itsi (**server + scheduler**) requires **Ruby >= 3.0**.
44-
45-
Itsi **server** supports **Ruby >= 2.7**.
46-
47-
If you wish to use either the scheduler or server independently:
48-
- `gem install itsi-server`
49-
- `gem install itsi-scheduler` (Ruby >= 3.0 only)
50-
{{< /callout >}}
23+
You'll need at least a C/C++ build environment and `clang` and `curl` (for running `rustup`) installed.
24+
25+
#### For Ubuntu / Debian:
26+
```bash
27+
apt-get install build-essential libclang-dev curl
28+
```
29+
#### For Fedora / RHEL / Rocky / AlmaLinux:
30+
```bash
31+
dnf groupinstall "Development Tools"
32+
dnf install clang curl
33+
```
34+
#### For Arch Linux / Manjaro:
35+
```bash
36+
pacman -S base-devel clang curl
37+
```
38+
#### For Alpine Linux:
39+
```bash
40+
apk add build-base clang curl
41+
```
42+
43+
Then use `gem` to install Itsi, or its components based on your Ruby version.
44+
45+
**For Ruby >= 3.0**:
46+
```bash
47+
gem install itsi
48+
```
49+
*(Installs both `itsi-server` and `itsi-scheduler`)*
50+
51+
**For Ruby 2.7**:
52+
```bash
53+
gem install itsi-server
54+
```
55+
*(Installs `itsi-server` only; `itsi-scheduler` is not supported on Ruby 2.7)*
56+
57+
> ℹ️ **Itsi (`server` + `scheduler`) requires Ruby >= 3.0**
58+
> Itsi `server` supports Ruby >= 2.7
59+
> You can install components individually:
60+
> `gem install itsi-server`
61+
> `gem install itsi-scheduler` (Ruby >= 3.0 only)
5162
5263
{{< /tab >}}
5364
{{< tab >}}
5465
**Mac**:
5566
**For Ruby >= 3.0**:
56-
```bash
57-
gem install itsi
58-
```
67+
```bash
68+
gem install itsi
69+
```
70+
*(Installs both `itsi-server` and `itsi-scheduler`)*
71+
72+
**For Ruby 2.7**:
73+
```bash
74+
gem install itsi-server
75+
```
76+
*(Installs `itsi-server` only; `itsi-scheduler` is not supported on Ruby 2.7)*
77+
78+
> ℹ️ **Itsi (`server` + `scheduler`) requires Ruby >= 3.0**
79+
> Itsi `server` supports Ruby >= 2.7
80+
> You can install components individually:
81+
> `gem install itsi-server`
82+
> `gem install itsi-scheduler` (Ruby >= 3.0 only)
83+
{{< /tab >}}
84+
{{< tab >}}**Windows**: Itsi currently doesn't support native Windows builds, but it runs well on [WSL](https://learn.microsoft.com/en-us/windows/wsl/install).
5985
60-
**For Ruby 2.7**:
61-
```bash
62-
gem install itsi-server
63-
```
86+
Follow the linked instructions to install a Linux distribution like Ubuntu or Debian, and then follow the instructions in the Linux tab.
87+
{{< /tab >}}
88+
{{< tab >}}
89+
**FreeBSD**
6490

65-
{{< callout type="info" >}}
66-
Itsi (**server + scheduler**) requires **Ruby >= 3.0**.
91+
On FreeBSD you'll need to install a few build tools manually:
92+
```bash
93+
pkg install gmake cmake curl llvm
94+
```
6795

68-
Itsi **server** supports **Ruby >= 2.7**.
96+
Then install Itsi with GNU make to avoid build errors:
97+
```bash
98+
MAKE=gmake gem install itsi
99+
```
69100

70-
You can install components individually:
71-
- `gem install itsi-server`
72-
- `gem install itsi-scheduler` (Ruby >= 3.0 only)
73-
{{< /callout >}}
101+
*(Installs both `itsi-server` and `itsi-scheduler`)*
74102

75-
{{< /tab >}}
76-
{{< tab >}}**Windows**: Itsi currently doesn't support native Windows builds, but it runs well on [WSL](https://learn.microsoft.com/en-us/windows/wsl/install).
103+
**For Ruby 2.7**:
104+
```bash
105+
MAKE=gmake gem install itsi-server
106+
```
107+
*(Installs `itsi-server` only; `itsi-scheduler` is not supported on Ruby 2.7)*
77108

78-
Follow the linked instructions to install a Linux distribution like Ubuntu or Debian, and then follow the instructions in the Linux tab.
79109
{{< /tab >}}
80110

81111
{{< /tabs >}}

0 commit comments

Comments
 (0)