From ef3445b04c2371759399a72718532e8cdc026d7e Mon Sep 17 00:00:00 2001 From: darkweak Date: Tue, 16 Jul 2024 10:16:28 +0200 Subject: [PATCH] fix(documentation): write README and lint Caddyfiles + fix Makefiles --- .github/workflows/static.yml | 17 +++++++++-------- README.md | 10 ++++++++++ badger/caddy/Caddyfile | 2 +- etcd/caddy/Caddyfile | 2 +- go-redis/caddy/Caddyfile | 2 +- go-redis/caddy/Makefile | 4 ++-- nats/caddy/Caddyfile | 2 +- nats/caddy/Makefile | 2 +- nuts/caddy/Caddyfile | 2 +- olric/caddy/Caddyfile | 2 +- otter/caddy/Caddyfile | 2 +- redis/caddy/Caddyfile | 2 +- 12 files changed, 30 insertions(+), 19 deletions(-) diff --git a/.github/workflows/static.yml b/.github/workflows/static.yml index 237fe0b..e10927e 100644 --- a/.github/workflows/static.yml +++ b/.github/workflows/static.yml @@ -10,13 +10,14 @@ env: jobs: static-validation: services: - nats: - image: nats - command: -js - ports: - - 4222:4222 - - 6222:6222 - - 8222:8222 + # nats: + # image: nats + # volumes: + # - ${{ github.workspace }}/.github/workflows/nats.conf:/etc/nats/nats-server.conf + # ports: + # - 4222:4222 + # - 6222:6222 + # - 8222:8222 redis: image: redis ports: @@ -43,7 +44,7 @@ jobs: - core - etcd - go-redis - - nats + # - nats - nuts - otter - redis diff --git a/README.md b/README.md index 826c4ea..bad9cf9 100644 --- a/README.md +++ b/README.md @@ -3,3 +3,13 @@ This repository contains all supported storages by the HTTP cache [Souin](https://github.com/darkweak/souin). Each storages are available as caddy module and can be used with the HTTP cache module. Using caddy, you can build your instance using the following template `xcaddy build --with github.com/darkweak/storages/{your_storage}/caddy`. + +## Supported storages +* [Badger](https://github.com/dgraph-io/badger) +* [Etcd](https://github.com/etcd-io/etcd) +* [Go-redis](https://github.com/redis/go-redis) +* [Nats](https://github.com/nats-io/nats-server) +* [Nuts](https://github.com/nutsdb/nutsdb) +* [Olric](https://github.com/buraksezer/olric) +* [Otter](https://github.com/maypok86/otter) +* [Redis](https://github.com/redis/rueidis) diff --git a/badger/caddy/Caddyfile b/badger/caddy/Caddyfile index f9cfcf9..36700d9 100644 --- a/badger/caddy/Caddyfile +++ b/badger/caddy/Caddyfile @@ -17,4 +17,4 @@ http://localhost { } } } -} \ No newline at end of file +} diff --git a/etcd/caddy/Caddyfile b/etcd/caddy/Caddyfile index c174310..9a9d384 100644 --- a/etcd/caddy/Caddyfile +++ b/etcd/caddy/Caddyfile @@ -17,4 +17,4 @@ http://localhost { } } } -} \ No newline at end of file +} diff --git a/go-redis/caddy/Caddyfile b/go-redis/caddy/Caddyfile index 574202a..a883eb1 100644 --- a/go-redis/caddy/Caddyfile +++ b/go-redis/caddy/Caddyfile @@ -17,4 +17,4 @@ http://localhost { } } } -} \ No newline at end of file +} diff --git a/go-redis/caddy/Makefile b/go-redis/caddy/Makefile index df6ca8d..13e1607 100644 --- a/go-redis/caddy/Makefile +++ b/go-redis/caddy/Makefile @@ -3,5 +3,5 @@ build: go mod tidy go mod download - XCADDY_RACE_DETECTOR=1 XCADDY_DEBUG=1 xcaddy build --with github.com/darkweak/storages/core=../../core/ --with github.com/darkweak/storages/redis=../ --with github.com/darkweak/storages/redis/caddy=./ - ./caddy run \ No newline at end of file + XCADDY_RACE_DETECTOR=1 XCADDY_DEBUG=1 xcaddy build --with github.com/darkweak/storages/core=../../core/ --with github.com/darkweak/storages/go-redis=../ --with github.com/darkweak/storages/go-redis/caddy=./ + ./caddy run diff --git a/nats/caddy/Caddyfile b/nats/caddy/Caddyfile index 3d8c1f3..deabb75 100644 --- a/nats/caddy/Caddyfile +++ b/nats/caddy/Caddyfile @@ -17,4 +17,4 @@ http://localhost { } } } -} \ No newline at end of file +} diff --git a/nats/caddy/Makefile b/nats/caddy/Makefile index a373139..53c2570 100644 --- a/nats/caddy/Makefile +++ b/nats/caddy/Makefile @@ -3,5 +3,5 @@ build: go mod tidy go mod download - XCADDY_RACE_DETECTOR=1 XCADDY_DEBUG=1 xcaddy build --with github.com/darkweak/storages/core=../../core/ --with github.com/darkweak/storages/otter=../ --with github.com/darkweak/storages/otter/caddy=./ + XCADDY_RACE_DETECTOR=1 XCADDY_DEBUG=1 xcaddy build --with github.com/darkweak/storages/core=../../core/ --with github.com/darkweak/storages/nats=../ --with github.com/darkweak/storages/nats/caddy=./ ./caddy run \ No newline at end of file diff --git a/nuts/caddy/Caddyfile b/nuts/caddy/Caddyfile index d8dc490..a3b03de 100644 --- a/nuts/caddy/Caddyfile +++ b/nuts/caddy/Caddyfile @@ -17,4 +17,4 @@ http://localhost { } } } -} \ No newline at end of file +} diff --git a/olric/caddy/Caddyfile b/olric/caddy/Caddyfile index 9536963..7713095 100644 --- a/olric/caddy/Caddyfile +++ b/olric/caddy/Caddyfile @@ -15,4 +15,4 @@ http://localhost { olric } } -} \ No newline at end of file +} diff --git a/otter/caddy/Caddyfile b/otter/caddy/Caddyfile index 3d87705..95317d4 100644 --- a/otter/caddy/Caddyfile +++ b/otter/caddy/Caddyfile @@ -17,4 +17,4 @@ http://localhost { } } } -} \ No newline at end of file +} diff --git a/redis/caddy/Caddyfile b/redis/caddy/Caddyfile index 574202a..a883eb1 100644 --- a/redis/caddy/Caddyfile +++ b/redis/caddy/Caddyfile @@ -17,4 +17,4 @@ http://localhost { } } } -} \ No newline at end of file +}