Building a native file upload handler for Caddy v2

aleks — Tue, 01 Mar 2022 00:00:00 +0000

When Caddy v2</a> was released in 2020, it introduced a new concept of handlers that use Go’s native module features.

In 2022 one of our customers needed to upload files, and at that time none of the available web servers could handle this natively without an extra program. So I decided to create a new handler for Caddy v2 — caddyv2-upload</a> was born.

I was not aware of any other tool which can handle file uploads natively in just one binary which can be used in Kubernetes or OpenShift, or I have not searched hard enough 😁. I also wanted to learn go, so I decided to create a new handler for the go based webserver caddyserver</a>.

In May 2022 dufs</a>, a Rust-based server, was created — so that might be another option worth considering. 🤷

Any how I wanted to learn go in the pre AI Area and at that time I looked into the docs of go modules, into the source of caddy servers own handlers and created step by step a new handler.

Luckily there was already podman and buildah, so I was able to create container images to run and test locally.

Building something real turned out to be the most effective way to learn Go. Diving into Caddy’s own handler source code, understanding the module system, and iterating with containers made the concepts stick far better than any tutorial would have.

A minimal Caddyfile configuration looks like this:

{</span></span>
    order upload before file_server</span></span>
}</span></span>
</span>
:2015 {</span></span>
    root .</span></span>
</span>
    file_server browse</span></span>
</span>
    @mypost method POST</span></span>
    upload @mypost {</span></span>
        dest_dir /var/uploads</span></span>
        max_filesize 4MB</span></span>
    }</span></span>
}</span></span></code></pre>
Build with xcaddy</a>:</p>
xcaddy</span> build</span> -</span>-with</span> github.com/git001/caddyv2-upload</span></span></code></pre>
Today caddyv2-upload</a> (v0.20.0) supports file uploads via HTTP multipart form, configurable destination directories, UUID-based subdirectory creation per upload, fixed filenames, pass-through mode to continue to the next Caddy handler after upload, configurable file size limits, an HTTP notification callback after successful uploads, and a /health</code> endpoint. It integrates with Caddy’s variable system and works in Kubernetes and OpenShift environments. Authentication is handled by Caddy’s own security layer rather than the module itself.</p>

Alek's Blog - caddy

Building a native file upload handler for Caddy v2