bksolutions/holdingnuts repository overview

⁠Holdingnuts Server

HoldingNuts is an open source multi-platform poker server to play the popular Texas Hold'em variant on your own network.

⁠Content

• Getting Started⁠
  • Prerequisities⁠
  • Usage⁠
    • Container Parameters⁠
    • Environment Variables⁠
    • Volumes⁠
    • Useful File Locations⁠
  • Using Podman instead of Docker⁠
  • Compose-File⁠
    • Docker compose⁠
    • Podman compose⁠
• Find Us⁠
• Contributing⁠
• Versioning⁠
• Authors⁠
• License⁠

⁠Getting Started

These instructions will cover usage information and for the docker container

⁠Prerequisities

In order to run this container you'll need docker installed.

• Windows⁠
• OS X⁠
• Linux⁠

⁠Usage

⁠Container Parameters

The image could be started by the following command.

docker run -d bksolutions/holdingnuts

By default the container uses the TCP port 40888 for the HoldingNuts server.

docker run -d -p <port>:40888 bksolutions/holdingnuts

The HoldingNuts server configuration is stored at /root/.holdingnuts/server.cfg.

docker run -d -v <path>:/root/.holdingnuts:ro bksolutions/holdingnuts

⁠Environment Variables

• PORT - The HoldingNuts server uses port 40888 tcp in the standard configuration.

⁠Volumes

• /root/.holdingnuts - Configuration folder

⁠Useful File Locations

• /root/.holdingnuts/server.cfg - HoldingNuts Server configuration file

⁠Using Podman instead of Docker

If using podman Version >=1.9 instead of docker it should be possible to use the auto-update feature with systemd.

First create the container (pod) than run generate command. The systemd service files will be created within the same folder. These .service file(s) should be moved to a systemd folder. If the system uses SELinux the new files must be updated with the correct labels. Then the systemd daemon must reload the service files.

$ podman create --name <container_name> \
 -p [host]:8080 \
 -v [host]:/opt/picapport:Z \
 -l "io.containers.autoupdate=registry" \
 -t bksolutions/holdingnuts:latest

$ podman generate systemd --new --name <container_name> --files
$ mv *.service /usr/lib/systemd/
$ restorecon -Rv /usr/lib/systemd/
$ systemctl daemon-reload

$ systemctl start <service> --now

⁠Compose-File

⁠Docker compose

version: "3.8"
services:
  holdingnuts:
    container_name: holdingnuts
    image: docker.io/bksolutions/holdingnuts:latest
    environment:
      - TZ=Europe/Berlin
    volumes:
      - ${PWD}/hn.conf.d:/root/.holdingnuts:Z

⁠Podman compose

version: "3.8"
services:
  holdingnuts:
    container_name: holdingnuts
    image: docker.io/bksolutions/holdingnuts:latest
    environment:
      - TZ=Europe/Berlin
    volumes:
      - ${PWD}/hn.conf.d:/root/.holdingnuts:Z
    labels:
      - "[email protected]"
      - "io.containers.autoupdate=registry"

⁠Find Us

• GitHub⁠

⁠Contributing

Please read CONTRIBUTING.md⁠ for details on our code of conduct, and the process for submitting pull requests to us.

⁠Versioning

We use SemVer⁠ for versioning. For the versions available, see the tags on this repository⁠.

⁠Authors

• Briezh Khenloo - Project - B.Khenloo⁠

See also the list of contributors⁠ who participated in this project.

⁠License

This project is licensed under the MIT License - see the LICENSE.md⁠ file for details.