Installation guide for Linux users

Installation Guide for Linux Users

This guide will help you install the necessary tools, set up SSH keys, and work with a Forgejo repository inside a Dev Container in Visual Studio Code.

---

1. Install Git

Run the following command in your terminal to install Git:

sudo apt update
sudo apt install git -y

---

2. Install Visual Studio Code

Follow these steps:

1. Download the .deb package of Visual Studio Code from the official website.

2. Install it using:

   sudo dpkg -i <filename>.deb
   sudo apt-get install -f

---

3. Generate SSH Keys

1. Generate an SSH key from your user account (not root):

   ssh-keygen -t ed25519 -C "your_email@example.com"

2. Press Enter for all prompts to accept defaults.

---

4. Add Your SSH Key to GitLab

1. Copy your public key:

   cat ~/.ssh/id_ed25519.pub

2. Go to the Solaris repo on GitLab and navigate to: Settings > SSH Keys.

3. Paste the copied key and save it.

---

5. Verify SSH Connection to GitLab

Run:

ssh -T git@github.com

---

6. Clone the Repository

1. Go to your project on GitHub and copy the SSH link of the repository.

2. In the terminal, navigate to the folder where you want to clone the repository:

   cd <desired_path>

3. Clone the repository:

   git clone --recurse-submodules git@github.com:secureshadow/solaris-software.git

---

7. Configure Required Files

1. You need to configure some files to enable remote debugging on the ESP32S3 board. Create a new file in ~/.ssh named config with the following content:

   Host raspi
      HostName 192.168.XX.YYY
      User username
      IdentityFile ~/.ssh/raspberrypi
      IdentitiesOnly yes

2. You also need to configure a file with your credentials: This file must be located at ~/.gitconfig:

   [user]
      name = name
      email = mail
   
   [safe]
      directory = /home/user/Documents/software-solaris

3. You need to create another SSH key inside ~/.ssh to connect to the Raspberry Pi:

   ssh-keygen -t ed25519 -C "your_email@example.com" -f ~/.ssh/raspberry

---

8. Project Configuration

1. Go to the json folder inside the cloned project:

   cd <repository_name>/json

2. Copy the Linux configuration content into the .devcontainer.json file.

---

9. Install the Dev Containers Extension in Visual Studio Code

1. Open Visual Studio Code.
2. Install the Dev Containers extension from the marketplace.

---

10. Open the Project in a Container

1. Open the project in Visual Studio Code.
2. Select Reopen in Container from the command palette (Ctrl+Shift+P).
3. Verify that your SSH key files have been loaded into the ~/.ssh folder inside the container.