ruben69695/ptokax repository overview

⁠🐋 PtokaX in Docker

This is a Docker image to be able to deploy easily PtokaX 0.5.3.0 (20th anniversary edition) into a container. You can follow the next steps in the README to have a private DC Hub, with default configuration, or use this image by yourself with your own configuration.

⁠📦Github Repository

• Here you have the repository⁠ if you want to build the image from scratch using the Dockerfile, contribute or if you want something else.

⁠ℹ️ 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: Create directories structure with the default config for PtokaX

mkdir $HOME/ptokax
cd $HOME/ptokax
wget https://github.com/ruben69695/ptokax-dockerfile/releases/download/v.0.5.3/ptokax-default.tar.gz
tar -xf ptokax-default.tar.gz

⁠⛏️ HOW-TO: Create the container including the bind mounts to inject the settings for PtokaX

docker create --name ptokax \
        -p 54400:411 \
        --mount type=bind,src=$HOME/ptokax/config,target=/src/cfg \
        --mount type=bind,src=$HOME/ptokax/logs,target=/src/logs \
        ruben69695/ptokax:0.5.3

1. Start the created container

docker start ptokax

1. 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

⁠⛏️ 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

⁠⛏️ 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 want a friend to access our hub, we can create a new user for him/her. Example:

!addreguser <nick> <password> <profilename>

!addreguser ruben ruben123 reg

⁠💻 Environment

• Fedora 37
• Codium 1.74