Skip to content
This repository was archived by the owner on Aug 13, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
74 changes: 48 additions & 26 deletions docs/how-to/terminus/setup/install/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,33 +19,55 @@ Before you begin, ensure your system meets these requirements:

## Step 1: Install Terminus

In your terminal, execute the following command to install Terminus:

- **To install the latest version of Terminus OS**:

```bash
curl -fsSL https://terminus.sh | bash -
```

- **To install a specific version**:

```bash

curl -LO https://github.com/beclab/terminus/releases/download/${VERSION}/install-wizard-v${VERSION}.tar.gz

mkdir -p install-wizard && cd install-wizard && \
tar -xzvf ../install-wizard-${VERSION}.tar.gz && bash install_cmd.sh
```

:::info
- Replace `{version}` with the current daily build version number. Check the [Terminus OS repository](https://github.com/beclab/terminus) for the latest version.
- If an error occurs during installation, use the following command to uninstall first:

```bash
bash uninstall_cmd.sh
```
After uninstalling, retry the installation by running the original installation command.
:::
1. Bind your local IP to your Ubuntu hostname for stable DNS resolution:

```bash
sudo apt install net-tools
ifconfig
# Get your local IP. Make sure it starts with `192.168`.
```

```bash
sudo nano /etc/hosts
# Add the following line
192.168.xx.xx linux
# Replace with your actual local IP and your host name.
```

2. Reboot your Ubuntu to apply the change.

```bash
sudo reboot
```

3. Execute the following command to install Terminus:

- **To install the latest version of Terminus OS**:

```bash
curl -fsSL https://terminus.sh | bash -
```

- **To install a specific version**:

```bash

curl -LO https://github.com/beclab/terminus/releases/download/${VERSION}/install-wizard-v${VERSION}.tar.gz

mkdir -p install-wizard && cd install-wizard && \
tar -xzvf ../install-wizard-${VERSION}.tar.gz && bash install_cmd.sh
```

:::info
- Replace `{version}` with the current daily build version number. Check the [Terminus OS repository](https://github.com/beclab/terminus) for the latest version.
- If an error occurs during installation, use the following command to uninstall first:

```bash
bash uninstall_cmd.sh
```
After uninstalling, retry the installation by running the original installation command.
:::

## Step 2: Enter Terminus Name

Expand Down
28 changes: 18 additions & 10 deletions docs/how-to/terminus/setup/install/raspberry.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,25 +23,33 @@ Before you begin, ensure your system meets these requirements:
echo "kernel=kernel8.img" | sudo tee -a /boot/firmware/config.txt
```

2. Reboot your Raspberry Pi to apply the changes.
2. Bind your local IP to your Ubuntu hostname for stable DNS resolution:

```bash
sudo reboot
sudo apt install net-tools
ifconfig
# Get your local IP. Make sure it starts with `192.168`.
```

3. Configure the hosts file. This ensures that the Raspberry Pi can resolve its own hostname to a stable IP address, which is important for internal networking within Terminus OS.

```bash
sudo nano /etc/hosts
192.168.50.11 raspberrypi # Adjust to your actual local IP address.

192.168.xx.xx raspberrypi
# Replace with your actual local IP and your host name.
```

3. Reboot your Raspberry Pi to apply the changes.
```bash
sudo reboot
```

4. Install the latest build of Terminus:

```bash
curl -sSfL https://github.com/beclab/Terminus/releases/download/${version}/install.sh | bash -
curl -fsSL https://terminus.sh | bash -
```
:::info
- Replace `{version}` with the current daily build version number. Check the [Terminus OS repository](https://github.com/beclab/terminus) for the latest version.

- If an error occurs during installation, use the following command to uninstall first:
:::info
If an error occurs during installation, use the following command to uninstall first:
```bash
bash uninstall_cmd.sh
```
Expand Down
47 changes: 29 additions & 18 deletions docs/how-to/terminus/setup/install/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,21 +21,14 @@ Before you begin, ensure your system meets these requirements:
- RAM: 8GB or above (available memory)
- Storage: 64GB or above (available disk space)
- Supported Systems:
- Windows: Windows 10 (Build 19041 or higher) or Windows 11
- Windows 11
- Linux (on WSL2): Ubuntu 20.04 LTS or later; Debian 11 or later
- [TermiPass](../../../termipass/overview.md#download-termipass) mobile app installed on your smartphone
- [Terminus Name](../../../termipass/account/index.md#create-a-terminus-name) created

## Step 1: Install Terminus

1. Open PowerShell as Administrator and run the following to update WSL2 and install Ubuntu:

```bash
wsl --update
wsl --install -d Ubuntu-22.04
```

2. Create a `.wslconfig` file in your Windows user directory (typically `C:\Users\YourUsername\`) with the following content:
1. Create a `.wslconfig` file in your Windows user directory (typically `C:\Users\YourUsername\`) with the following content:

```bash
[wsl2]
Expand All @@ -46,6 +39,13 @@ Before you begin, ensure your system meets these requirements:
[experimental]
hostAddressLoopback=true

2. Open PowerShell as Administrator and run the following to update WSL2 and install Ubuntu:

```bash
wsl --update
wsl --install -d Ubuntu-22.04
```

3. Launch Ubuntu from the Start menu, and configure the Ubuntu environment as below:

a. Modify the `/etc/wsl.conf` file:
Expand All @@ -65,17 +65,29 @@ Before you begin, ensure your system meets these requirements:
sudo mount --make-rshared /
```

c. Configure the hosts file to ensure stable host resolution within WSL:

```bash
sudo nano /etc/hosts
# Add the following line
192.168.50.11 ubuntu # Adjust to your actual local IP address
```
c. Bind your local IP to your Ubuntu hostname for stable DNS resolution:

```bash
sudo apt install net-tools
ifconfig
# Get your local IP. Make sure it starts with `192.168`.
```

```bash
sudo nano /etc/hosts
192.168.xx.xx ubuntu
# Replace with your actual local IP and your host name.
```

d. Reboot your Ubuntu to ensure the changes take effect.

```bash
sudo reboot
```

4. In Ubuntu, run the following command to install the latest build of Terminus:

```bash
```bash
curl -fsSL https://terminus.sh | bash -
```

Expand All @@ -87,7 +99,6 @@ Before you begin, ensure your system meets these requirements:
After uninstalling, retry the installation by running the original installation command.
:::


## Step 2: Enter Terminus Name

At the end of the installation process, enter your domain name and Terminus Name as prompted by the system:
Expand Down
2 changes: 1 addition & 1 deletion docs/overview/introduction/getting-started/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Before you begin, ensure your system meets these requirements. For optimal perfo

| | Linux | Raspberry Pi | macOS | Windows |
|---|---|---|---|---|
| Operating System | Ubuntu 20.04 or later, Debian 11 or later | Raspbian 12 | macOS Monterey (12) or later | Windows 10 (Build 19041 or later) or Windows 11 |
| Operating System | Ubuntu 20.04 or later, Debian 11 or later | Raspbian 12 | macOS Monterey (12) or later | Windows 11 |
| Arch/Model | x86-64, amd64 | Raspberry Pi 5 | Apple Silicon (ARM64) | x86-64, amd64 |
| RAM | 8GB | 8GB | 8 GB | 8GB |
| Disk Space | 64GB | 64GB MicroSD (Class 2) | 64GB | - |
Expand Down
25 changes: 23 additions & 2 deletions docs/overview/introduction/getting-started/linux.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,13 +14,34 @@ Open TermiPass on your mobile, and [create a new Terminus Name](../../../how-to/

## Step 2: Install Terminus

1. In your terminal, run the following command to install the latest build of Terminus:
1. Bind your local IP to your Ubuntu hostname for stable DNS resolution:

```bash
sudo apt install net-tools
ifconfig
# Get your local IP. Make sure it starts with `192.168`.
```

```bash
sudo nano /etc/hosts
# Add the following line
192.168.xx.xx Ubuntu
# Replace with your actual local IP and your host name.
```

2. Reboot your Ubuntu to apply the change.

```bash
sudo reboot
```

3. In your terminal, run the following command to install the latest build of Terminus:

```sh
curl -fsSL https://terminus.sh | bash -
```

2. At the end of the installation, take note of the URL for Terminus Activation wizard and your initial login password.
4. At the end of the installation, take note of the URL for Terminus Activation wizard and your initial login password.

Depending on your network and hardware configuration, the installation time may vary. For detailed instructions, see [Install Terminus on Linux](../../../how-to/terminus/setup/install/linux.md).

Expand Down
30 changes: 19 additions & 11 deletions docs/overview/introduction/getting-started/raspberry.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@

# Getting Started on Raspberry Pie
# Getting Started on Raspberry Pi

This guide will walk you through the essential steps to get Terminus up and running on your Raspberry Pi. Follow these steps to create your account, install Terminus, and start exploring the Terminus ecosystem.

Expand All @@ -22,27 +22,35 @@ Open TermiPass on your mobile, and [create a new Terminus Name](../../../how-to/
echo "kernel=kernel8.img" | sudo tee -a /boot/firmware/config.txt
```

2. Reboot your Raspberry Pi to apply the changes.
2. Bind your local IP to your Ubuntu hostname for stable DNS resolution:

```bash
sudo reboot
sudo apt install net-tools
ifconfig
# Get your local IP. Make sure it starts with `192.168`.
```

3. Configure the hosts file to ensure stable host resolution.

```bash
sudo nano /etc/hosts
192.168.50.11 raspberrypi # Adjust to your actual local IP address

# Add the following line
192.168.xx.xx raspberrypi
# Replace with your actual local IP and your host name.
```

3. Reboot your Raspberry Pi to apply the changes.
```bash
sudo reboot
```

4. Install the latest build of Terminus:

```bash
curl -sSfL https://github.com/beclab/Terminus/releases/download/${version}/install.sh | bash -
curl -fsSL https://terminus.sh | bash -
```
:::info
Replace `{version}` with the current daily build version number. Check the [Terminus OS repository](https://github.com/beclab/terminus) for the latest version.

5. At the end of the installation, take note of the URL for Terminus Activation wizard and your initial login password.

For more detailed instructions, see [Install Terminus on Raspberry Pie](../../../how-to/terminus/setup/install/raspberry.md).
For more detailed instructions, see [Install Terminus on Raspberry Pi](../../../how-to/terminus/setup/install/raspberry.md).

## Step 3: Activate Terminus

Expand Down
69 changes: 40 additions & 29 deletions docs/overview/introduction/getting-started/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,7 @@ Open TermiPass on your mobile, and [create a new Terminus Name](../../../how-to/

## Step 2: Install Terminus

1. Open PowerShell as Administrator and run the following commands:

```bash
wsl --update
wsl --install -d Ubuntu-22.04
# Update WSL2 and install Ubuntu
```

2. Create a `.wslconfig` file in your Windows user directory (typically `C:\Users\YourUsername\`) with the following content:
1. Create a `.wslconfig` file in your Windows user directory (typically `C:\Users\YourUsername\`) with the following content:

```bash
[wsl2]
Expand All @@ -40,32 +32,51 @@ Open TermiPass on your mobile, and [create a new Terminus Name](../../../how-to/
[experimental]
hostAddressLoopback=true

3. Launch Ubuntu from the Start menu, and configure the Ubuntu environment as below:

a. Modify the `/etc/wsl.conf` file:

2. Open PowerShell as Administrator and run the following commands:

```bash
echo "[network]
generateHosts = false
generateResolvConf = false" | sudo tee -a /etc/wsl.conf
wsl --update
wsl --install -d Ubuntu-22.04
# Update WSL2 and install Ubuntu
```
:::info
This configuration prevents WSL2 from overwriting your Windows host's DNS settings.
:::

b. Configure Mount:
3. Launch Ubuntu from the Start menu, and configure the Ubuntu environment as below:

```bash
sudo mount --make-rshared /
```
a. Modify the `/etc/wsl.conf` file by executing the following command:

c. Configure the hosts file:
```bash
echo "[network]
generateHosts = false
generateResolvConf = false" | sudo tee -a /etc/wsl.conf
# Prevent WSL2 from overwriting your Windows host's DNS settings.
```

```bash
sudo nano /etc/hosts
# Add the following line
192.168.50.11 ubuntu # Adjust to your actual local IP address
```
b. Configure Mount:

```bash
sudo mount --make-rshared /
```

c. Bind your local IP to your Ubuntu hostname for stable DNS resolution:

```bash
sudo apt install net-tools
ifconfig
# Get your local IP. Make sure it starts with `192.168`.
```

```bash
sudo nano /etc/hosts
# Add the following line
192.168.xx.xx ubuntu
# Replace with your actual local IP and your host name.
```

d. Reboot your Ubuntu to ensure the changes take effect.

```bash
sudo reboot
```

4. In Ubuntu, run the following command to install the latest build of Terminus:

Expand Down