Fuxedo logoFuxedo

From zero to a running service in five minutes

Quickstart

The fastest honest path: build from source (a few minutes on any modern Linux), boot a domain, place a call. No database, no container, no license key.

1. Build and install.

sudo apt-get install -y build-essential autoconf automake \
                         libtool pkg-config libssl-dev  # Debian/Ubuntu names
git clone https://github.com/fuxedo/fuxedo.git
cd fuxedo
./autogen.sh
./configure --prefix="$HOME/fux"
make -j"$(nproc)"
make install

2. Point the environment at it.

export TUXDIR="$HOME/fux"
export PATH="$TUXDIR/bin:$PATH"
export LD_LIBRARY_PATH="$TUXDIR/lib:${LD_LIBRARY_PATH:-}"

3. A minimal UBBCONFIG. Save as ubb, using your hostname (uname -n) and a scratch directory:

*RESOURCES
IPCKEY 123456
MASTER fuxapp
MODEL SHM

*MACHINES
"myhost" LMID=fuxapp APPDIR="/tmp/fuxdemo" \
        TUXCONFIG="/tmp/fuxdemo/tuxconfig" TUXDIR="$HOME/fux"

*GROUPS
G1 LMID=fuxapp GRPNO=1

*SERVERS
"reply.py" SRVGRP=G1 SRVID=1

*SERVICES
REPLY
mkdir -p /tmp/fuxdemo && cd /tmp/fuxdemo

4. The server, reply.py (executable, shebang required). Install the bindings from PyPI (they build against whichever Tuxedo TUXDIR points at):

pip install pybind11 setuptools wheel
TUXDIR="$HOME/fux" pip install --no-build-isolation tuxedo
#!/usr/bin/env python3
import sys
import tuxedo as t

class Server:
    def tpsvrinit(self, args):
        t.tpadvertise('REPLY')
        return 0
    def REPLY(self, args):
        return t.tpreturn(t.TPSUCCESS, 0, args)

if __name__ == '__main__':
    t.run(Server(), sys.argv)
chmod +x reply.py
tmloadcf -y ubb
tmboot -y

5. Place the call.

python3 -c 'import tuxedo as t; t.tpinit(None); \
  print(t.tpcall("REPLY", {"HELLO": "world"}).data)'

That is the whole shape of the system: a text configuration loaded into a binary TUXCONFIG, servers booted into groups, services advertised into the bulletin board, calls routed over System V queues. From here the tuxedo-python bindings, the demo and test suites, and the training take it to production depth.