README.md

	Obsei-rest: Rest API interface for Obsei

This is rest api playground on Obsei.

Note this is work in progress test platground hence things may not be updated with latest Obsei changes

Rest interface

Start docker with default configuration file:

docker run -d --name obesi -p 9898:9898 lalitpagaria/obsei-rest:latest

Start docker with custom configuration file (Assuming you have configfile config.yaml at /home/user/obsei/config at host machine):

docker run -d --name obesi -v "/home/user/obsei/config:/home/user/config" -e "OBSEI_CONFIG_PATH=/home/user/config" -e "OBSEI_CONFIG_FILENAME=config.yaml" -p 9898:9898 lalitpagaria/obsei:latest

Start docker locally with docker-compose:

docker-compose up --build

Following environment variables are useful to customize various parameters -

• OBSEI_CONFIG_PATH: Configuration file path (default: ../config)
• OBSEI_CONFIG_FILENAME: Configuration file name (default: rest.yaml)
• OBSEI_NUM_OF_WORKERS: Number of workers for rest API server (default: 1)
• OBSEI_WORKER_TIMEOUT: Worker idle timeout in seconds (default: 180)
• OBSEI_SERVER_PORT: Rest API server port (default: 9898)
• OBSEI_WORKER_TYPE: Gunicorn worker type (default: uvicorn.workers.UvicornWorker)