Pubkeeper Python Server

The Pubkeeper server will handle and manage all client brewers and patrons. The server is where the logic exists within the Pubkeeper ecosystem to determine how different clients will communicate with each other when multiple protocols are available for use.

The server handles client authentication with tokens. Once you have the source of the Pubkeeper server installed within your Python environment, you should create your pubkeeper.conf file and then launch the server using the pk_server executable that was installed with the library.

Run the Server

pk_server [-i] [-c /path/to/config]

• -i : run server in insecure mode
• -c : path to pubkeeper configuration file, defaults to pubkeeper.conf in the current directory

Configuration (pubkeeper.conf)

The server's configuration is specified in an INI file. Default name is pubkeeper.conf.

Sample configuration file

[pubkeeper_server]

# Bind the server to the lo0 interface on port 9898
interface = lo0
port = 9898

# Bind to a specific server IP address. Not used with the interface option
#ip_address = x.x.x.x

# Heartbeat timer for WebSocket connections
#websocket_ping_interval = 10

# If provided, will enable SSL
#server_cert     = /path/to/cert.pem
#server_key      = /path/to/key.pem

[auth]
provider = pubkeeper.server.core.auth.internal.InternalAuthProvider
token = supersecrettoken

Show Status

MacOS

SIGINFO (ctrl + t) will show the currently subscribed brewers and patrons.

Linux

Sending the server process a SIGUSR1(kill -SIGUSR1 <pid>).