From 1560cd714923c7a722cc38e6ddc3481169cef028 Mon Sep 17 00:00:00 2001 From: jahtz Date: Tue, 8 Oct 2024 15:52:41 +0200 Subject: [PATCH] resolve #1 update readme --- README.md | 64 +++++++++++++++++++++++++++++-------------------------- 1 file changed, 34 insertions(+), 30 deletions(-) diff --git a/README.md b/README.md index f189d12..4af7a4b 100644 --- a/README.md +++ b/README.md @@ -16,44 +16,48 @@ I started following their [guide](https://doku.tid.dfn.de/de:eduroam:easyroam#in Currently, the direct setup has been tested only on Fedora with NetworkManager, but I can extend support to other distributions and other network managers if there is interest. ## Usage -### Get certificate +### Step 1: Obtaining certificate 1. Open https://www.easyroam.de -2. Search your university and log in. -3. Go to `Generate profile`. -4. Select `manual options`, select `PKCS12` and enter your device name. -5. Download the file by clicking on the `Generate profile`-Button. +2. Search for your university and log in +3. Navigate to `Generate profile` +4. Select `manual options`, choose `PKCS12` and enter your device name +5. Download the file by clicking on the `Generate profile` button -### Fedora with NetworkManger -1. Download the script: - ``` - curl -o easyroamlinux.sh https://raw.githubusercontent.com/jahtz/easyroam-linux/main/easyroam_nm.sh - ``` -2. Make it executable: - ``` - chmod +x easyroam_nm.sh - ``` -3. Run setup: +### Step 2: Download +- **Network Manager**
+ Install easyroam/eduroam on distributions using NetworkManager + + > [!WARNING] + > Tested only on Fedora Workstation 40 + + > [!NOTE] + > For immutable distributions like Fedora Atomic Desktops, refer to [C-3PK's fork](https://github.com/C-3PK/easyroam-linux) + + > [!TIP] + > To remove the generated configuration, delete the file _/etc/NetworkManager/system-connections/easyroam.nmconnection_
or run: `nmcli connection delete easyroam` ``` - ./easyroam_nm.sh + curl -o easyroam.sh https://raw.githubusercontent.com/jahtz/easyroam-linux/main/easyroam_nm.sh ``` -4. If you want to delete the generated config remove _/etc/NetworkManager/system-connections/easyroam.nmconnection_ or run: +- **Manual**
+ This script unpacks the PKCS12 (.p12) file for manual configuration + > [!TIP] + > After unpacking, you can follow the official DNF guides for: + > - [netctl](https://doku.tid.dfn.de/de:eduroam:easyroam#installation_der_easyroam_profile_auf_linux_geraeten) (e.g. Arch) + > - [wpa-supplicant](https://doku.tid.dfn.de/de:eduroam:easyroam#installation_der_easyroam_profile_auf_linux_geraeten_ohne_desktop_umgebung_wpa-supplicant_only) (e.g. Pi OS Lite) ``` - nmcli connection delete easyroam + curl -o easyroam.sh https://raw.githubusercontent.com/jahtz/easyroam-linux/main/easyroam_cert.sh ``` + Resulting files: + - `easyroam_root_ca.pem` → CA certificate + - `easyroam_client_cert.pem` → User certificate + - `easyroam_client_key.pem` → Private key -### Manual extraction -1. Download the script: - ``` - curl -o easyroamlinux.sh https://raw.githubusercontent.com/jahtz/easyroam-linux/main/easyroam_cert.sh - ``` -2. Make it executable: +### Step 3: Run script +1. Make the script executable: ``` - chmod +x easyroam_cert.sh + chmod +x easyroam.sh ``` -3. Run setup: +2. Run the setup: ``` - ./easyroam_cert.sh + ./easyroam.sh ``` -4. Follow setup guides: - - [netctl](https://doku.tid.dfn.de/de:eduroam:easyroam#installation_der_easyroam_profile_auf_linux_geraeten) (e.g. Arch) - - [wpa-supplicant](https://doku.tid.dfn.de/de:eduroam:easyroam#installation_der_easyroam_profile_auf_linux_geraeten_ohne_desktop_umgebung_wpa-supplicant_only) (e.g. Pi OS Lite):