Tutorial Setup

Setup for CORE

We assume the prior installation of CORE, using a virtual environment.

# location of all core files
/opt/core

# location of the virtual environment
/opt/core/venv

# convenience command for using core's python virtual environment
core-python

Setup for Chat App

There is a simple TCP chat app provided as example software to use and run within the tutorials provided.

Installation

The following will install chatapp and its scripts into /usr/local, which you may need to add to PATH within node to be able to use command directly.

cd /opt/core/share/tutorials/chatapp
sudo python3 -m pip install .

Note

Some Linux distros will not have /usr/local in their PATH and you will need to compensate.

export PATH=$PATH:/usr/local

Running the Server

The server will print and log connected clients and their messages.

usage: chatapp-server [-h] [-a ADDRESS] [-p PORT]

chat app server

optional arguments:
  -h, --help            show this help message and exit
  -a ADDRESS, --address ADDRESS
                        address to listen on (default: )
  -p PORT, --port PORT  port to listen on (default: 9001)

Running the Client

The client will print and log messages from other clients and their join/leave status.

usage: chatapp-client [-h] -a ADDRESS [-p PORT]

chat app client

optional arguments:
  -h, --help            show this help message and exit
  -a ADDRESS, --address ADDRESS
                        address to listen on (default: None)
  -p PORT, --port PORT  port to listen on (default: 9001)

Installing the Chat App Service

You will first need to edit /opt/core/etc/core.conf to update the custom service path to pick up your service
```
custom_services_dir = <path for service>
```
Then you will need to copy/move /opt/core/share/tutorials/chatapp/chatapp_service.py to the directory configured above
Then you will need to restart the core-daemon to pick up this new service
Now the service will be an available option under the group ChatApp with the name ChatApp Server