Update README.md (#130)

* Update documentation + Bump caddy version

* Edit Souin logo rendering in md

plugins/caddy/.github/workflows/ci.yml

@@ -17,7 +17,7 @@ jobs:
         # The Windows build currently fail because of https://github.com/golang/go/issues/40795, and because xcaddy isn't compatible with the known workaround
         #os: [ ubuntu-latest, macos-latest, windows-latest ]
         os: [ ubuntu-latest, macos-latest ]
-        go: [ '1.15' ]
+        go: [ '1.16', '1.17' ]
 
     runs-on: ${{ matrix.os }}
 

plugins/caddy/README.md

@@ -7,14 +7,14 @@ This is a distributed HTTP cache module for Caddy based on [Souin](https://githu
 
  * Supports most HTTP cache headers defined in [RFC 7234](https://httpwg.org/specs/rfc7234.html) (see the TODO section for limitations)
  * Sets [the `Cache-Status` HTTP Response Header](https://httpwg.org/http-extensions/draft-ietf-httpbis-cache-header.html)
- * REST API to be able to purge the cache and list stored keys.
- * Embedded (or not) distributed cache can be used and a non-distributed one is supported too.
+ * REST API to purge the cache and list stored resources.
+ * Builtin support for distributed cache.
 
 
 ## Example Configurations
 
 You can find an example for the [Caddyfile](Caddyfile) or the [JSON file](configuration.json).  
-See the [Souin](https://github.com/darkweak/souin) configuration for the full configuration, and his associated [Caddyfile](https://github.com/darkweak/souin/plugins/caddy/Caddyfile)  
+See the [Souin](https://github.com/darkweak/souin) configuration for the full configuration, and its associated [Caddyfile](https://github.com/darkweak/souin/blob/master/plugins/caddy/Caddyfile)  
 
 
 ## TODO

plugins/caddy/app.go

@@ -1,6 +1,7 @@
-package caddy
+package httpcache
 
 import (
+	"errors"
 	"github.com/caddyserver/caddy/v2"
 	"github.com/darkweak/souin/cache/types"
 	"github.com/darkweak/souin/configurationtypes"
@@ -26,7 +27,7 @@ func (s *SouinApp) Provision(_ caddy.Context) error {
 // Start will start the App
 func (s SouinApp) Start() error {
 	if s.DefaultCache != nil && s.DefaultCache.GetTTL() == 0 {
-		return new(defaultCacheError)
+		return errors.New("Invalid/Incomplete default cache declaration")
 	}
 	return nil
 }

plugins/caddy/configuration.go

@@ -1,4 +1,4 @@
-package caddy
+package httpcache
 
 import (
 	"time"

plugins/caddy/go.mod

@@ -3,7 +3,7 @@ module github.com/darkweak/souin/plugins/caddy
 go 1.16
 
 require (
-	github.com/caddyserver/caddy/v2 v2.4.4
+	github.com/caddyserver/caddy/v2 v2.4.5
 	github.com/darkweak/souin v1.5.5
 	go.uber.org/zap v1.19.0
 )

plugins/caddy/go.sum

@@ -174,10 +174,10 @@ github.com/buraksezer/consistent v0.0.0-20191006190839-693edf70fd72/go.mod h1:OE
 github.com/buraksezer/olric v0.3.11 h1:0WaCMBSGMhmUkFtJc8X2FnNwnXqO7jviYzD7ikZgHSQ=
 github.com/buraksezer/olric v0.3.11/go.mod h1:o0fRJZTHrJJto62IApcdRd5jNkGUomTlouIEL1NGCi4=
 github.com/caarlos0/ctrlc v1.0.0/go.mod h1:CdXpj4rmq0q/1Eb44M9zi2nKB0QraNKuRGYGrrHhcQw=
-github.com/caddyserver/caddy/v2 v2.4.4 h1:QBsN1jXEsCqRpKPBb8ebVnBNgPxwL50HINWWTuZ7evU=
-github.com/caddyserver/caddy/v2 v2.4.4/go.mod h1:cZwYh3+kDWw5v/ePDTyXPeAsC8J+6sROPk3sNFObE/g=
-github.com/caddyserver/certmagic v0.14.4 h1:jlGiMUHOd7p3sgT8zHA/4wckZjIp/6ME2JWGAN5zh5E=
-github.com/caddyserver/certmagic v0.14.4/go.mod h1:/0VQ5og2Jxa5yBQ8eT80wWS7fi/DgNy1uXeXRUJ1Wj0=
+github.com/caddyserver/caddy/v2 v2.4.5 h1:P1mRs6V2cMcagSPn+NWpD+OEYUYLIf6ecOa48cFGeUg=
+github.com/caddyserver/caddy/v2 v2.4.5/go.mod h1:YhfZAAh3jWSbG6rEEOM49FwxmcbLY2fZQVlo59Sc/80=
+github.com/caddyserver/certmagic v0.14.5 h1:y4HcFzLLBMsTv8sSlAPj5K55mvntX8e8ExcmB/lhO6w=
+github.com/caddyserver/certmagic v0.14.5/go.mod h1:/0VQ5og2Jxa5yBQ8eT80wWS7fi/DgNy1uXeXRUJ1Wj0=
 github.com/campoy/unique v0.0.0-20180121183637-88950e537e7e/go.mod h1:9IOqJGCPMSc6E5ydlp5NIonxObaeu/Iub/X03EKPVYo=
 github.com/casbin/casbin/v2 v2.1.2/go.mod h1:YcPU1XXisHhLzuxH9coDNf2FbKpjGlbCg3n9yuLkIJQ=
 github.com/cavaliercoder/go-cpio v0.0.0-20180626203310-925f9528c45e/go.mod h1:oDpT4efm8tSYHXV5tHSdRvBet/b/QzxZ+XyyPehvm3A=

plugins/caddy/main.go → plugins/caddy/httpcache.go

@@ -1,4 +1,4 @@
-package caddy
+package httpcache
 
 import (
 	"bytes"
@@ -145,25 +145,26 @@ func (s *SouinCaddyPlugin) FromApp(app *SouinApp) error {
 			Headers: app.Headers,
 			TTL:     app.TTL,
 		}
-	} else {
-		dc := s.Configuration.DefaultCache
-		appDc := app.DefaultCache
-		if dc.Headers == nil {
-			s.Configuration.DefaultCache.Headers = appDc.Headers
-		}
-		if dc.TTL.Duration == 0 {
-			s.Configuration.DefaultCache.TTL = appDc.TTL
-		}
-		if dc.Olric.URL == "" || dc.Olric.Path == "" || dc.Olric.Configuration == nil {
-			s.Configuration.DefaultCache.Distributed = appDc.Distributed
-			s.Configuration.DefaultCache.Olric = appDc.Olric
-		}
-		if dc.Badger.Path == "" || dc.Badger.Configuration == nil {
-			s.Configuration.DefaultCache.Badger = appDc.Badger
-		}
-		if dc.Regex.Exclude == "" {
-			s.Configuration.DefaultCache.Regex.Exclude = appDc.Regex.Exclude
-		}
+		return nil
+	}
+
+	dc := s.Configuration.DefaultCache
+	appDc := app.DefaultCache
+	if dc.Headers == nil {
+		s.Configuration.DefaultCache.Headers = appDc.Headers
+	}
+	if dc.TTL.Duration == 0 {
+		s.Configuration.DefaultCache.TTL = appDc.TTL
+	}
+	if dc.Olric.URL == "" || dc.Olric.Path == "" || dc.Olric.Configuration == nil {
+		s.Configuration.DefaultCache.Distributed = appDc.Distributed
+		s.Configuration.DefaultCache.Olric = appDc.Olric
+	}
+	if dc.Badger.Path == "" || dc.Badger.Configuration == nil {
+		s.Configuration.DefaultCache.Badger = appDc.Badger
+	}
+	if dc.Regex.Exclude == "" {
+		s.Configuration.DefaultCache.Regex.Exclude = appDc.Regex.Exclude
 	}
 
 	return nil

plugins/traefik/traefik.yml

@@ -9,7 +9,7 @@ api:
   insecure: true
 
 pilot:
-  token: 75223eaf-380a-4c16-840d-2b3ee4a2765a
+  token: 1050f8a0-eb6f-4458-97ae-6d223afbefe6
 
 experimental:
   localPlugins: