Getting Started with EdgeGO
Follow these steps to get EdgeGO up and running:
Step 1: Support Virtual Environment - Download and install VirtualBox.
Step 2: Import Virtual Machine - Install EdgeGO Server.
Step 3: Install Controlled Devices - Download and install EdgeGO Agent.
Step 4: Pair Devices with the Server - Onboard Devices.
Step 1: Download and Install Virtualbox
Follow these steps to download and install VirtualBox on different operating systems.
Windows
Download and Install:
1. Go to the VirtualBox website.
2. Download the VirtualBox installer for Windows.
3. Locate the downloaded file, and double-click the file to start the installation.
Linux
Download and Install:
Method 1:
Open the Terminal and execute the following commands:
> Ensure that the system is up to date: sudo apt-get update
> Install VirtualBox: sudo apt-get install virtualbox
Method 2:
> Download the Linux installer from the VirtualBox website
> Open the Terminal and run
sudo dpkg -i virtualbox-7.0_7.012-15984~Ubuntu~
During the installation process, if you encounter a message indicating that the user is not in the sudoers file, additional steps are required to modify user permissions. <USERNAME> is not in the sudoers file. This incident will be reported.
1. Switch to the user "root": su root
2. Edit the sudo users: visudo
3. Under "User privilege specification", add the line : <USERNAME> ALL=(ALL:ALL)ALL
4. Save and exit.
For other operating systems, please refer to the VirtualBox website
After successfully downloading and installing VirtualBox, the next step is to install EdgeGO Sever.
Step 2: Install EdgeGO Server
Download EdgeGO OVA
Launch VirtualBox and import EdgeGO OVA installation file
Configure the virtual machine with the following settings:
・RAM : Recommended 5,120MB or above.
・MAC Address Policy : Generate a new MAC address for all network adapters (Adjust as needed).
Keep other settings unchanged and click Finish to complete the import.
Start Guest VM
You may encounter a VirtualBox Error when starting the VM, follow the steps below to resolve :
1. Click on Change Network Settings close the pop-up
2. Click Settings
3. In the Settings window, click OK without modifying network settings (adjust as needed)
4. Restart the Guest VM
Wait for EdgeGO server to start, it may take up two minutes
Ensure you wait for the server to fully start before proceeding.
Open EdgeGO Server Web Interface
Open a web browser on any Linux / Windows host within the local network.
Enter http://server-edgego.local/ in the address bar.
It is recommended to open the web interface for the first time on the host machine.
By default, EdgeGO launches with a self-signed certificate, which is not recommended for production usage. Users should accept the self-signed certificate initially, but it is advised to host a proxy with valid certificates and redirect the traffic to the EdgeGO server for production sites. More information can be found on the page about hosting EdgeGO in public clouds.
You should see the EdgeGO login screen. Log in to initiate the download and installation of the EdgeGO Agent.
At this point, you have successfully installed and accessed the EdgeGO server.
EdgeGO Server Initial Login and Basic Functionality Guide
On the login screen, enter the default system username and password.
Account : [email protected]
Password : admin!#
Click on the sidebar to explore the functionalities of various tabs.
If there are no relevant devices listed, navigate to the "Devices" tab in the sidebar and download/install the EdgeGO Agent
Step 3: Download and Install Device Agent
1. The target device should log in to EdgeGO Server at http://server-edgego.local/.
Ensure that the target device is on the same domain as the host for successful access to the URL.
2. Click on the sidebar to navigate to the Device List, then click the +Device Agent Download
3. Download the Agent installation file based on the operating system version of the target device.
4. Install the Agent using the following method depending on the operating system:
The installation process varies based on the operating system
Installation Methods:
1. Windows: Simply click on the installation file and follow the on-screen instructions.
2. Linux: Unzip the downloaded file: unzip filename.zip> Open the Terminal with administrator privileges.
- Change path: cd Downloads/EdgeGO...
If your Ubuntu version is 22.04, you need to follow the instructions below to enable remote desktop:
> Execute command: sudo bash install_lightdm.sh
This will pop up a window with gdm and lightdm, pick lightdm
> After reboot, change path back to : cd Downloads/EdgeGO...
- Execute command: sudo bash install.sh
The installation process may differ depending on the operating system.
The EdgeGO Device Agent has been successfully downloaded and installed on the target device.
Step 4: Onboard Devices
After installation, we will need to pair the EdgeGO server with our installed agent through an onboarding process.
The onboarding process consists two stages:
Stage 1: Agent searches for the server location and requests pairing.
Stage 2: Server receives the request and the administrator accepts the pairing request.
Agent Request Pairing
The execution process may vary based on the operating system.
Windows:
Open File Explorer
> Navigate to: C:\Program Files (x86)\EdgeGO\edgegoagent\cmd
> Right click on devicego.exe and run as an administrator.
Ubuntu / Raspbian:
> Open Terminal and navigate to: /opt/edgego/agent/cmd
> Run with administrator privileges: sudo ./devicego
Verify successful execution when the screen displays the starting text as follows:
"Proceed to the 'Devices Page'..."
If a local EdgeGO server cannot be found within your Local Area Network (LAN), you will be prompted to specify a remote IP address for connection. To avoid unexpected errors, do not launch another EdgeGO server within the LAN after pairing with a remote one. For more information, please refer to our online FAQ.
Server Accept Pairing Request
1. Go back to EdgeGO Server.
2. Click on the Refresh ; the status should be PENDING.
3. Click on Operation select Onboard Device
4. Choose the Device Group name and add the Device to the group.
5. Click Refresh to update the Device list, confirming the successful pairing of the Server and Agent.
If the device status remains “ OFFLINE ” after the onboarding process.
1. Check if the agent service is still running.
2. Make sure the date and time settings are the same in both the server device and the agent devices
Congratulations! You have successfully completed the setup process for EdgeGO.
Now you can start enjoying EdgeGO and explore its various features.
If you encounter any issues or need further assistance, please refer to the documentation or contact our team.
Happy exploring with EdgeGO!