Run the Server

Choose one of the following methods to run the Huntly server:

Option A: Docker Compose (Recommended)

Create a docker-compose.yml file:

version: '3.8'

services:
  huntly:
    image: lcomplete/huntly
    container_name: huntly
    restart: always
    ports:
      - "8088:80"
    volumes:
      - ~/data/huntly:/data
    labels:
      - "com.centurylinklabs.watchtower.enable=true"

It's recommended to use Watchtower for automatic updates to get the latest features.

Then run:

docker-compose up -d

Option B: Desktop Client

Download the installation package for your operating system from Releases and run it after installation.

If you encounter the error message "Huntly.app" is damaged and can't be opened on macOS, run:

sudo xattr -r -d com.apple.quarantine /YOUR_PATH/Huntly.app

See the Run the Server wiki for more options.

Option C: Docker

mkdir huntly && cd huntly
docker run -itd --name huntly --restart=always -p 8080:80 -v `pwd`/data:/data lcomplete/huntly

Always pull the latest image. If you need to upgrade, delete the local latest image and run the startup command again.

Option D: Run with Java

Download the jar package from Releases, then run:

java -Xms128m -Xmx1024m -jar huntly-server.jar

By default it runs on port 8080. To use a different port:

java -Xms128m -Xmx1024m -jar huntly-server.jar --server.port=80

Option E: Install as Windows Service

Create a new directory named Huntly, and perform the following operations in this directory.

Download the jar package from Releases.

Download WinSW exe and rename it to app.exe.

Create a new file named app.xml with the following content:

<service>
  <id>huntly</id>
  <name>huntly</name>
  <description>huntly</description>
  <executable>java</executable>
  <arguments>-Xms128m -Xmx1024m -jar huntly-server.jar --server.port=8123</arguments>
  <log mode="roll"></log>
</service>

Open the terminal and run the command:

.\app.exe install .\app.xml

After executing the above command, Huntly has been installed as a Windows service and set to start automatically at boot. It is currently not started. Use the following command to start the service:

.\app.exe start .\app.xml

If you receive an error message that java cannot be executed, change the value of executable to the full path of java.exe.

Other commands such as uninstall, stop, restart, status, refresh, customize are also supported. For specific usage instructions please refer to https://github.com/winsw/winsw.

After successful startup, you can access http://localhost:8123.