Documentation for iocaine 3.x
Last updated: 2025-11-14

# Getting Started

The best place to start getting familiar with the latest stable release is the Getting Started guide - it gives you step by step instructions on how to get up and running with iocaine on a typical Linux system. If you’re on Debian, you might be interested in Debian-specific installation instructions. If you’re on NixOS, we have a NixOS guide. And if you’re using containers, there’s a guide for that too!

Once you began your journey, you might be interested in a configuration reference.

# Reverse proxies

`iocaine` is meant to be used together with a reverse proxy, with the proxy in front, and `iocaine` acting as a kind of middleware. How this works in practice, and how to integrate `iocaine` with popular reverse proxies, is documented on the reverse proxy pages.

# Advanced topics

Once you’re comfortably settled into your `iocaine`, and wish to tackle some more advanced topics, one place where you might look is Nam-Shub of Enki, the author’s personal request handler, with a whole lot more features than the built-in handler - but also one that is more complex too.

And if you’re ready to dig deep, read the scripting environment reference, and you can write your own request handler, or have more confidence in modifying the built-in one, or even Nam-Shub of Enki!