🐋 PtokaX in Docker

This is a Dockerfile to be able to build an image of PtokaX 0.5.3.0 (20th anniversary edition) and to create a container of the image. This README has a tutorial to start with a custom configuration for PtokaX made by me, you have several options to start with this image:

1. You can follow my tutorial to have a solid base to start and later change the settings with your own values.
2. You can inject your current config if you have it to the new version of PtokaX.
3. If you prefer you can start without config and let PtokaX create it for you.

📦 Dependencies

• Docker

ℹ️ Information

• There's a default user created to be able to operate with the hub: User -> main | Password -> main123, when not needed anymore because we've created at least one master user, we can delete it with a chat command.
• PtokaX logs are stored on logs directory, this will be bound when creating the container and this gave us the possibility to watch logs from the host machine.
• All PtokaX configuration are under config directory, this will be bound when creating the container, this give us some advantages:
  1. We have the settings available to watch and change from the host machine.
  2. We don't lose settings when container is deleted/re-created.
• Settings has been prepared to host a private PtokaX Direct Connect Hub, if we want to make it public, we have to change the Settings.pxt file.

⚠️ Important

• If we want to change any setting from the .pxt, .pxb files, we must stop the container first. Because all manually changed settings or using PtokaX CLI tool, when container and PtokaX main process is running are not applied on the fly and the most important, when PtokaX service or container stops the changes are overriden with the in memory values of the main process of PtokaX.

⛏️ HOW-TO: Clone the repository

Clone the repo using git with https

git clone https://github.com/ruben69695/ptokax-dockerfile.git

⛏️ HOW-TO: Build and start the container

1. Build image from dockerfile

docker build -t ptokax:latest .

2. Create the container based on the image.

Be sure to replace the src param with your host path to the cloned repository on your machine

docker create --name ptokax \
        -p 54400:411 \
        --mount type=bind,src=/home/rubenarrebola/Development/ptokax/config,target=/src/cfg \
        --mount type=bind,src=/home/rubenarrebola/Development/ptokax/logs,target=/src/logs \
        ptokax:latest

3. Start the created container

docker start ptokax

4. If we have to connect to the container shell, we can do it like this

docker exec -it ptokax bash

⛏️ HOW-TO: Connect to the DC Hub

• Default user: main
• Default pass: main123

Screenshots for connecting to hub

• We can use the airdc++, or we can use the eiskaltdc++

⛏️ HOW-TO: See available commands

• In the hub chat, we can see a list of available commands for our user sending the message (command) !help

!help

Screenshots for help

⛏️ HOW-TO: create a user

• Before create a new user we have to understand the available profiles for the user, this declares what the user can do in the hub. The available profiles are: master | operator | vip | reg

• In the hub chat, with our main user (profile: master), we can create users directly from the chat. As we saw the !help command displays a list of commands, and the command to create new users is the next one: !addreguser. So if we want to give access to a friend, we can create a new user for him/her in the hub. Example:

!addreguser <nick> <password> <profilename>

!addreguser ruben ruben123 reg

📦 Container registry

The image is also available directly in the next container registries and ready to go.

• GitHub
• DockerHub

💻 Environment

• Fedora 37
• Codium 1.74