Skip to main content

Install on Linux

Install 'hypermass' command​

You can download the latest pre-compiled binaries for your operating system from the Releases Page.

Extract the executable:

tar -xzf hypermass_*.tar.gz

Mark the file as executable

chmod +x ./hypermass

Move to the common user binaries path;

sudo cp ./hypermass /usr/local/bin

Verify​

Open a new terminal and run;

hypermass

You should see the command documentation.

Done!

Now that the command is installed, we suggest going to this page; Using the CLI

Optional: Adding a Sync service (Server mode)​

If you're installing hypermass on a server to integrate into a system, you will likely want to run the "hypermass sync" as a service.

Benefits:

  • Ensures that sync is always running (so your data is always up-to-date)
  • Logs go to a standard location (not just the terminal)
  • Built in service tools;
    • auto start on server startup
    • restart on error
    • management commands

Linux (SystemD)​

This covers the common modern options: RHEL & Derivatives, Ubuntu, SUSE & Derivatives, Amazon Linux 2023, Arch, etc

sudo nano /etc/systemd/system/hypermass.service

Paste the following configuration (adjust /usr/local/bin/hypermass if your binary is elsewhere): Ini, TOML

[Unit]
Description=Hypermass Sync Daemon
After=network.target
StartLimitIntervalSec=0

[Service]
Type=simple
Restart=always
RestartSec=5
User=your-username
ExecStart=/usr/local/bin/hypermass sync
WorkingDirectory=/home/your-username

[Install]
WantedBy=multi-user.target

Enable and start the service:

sudo systemctl daemon-reload
sudo systemctl enable hypermass
sudo systemctl start hypermass

Monitoring and Output​

Just use the usual systemctl / journalctl commands

Check the status;

systemctl status hypermass

Get the logs;

journalctl -u hypermass -f
Done!

Now that the command is installed, we suggest going to this page; Using the CLI