User Guide
In order to use Kova, you will need several services running.
Supporting services
- a NATS server (required by all
kova
services) - a database server (required for user authentication)
Note
Running both services on the same machine is fine for development
Installation
Contributing
- clone this repository
make develop
to install all dependenciesdocker compose up -d
to run external services locally
Install nsc
$ brew tap nats-io/nats-tools
$ brew install nats-io/nats-tools/nsc
# to uninstall:
$ brew uninstall nats-io/nats-tools/nsc
$ brew untap nats-io/nats-tools
Configuration
To configurate the Authentication in the kova
service, use the nsc
service at the /new-setup
endpoint
Warning
After creating a NATS Operator, set it up by adding your operator.jwt
on your NATS server in the server.conf
file. An example of this configuration is available on GitHub.
Running the applicative server
Important
There must be a NATS server properly configured and running. If needed, the NATS server access can be changed trough Settings
.
$ python server.py [--creds <credential_file.creds>]
Running a client
Important
There must be an applicative server listening to the same queue in order to process the messages send by the clients.
$ python client.py -s <nats-server> [--creds <credential_file.creds>]
nats-server is the IP address of your NATS server such as nats://localhost:4222
Running the nsc
service
$ python kova/authentication/nsc_api.py
This service is used for user creation and setting up new Operator and Accounts. By default, it serves at http://localhost:4000
.