3.1. Reverse Proxy general guide

It’s common to put OliveTin behind a reverse proxy, for authentication, customizing the OliveTin address/path, or for a variety of other reasons.

For most users, even under reverse proxy configurations, just proxying port 1337 should be all that is needed. For a more detailed understanding of the different ports that OliveTin uses, and why, see the network ports page.

  • DNS Name based virtual hosts ( olivetin.example.com ) as easier to setup and configure than path based virtual hosts ( www.example.com/utils/OliveTin), because path based virtual hosts need to take care not to mangle OliveTin paths.

  • If using a path based virtual host, you may need to set externalRestAddress manually to something like; http://example.com/utils/OliveTin in the OliveTin config.yaml.

  • DNS Name based reverse proxies should work like this;

    • olivetin.example.com should how the standard webui (port 1337)

    • olivetin.example.com/webUiSettings.json should return a JSON file generated by OliveTin that sets up the web interface. (port 1337)

    • olivetin.example.com/api should how the REST based API. (port 1337)