NethLink is a tool designed to link NethServer systems and provide remote access tools. This project aims to offer a simple yet powerful user interface for managing NethServer systems more efficiently.
Key Features:
Multi-server management: Connect and manage multiple NethServer instances from a single interface.
Secure remote access: Provide RDP, SSH, and VNC access to NethServer systems with role-based permissions.
Real-time monitoring: Track system performance, resource usage, and status updates in real time.
Centralized configuration: Simplify the setup and management of services across multiple servers.
Integration support: Seamlessly integrate with existing infrastructure and workflows.
Audience & Benefit:
Ideal for system administrators, IT professionals, and organizations managing NethServer environments. By streamlining server management and remote access, NethLink helps reduce operational complexity and improve efficiency. It is particularly beneficial for teams that need to manage multiple servers or require secure, centralized access control.
NethLink can be installed via winget on Windows, making it easy to deploy across supported platforms.
README
NethLink
NethLink is a tool designed to link NethServer systems and provide remote access tools. This project aims to offer a simple yet powerful user interface for managing NethServer systems more efficiently.
🔧 Installation
macOS (Homebrew)
To install NethLink on macOS, use Homebrew:
brew install --cask nethlink
Windows (Winget)
For Windows, you can install NethLink via Winget:
winget install NethLink
Linux (Manual Installation)
For Linux, you can install NethLink manually using the following steps:
Download the NethLink AppImage using curl or wget:
This will allow you to run NethLink on your Linux machine. You can also move the nethlink.AppImage to a directory in your PATH to make it easier to run from anywhere.
📦 Requirements
macOS: Version 10.15 (Catalina) or later.
Windows: Windows 10 or later.
Rosetta: Required on macOS for ARM architectures.
⚙️ Usage
Launch the app: After installation, open on macOS or the executable on Windows.
To get started with NethLink development, follow the steps below.
Install Dependencies
Install the project dependencies using npm:
npm install
Development Mode
To run the application in development mode, use:
npm run dev
Build the Application
To build the application for different platforms:
# For Windows
npm run build:win
# For macOS
npm run build:mac
# For Linux
npm run build:linux
Release Versions
To release a new version of the application, use the following commands:
# For major release
npm run publish:major
# For minor release
npm run publish:minor
# For patch release
npm run publish:patch
⚙️ Env Variables
Use the following environment variables for testing purposes:
> DEV=true
> Runs the app in development mode.
> INSTANCE=
> Enables multiple instances of the process. Use this function with caution, as it can cause issues. This is only for testing purposes. When this variable is set, a new user_data_.json is created and the instance only changes its related file.
🗂 User Data Folders
The user data folders for different operating systems are as follows:
Windows: %APPDATA%/nethlink/
Linux: ~/.config/nethlink/
macOS: ~/Library/Application Support/nethlink/
There are two files: user_data.json and available_users.json. The first file contains the data of the currently logged-in user, while the second contains data for all users who have logged in at least once on the device.