Skip to content
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
vendor/
goStatic
.DS_Store
43 changes: 35 additions & 8 deletions customHeaders.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"net/http"
"os"
"path/filepath"
"regexp"
"strings"
)

Expand All @@ -17,9 +18,22 @@ type HeaderConfigArray struct {

// HeaderConfig is a single header rule specification
type HeaderConfig struct {
Regex string `json:"regex"`
Path string `json:"path"`
FileExtension string `json:"fileExtension"`
Headers []HeaderDefiniton `json:"headers"`

CompiledRegex *regexp.Regexp
}

func (config *HeaderConfig) Init() {
if len(config.Regex) > 0 {
config.CompiledRegex = regexp.MustCompile(config.Regex)
}
}

func (config *HeaderConfig) UsesRegex() bool {
return config.CompiledRegex != nil
}

// HeaderDefiniton is a key value pair of a specified header rule
Expand All @@ -28,7 +42,7 @@ type HeaderDefiniton struct {
Value string `json:"value"`
}

var headerConfigs HeaderConfigArray
var headerConfigs *HeaderConfigArray

func fileExists(filename string) bool {
info, err := os.Stat(filename)
Expand All @@ -38,9 +52,13 @@ func fileExists(filename string) bool {
return !info.IsDir()
}

func logHeaderConfig(config HeaderConfig) {
fmt.Println("Path: " + config.Path)
fmt.Println("FileExtension: " + config.FileExtension)
func logHeaderConfig(config *HeaderConfig) {
if config.UsesRegex() {
fmt.Println("Regex: " + config.Regex)
} else {
fmt.Println("Path: " + config.Path)
fmt.Println("FileExtension: " + config.FileExtension)
}

for j := 0; j < len(config.Headers); j++ {
headerRule := config.Headers[j]
Expand Down Expand Up @@ -69,7 +87,8 @@ func initHeaderConfig(headerConfigPath string) bool {
fmt.Println("------------------------------")

for i := 0; i < len(headerConfigs.Configs); i++ {
configEntry := headerConfigs.Configs[i]
configEntry := &headerConfigs.Configs[i]
configEntry.Init()
logHeaderConfig(configEntry)
}
} else {
Expand All @@ -89,11 +108,19 @@ func customHeadersMiddleware(next http.Handler) http.Handler {

for i := 0; i < len(headerConfigs.Configs); i++ {
configEntry := headerConfigs.Configs[i]
var matches bool

fileMatch := configEntry.FileExtension == "*" || reqFileExtension == "."+configEntry.FileExtension
pathMatch := configEntry.Path == "*" || strings.HasPrefix(r.URL.Path, configEntry.Path)
if configEntry.UsesRegex() {
matches = configEntry.CompiledRegex.MatchString(r.URL.Path)
} else {
matches =
// Check if the file extension matches.
(configEntry.FileExtension == "*" || reqFileExtension == "."+configEntry.FileExtension) &&
// Check if the path matches.
(configEntry.Path == "*" || strings.HasPrefix(r.URL.Path, configEntry.Path))
}

if fileMatch && pathMatch {
if matches {
for j := 0; j < len(configEntry.Headers); j++ {
headerEntry := configEntry.Headers[j]
w.Header().Set(headerEntry.Key, headerEntry.Value)
Expand Down
39 changes: 38 additions & 1 deletion docs/header-config.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,44 @@ With the header config, you can specify custom [HTTP Header](https://developer.m

## Config

You have to create a JSON file that serves as a config. The JSON must contain a `configs` array. For every entry, you can specify a certain path that must be matched as well as a file extension. You can use the `*` symbol to use the config entry for any path or filename. Note that the path option only matches the requested path from the start. Thatswhy you have to start with a `/` and can use paths like `/files/static/css`. The `headers` array includes a key-value pair of the actual header rule. The headers are not parsed so double check your spelling and test your site.
You have to create a JSON file that serves as a config. The JSON must contain a `configs` array. For every entry, you can specify the rule in one of two ways:

1. A regular expression that the path must meet, e.g.:

```json
{
"regex": "/$",
"headers": [
{
"key": "cache-control",
"value": "no-cache, no-store, must-revalidate"
}
]
}
```

This rule would match any path ending in `/` which is useful if you never want to cache the `index.html` that a directory leads to.

2. You may specify a combination of `path` and `fileExtension`:

```json
{
"path": "*",
"fileExtension": "html",
"headers": [
{
"key": "cache-control",
"value": "public, max-age=0, must-revalidate"
},
{
"key": "Strict-Transport-Security",
"value": "max-age=31536000; includeSubDomains;"
}
]
}
```

You can use the `*` symbol to use the config entry for any path or filename. Note that the path option only matches the requested path from the start. That's why you have to start with a `/` and can use paths like `/files/static/css`. The `headers` array includes a key-value pair of the actual header rule. The headers are not parsed so double check your spelling and test your site.

The created JSON config has to be mounted into the container via a volume into `/config/headerConfig.json` per default. When this file does not exist inside the container, the header middleware will not be active.

Expand Down