API Server

Mon, 01 Jan 0001 00:00:00 +0000

Running Server on a Specific Port

By default, the server runs on port 28082. However, you can set the server to run on a specific port:

# ./etc/application.yaml
micronaut:
 server:
 port: 80 # Port used to access APIs

endpoints:
 all:
 port: 80 # Port used to access Health endpoints

Enabling Specific Extension Providers

By default, the server is configured to run only with the core and kafka extension providers. However, you can enable (or disable) additional providers:

CLI Proxy Mode

Mon, 01 Jan 0001 00:00:00 +0000

Configuration

Step 1: Enable Proxy Mode

To enable proxy mode so that the CLI communicates directly with your API Server, add the following parameters to your configuration:

jikkou {
 # Proxy Configuration
 proxy {
 # Specify whether proxy mode is enabled (default: false).
 enabled = true
 # URL of the API Server
 url = "http://localhost:28082"
 # Specifcy whether HTTP request debugging should be enabled (default: false)
 debugging = false
 # The connect timeout in millisecond (if not configured used ` default-timeout` ).
 connect-timeout = 10000
 # The read timeout in millisecond (if not configured used ` default-timeout` ).
 read-timeout = 10000
 # The write timeout in millisecond (if not configured used ` default-timeout` ).
 write-timeout = 10000
 # The default timeout (i.e., for read/connect) in millisecond (default: 10000)
 default-timeout = 10000
 # Security settings to authenticate to the API Server.
 security = {
 # For Token based Authentication.
 # access-token = ""
 # For Username/Password Basic-Authentication.
 # basic-auth = {
 # username = ""
 # password = ""
 # }
 }
 }
}

Step 2: Check connection

When enabling Proxy Mode, Jikkou CLI provides the additional command server-info. You can use it to verify the connectivity with teh server.