https://github.com/humpback/humpback-agent

The humpback agent
https://github.com/humpback/humpback-agent

docker docker-manage humpback

Last synced: 6 months ago
JSON representation

The humpback agent

• Host: GitHub
• URL: https://github.com/humpback/humpback-agent
• Owner: humpback
• License: apache-2.0
• Created: 2017-04-19T08:58:59.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2025-06-23T01:12:47.000Z (about 1 year ago)
• Last Synced: 2025-06-23T02:24:25.841Z (about 1 year ago)
• Topics: docker, docker-manage, humpback
• Language: Go
• Homepage:
• Size: 430 KB
• Stars: 21
• Watchers: 6
• Forks: 22
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# humpback-agent

[![PkgGoDev](https://pkg.go.dev/badge/github.com/docker/docker)](https://golang.org/)

[![Docker](https://img.shields.io/badge/docker-pull-blue?logo=docker)](https://hub.docker.com/r/humpbacks/humpback-agent)

[![Base: Moby](https://img.shields.io/badge/Base-Moby-2496ED?logo=docker&logoColor=white)](https://github.com/moby/moby)

[![Release](https://img.shields.io/badge/release-v2.0.0-blue)](https://github.com/humpback/humpback-agent/releases/tag/v2.0.0)

![Humpback logo](/assets/logo.png)

The service executor of Humpback, which provides container operations and cron execution for Humpback.

## language

- [English](README.md)

- [中文](README.zh.md)

## Feature

- Heartbeat debriefing.

- Container operations。

- Support for cron.

## Getting Started

* [Humpback Guides](https://humpback.github.io/humpback)

## Installing

By default, Humpback Agent will expose a API server over port `8018` for receiving Humpback Server call.

```bash

docker run -d \

  --name=humpback-agent \

  --net=host \

  --restart=always \

  --privileged \

  -v /var/run/docker.sock:/var/run/docker.sock \

  -v /var/lib/docker:/var/lib/docker \

  -e HUMPBACK_SERVER_REGISTER_TOKEN={token} \

  -e HUMPBACK_SERVER_HOST={server-address}:8101 \

  -e HUMPBACK_VOLUMES_ROOT_DIRECTORY=/var/lib/docker \

  humpbacks/humpback-agent

```

Please replace `{server-address}` to the Humbpack Server IP.

## Usage

After the installation is completed, add the current machine IP address to the **Nodes** page, and you can schedule it after the status changes to **Healthy**.

![Nodes](/assets/nodes.png)

## Licence

Humpback Server is licensed under the [Apache Licence 2.0](http://www.apache.org/licenses/LICENSE-2.0.html).