Step 1: Open Allxon Installer
-
On Linux OS:
- Open the Terminal
- Enter the installation command with desired options (refer to Step 2.):
sudo bash -c "$(wget -qO - https://get.allxon.net/linux)" -s [options] [arguments]
- On Windows OS:
- Open the Powershell as an Admin
- Enter the installation command with desired options (refer to Step 2.):
Set-ExecutionPolicy RemoteSigned -Scope Process -Force; Invoke-WebRequest -Uri "https://get.allxon.net/windows" -OutFile "$env:TEMP\allxon-installer.ps1"; & "$env:TEMP\allxon-installer.ps1" -[options] [arguments]
Step 2: Introduction to Options
These two options can be used separately or in combination.
- Device Name
- Linux:
sudo bash -c "$(wget -qO - https://get.allxon.net/linux)" -s --name "Your device's name"
- Windows:
Set-ExecutionPolicy RemoteSigned -Scope Process -Force; Invoke-WebRequest -Uri "https://get.allxon.net/windows" -OutFile "$env:TEMP\allxon-installer.ps1"; & "$env:TEMP\allxon-installer.ps1" -Name 'Your device's name'
- Device Profile
sudo bash -c "$(wget -qO - https://get.allxon.net/linux)" -s --profile path/profile.json- Windows:
Set-ExecutionPolicy RemoteSigned -Scope Process -Force; Invoke-WebRequest -Uri "https://get.allxon.net/windows" -OutFile "$env:TEMP\allxon-installer.ps1"; & "$env:TEMP\allxon-installer.ps1" -Profile 'path/profile.json'
-
The profile file is a JSON file that contains the fields under the Profile section in the Allxon Portal. This file can be used to set the profile during installation and should be in the above format.
profile={
"store": "My Store",
"phone": "12345678",
"asset": "ASSET123",
"address": "123 Main St",
"city": "Anytown",
"state": "CA",
"country": "USA",
"zip": "12345",
"note": "This is a note",
"tags": [
"tag1",
"tag2"
]
}
Notes:
1. country: should be in ISO 3166-1 alpha-2 format.
2. tag: only up to three tags, each up to 10 characters
*You can also download the JSON template directly.
- Used In Combination:
- Linux:
sudo bash -c "$(wget -qO - https://get.allxon.net/linux)" -s --name "Your device name" --profile path/profile.json
- Windows:
Set-ExecutionPolicy RemoteSigned -Scope Process -Force; Invoke-WebRequest -Uri https://get.allxon.net/windows -OutFile $env:TEMP\allxon-installer.ps1; & $env:TEMP\allxon-installer.ps1 -Name "my device" -Profile "path/profile.json"
💡Note: If you’re unsure about the available commands or need guidance on the correct parameters, use the -h
option to view a complete list of CLI commands and their descriptions. This can help you quickly find the correct usage.
For more options, learn more at: https://github.com/allxon/allxon-cli/blob/master/docs/Home.md