Skip to main content
Enterprises can deploy and manage CyStack Endpoint software on their own infrastructure by following the instructions below.
Note: Currently, Endpoint Server only supports Linux.

​
System Requirements

General Notes:
  • The server needs a public IP address.
  • Do not press Ctrl+C during the installation process.

​
Managing fewer than 100 devices

If system dependencies (Redis, MySQL) are installed directly on the server, the following minimum specifications are required:
Server CountCPU (cores)RAMStorage (SSD)
124GB75GB

​
Managing 100–1000 devices

Scenario 1: If system dependencies (Redis, MySQL) are installed directly on the server, the following minimum specifications are required:
Server CountCPU (cores)RAMStorage (SSD)
110.517.1 GB200 – 300 GB
Scenario 2: If system dependencies (Redis, MySQL) are deployed within containers, the minimum container configuration requirements are as follows:
ComponentContainer CountCPU/ContainerRAM/ContainerStorage (SSD)
Fleet10.54 GB-
Redis 6321.47 GB-
MySQL 8.0 (Aurora 3.07.1)224.3 GB10 GB

​
Installation

The installation process for CyStack Endpoint can be automated using the endpointCtl binary utility.
1

Download the installation tool

mkdir -p ~/endpoint && cd ~/endpoint
wget https://d.cystack.net/endpointctl/endpointctl
ls -l
install-server-1install-server-2
2

Grant execution permissions for the installer

chmod +x endpointctl
3

Run the installer

./endpointctl start
Enter the root password when prompted. The installation process typically takes 1–3 minutes.
4

Select installation method

Option 1: Use default configuration
  • The system will automatically create the database; no user intervention is required.
  • Input 1 and press Enter.
install-server-4Option 2: Use existing MySQL installation
  • Input 2 and press Enter.
  • Have the following information ready:
FieldExample
MySQL Hostlocalhost
MySQL Port3306
Database/User/Password for servicesces_fleet / ces_api / ces_data_labeling
5

Enter Workspace Credentials

After MySQL is configured, the system will request the following details:
Work Space ID
Work Space Secret
(These credentials will be provided by CyStack).Estimated completion time: 3–10 minutes (depending on server specifications). Upon completion, the program will display a list of active services.install-server-5
6

Post-Installation

✅ Verify the agent fileUpon completion, the agent file is generated automatically:
cystack-endpoint_<version>_amd64.deb
✅ Configure automatic updatesRun the following command:
nohup ./endpointctl update > endpoint_updater.log 2>&1 &

​
Using endpointctl

​
Command Reference

CommandDescription
./endpointctl startInstall Endpoint. Append --config (path to config file) or --re-config to reinstall.
./endpointctl stopStop all services.
./endpointctl statusCheck the status of all services.
./endpointctl backupCreate a .zip backup of the database in ~/.cystack/endpoint_server/backupdb/.
./endpointctl restore <path>Restore the database from a .zip file.
./endpointctl updatePerform daily automatic updates. Can be run in the background using nohup.

​
Troubleshooting

​
❌ Container reports “Unhealthy” status

  • Cause: Insufficient server resources or database configuration errors.
  • Resolution:
    • Check container logs: 
      docker logs -f ces_fleet_container
    • If migration is complete Restart the process: 
      ./endpointctl start --re-config
    • If database errors persist Delete the config and reinstall from scratch.

​
⚠️ Missing configuration error

Run ./endpointctl start to generate the root configuration file, then edit and reuse it.

​
⚙️ Backup process takes too long

This is typically due to limited server resources. Please wait patiently for the process to complete.

​
🔑 Token retrieval error

Please contact CyStack Support.

​
🌐 Domain Error (Caddy)

  • Check the logs: 
    docker logs -f caddy_container
  • If:
    • The domain does not point to the correct IP Update DNS records.
    • The domain has reached SSL limits Switch to a different domain.