From db4293cb5fce33b467b50ef77698f69a4a066215 Mon Sep 17 00:00:00 2001
From: Matthew Holt <mholt@users.noreply.github.com>
Date: Wed, 27 Nov 2019 11:51:32 -0700
Subject: reverse_proxy: Add flush_interval to caddyfile syntax (#1460)

Also add godoc for Caddyfile syntax for file_server
---
 modules/caddyhttp/fileserver/caddyfile.go | 10 ++++++++++
 1 file changed, 10 insertions(+)

(limited to 'modules/caddyhttp/fileserver/caddyfile.go')

diff --git a/modules/caddyhttp/fileserver/caddyfile.go b/modules/caddyhttp/fileserver/caddyfile.go
index 06540bc..46bc5b7 100644
--- a/modules/caddyhttp/fileserver/caddyfile.go
+++ b/modules/caddyhttp/fileserver/caddyfile.go
@@ -27,6 +27,16 @@ func init() {
 	httpcaddyfile.RegisterDirective("try_files", parseTryFiles)
 }
 
+// parseCaddyfile parses the file_server directive. It enables the static file
+// server and configures it with this syntax:
+//
+//    file_server [<matcher>] [browse] {
+//        root   <path>
+//	      hide   <files...>
+//	      index  <files...>
+//	      browse [<template_file>]
+//    }
+//
 func parseCaddyfile(h httpcaddyfile.Helper) (caddyhttp.MiddlewareHandler, error) {
 	var fsrv FileServer
 
-- 
cgit v1.2.3