Skip to content

Client setup and use

Tim Hardcastle edited this page Feb 29, 2024 · 8 revisions

The client

To talk to Pipefish in its role as a server, I have supplied a little desktop client called HubTalk. Build it using go build in the root folder, like you built Pipefish, and then run the executable with ./hubtalk.

 ╔═══════════♥═══════════╗
 ║  HubTalk version 0.1  ║
 ╚═══════════♥═══════════╝
ht → 

At this point until you connect to a hub there are only two available commands, ht quit, which does exactly what you think it does, and ht config which sets up the connection to the hub:

ht → ht config
Host: http://localhost:3333/foo
Username: tihardc
Password: ▪▪▪▪▪▪▪▪▪
ok
ht → 

Hub commands

The end-users of an administered hub have only a few ways to interact with it. Obviously they aren't allowed to start and stop services, which is reserved for the admins. But they can register and log in and out of the hub. Here are the extra hub commands they have access to.

hub register

This will make the hub ask them for their details (name, username, email etc) to set up an account. They are then put in the Guest group.

hub log on and hub log off

These are used by registered users to log on and off.

hub groups

Lists the groups of which the user is a member.

hub services

Lists the services to which the user has access.

hub unregister

Deletes the user's account.

Clone this wiki locally