Gateway Configuration

Gateway uses a conf.yaml file as the configuration API. At the moment there is no documentation on that configuration file, however luckily most fields are self-explanatory. Using it you may alter the behaviour of the Gateway, for instance by changing the port it will listen on or allowing additional IP addresses to communicate from.

IBeam allows you to provide your own configuration file using the Inputs Directory. Note that IBeam will use the conf.yaml file provided to overwrite the existing conf.yaml in the root subdirectory of Gateway, specified in the IBEAM_GATEWAY_DIR environment variable.

If using IBeam in standalone mode, you may edit the conf.yaml file directly in the Gateway's root folder.

---

Default conf.yaml used by IBeam is a slightly modified version of the file that is originally distributed with the Gateway. The additions facilitate using the Gateway in a Docker container. If you provide IBeam with a custom conf.yaml it is recommended you use the following file as the starting point:

ip2loc: "US"
proxyRemoteSsl: true
proxyRemoteHost: "https://api.ibkr.com"
listenPort: 5000
listenSsl: true
svcEnvironment: "v1"
sslCert: "vertx.jks"
sslPwd: "mywebapi"
authDelay: 3000
portalBaseURL: ""
serverOptions:
    blockedThreadCheckInterval: 1000000
    eventLoopPoolSize: 20
    workerPoolSize: 20
    maxWorkerExecuteTime: 100
    internalBlockingPoolSize: 20
cors:
    origin.allowed: "*"
    allowCredentials: false
webApps:
    - name: "demo"
      index: "index.html"
ips:
  allow:
    - 192.*
    - 131.216.*
    - 127.0.0.1
    - 0.0.0.0
    - 172.17.0.*
  deny:
    - 212.90.324.10

---

Next

Learn about TLS Certificates and HTTPS or Two-Factor Authentication