Skip to content

gsquarediv/peacock-docker

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

104 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Peacock‑Docker

GitHub Workflow Status License: AGPL v3

Container image of the Peacock server replacement for HITMAN: World of Assassination.

Note

This repository does not contain the Peacock source code and is not affiliated with Peacock in any way. This repository is a simple wrapper that only packages the official release from the upstream repository (thepeacockproject/Peacock) into a production‑ready container image.


🚀 Quick start

# Pull the latest image
docker pull ghcr.io/gsquarediv/peacock-docker:latest

# Run it – expose port 3000 and persist data
docker run \
  -d \
  -p 3000:3000 \
  -v userdata:/peacock/userdata \
  -v contractSessions:/peacock/contractSessions \
  -v contracts:/peacock/contracts \
  -v plugins:/peacock/plugins \
  -v options:/peacock/options \
  ghcr.io/gsquarediv/peacock-docker:latest

Tip – If you prefer Docker‑Compose:

docker compose up -d

📦 Features

Feature Description
Zero‑touch installation Pull a pre‑built image – no Node.js or Yarn setup needed.
Offline capable Starting with v8.7.0, all offline assets are baked in to the image. There's no need to run chunk0.js tools to download the image pack.
Multi‑architecture Built for x86_64 & ARM64.
Automatic releases GitHub Actions checks for upstream Peacock releases nightly and publishes a new container image as needed.
Data persistence User data & contract sessions are stored in Docker named volumes.
Self‑contained All dependencies (Node.js and Peacock binaries) are baked in.
AGPL‑3.0 The image respects the upstream license.

📚 How it works

  1. Containerfile: Installs curl, unzip, node, downloads the latest Peacock release, unpacks it, and exposes the required port.
  2. docker-compose.yml: Exposes five named volumes (userdata, contractSessions, contracts, plugins, & options) so data survives container removal.
  3. GitHub Actions:
    • docker-publish.yml checks the latest Peacock tag.
    • If a new tag appears, a new Docker image is built & pushed to GitHub Container Registry (ghcr.io).
    • The image is signed with cosign for provenance.

📄 License

This project is distributed under the AGPL‑3.0 license. See the LICENSE file for details.

⚠️ The image contains the Peacock binary, which is itself licensed under AGPL‑3.0.


👤 Acknowledgements

About

Container image of the Peacock server replacement for HITMAN: World of Assassination.

Topics

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors