Skip to content

Nstbrowser/nstbrowser-agent-setup

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

14 Commits
 
 
 
 
 
 

Repository files navigation

Nstbrowser Agent Setup

Introduction

Nstbrowser is an efficient, secure, and user-friendly browser solution designed to enhance productivity and protect user privacy.
This repository provides the installation script for Nstagent, enabling quick deployment of the client service. Nstagent is a core component of Nstbrowser, responsible for seamless communication with the server.


Key Features

  • Quick Deployment: Install with a single command.
  • Modular Installation: Flexibly skip font or kernel installation based on your environment needs.
  • Lightweight and Efficient: Runs stably with minimal resource usage.
  • Version Management: Supports installing specific versions of Nstagent for easier maintenance and upgrades.
  • Open API: Offers powerful APIs for seamless integration and customization.

Installation Guide

1. Install Nstagent

Run the following command to install the latest version of Nstagent:

wget -qO- https://raw.githubusercontent.com/Nstbrowser/nstbrowser-agent-setup/refs/heads/main/scripts/agent_install.sh | sudo bash

Note: By default, the script installs necessary fonts and kernel. You can skip these installations using the following options:

  • Skip Kernel Installation: --no-kernel
  • Skip Font Installation: --no-fonts

Example:

Install Nstagent without fonts and kernel:

wget -qO- https://raw.githubusercontent.com/Nstbrowser/nstbrowser-agent-setup/refs/heads/main/scripts/agent_install.sh | sudo bash -s -- --no-kernel --no-fonts

2. Run Nstagent

After installation, run the following command to start Nstagent:

agent --referer=client

Default Service Port: 8848


Nstcli: Command-Line Management

To manage Nstagent efficiently, we provide nstcli, a command-line tool with various management capabilities. You can use nstcli to start, stop, upgrade, and inspect the agent, as well as manage profiles and kernel versions.

For detailed usage instructions, please refer to the Nstcli Documentation.


Supported Systems

Nstbrowser Agent is compatible with the following operating systems and architectures:

  • Ubuntu 24.04:

    • Architecture: AMD64 (x86_64)
    • Architecture: ARM64 (aarch64)
  • Ubuntu 22.04:

    • Architecture: AMD64 (x86_64)
    • Architecture: ARM64 (aarch64)

Note: The Nstbrowser Agent is currently only supported on the specified versions of Ubuntu. Other operating systems and versions have not been tested or adapted for compatibility.


System Requirements

To ensure optimal performance and functionality, Nstbrowser Agent requires the following system resources:

  • Memory: At least 2 GB of RAM is required.
  • Disk Space:At least 10 GB of free disk space is required.

Resources


API Documentation

Nstbrowser provides a robust API for developers to integrate and extend its functionality.
For detailed API usage instructions, refer to the Nstbrowser API Documentation.


Contributing

We welcome contributions from the community!
If you encounter any issues or have feature suggestions, feel free to reach out to us via Discord.

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •  

Languages