Skip to content

Commit d625b09

Browse files
zc-devsdekobon
zc-devs
authored and
dekobon
committed
Cache configuration via ENV
- made cache config as template - added ENV variables
1 parent 10c3415 commit d625b09

File tree

9 files changed

+30
-14
lines changed

9 files changed

+30
-14
lines changed

‎Dockerfile.buildkit.plus‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,8 @@ ENV NGINX_VERSION 1.23.4
55
ENV NJS_VERSION 29+0.7.12-1
66
ENV XSLT_VERSION 29-1
77

8-
ENV PROXY_CACHE_VALID_OK "1h"
9-
ENV PROXY_CACHE_VALID_NOTFOUND "1m"
10-
ENV PROXY_CACHE_VALID_FORBIDDEN "30s"
11-
8+
ENV PROXY_CACHE_MAX_SIZE "10g"
9+
ENV PROXY_CACHE_INACTIVE "60m"
1210
ENV PROXY_CACHE_VALID_OK "1h"
1311
ENV PROXY_CACHE_VALID_NOTFOUND "1m"
1412
ENV PROXY_CACHE_VALID_FORBIDDEN "30s"

‎Dockerfile.oss‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ FROM nginx:1.24.0
33
ENV NGINX_VERSION "1.24.0"
44
ENV NJS_VERSION 0.7.12
55

6+
ENV PROXY_CACHE_MAX_SIZE "10g"
7+
ENV PROXY_CACHE_INACTIVE "60m"
68
ENV PROXY_CACHE_VALID_OK "1h"
79
ENV PROXY_CACHE_VALID_NOTFOUND "1m"
810
ENV PROXY_CACHE_VALID_FORBIDDEN "30s"

‎Dockerfile.plus‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,9 @@ ENV NGINX_PLUS_VERSION 29-1
44
ENV NGINX_VERSION 1.23.4
55
ENV NJS_VERSION 29+0.7.12-1
66
ENV XSLT_VERSION 29-1
7-
7+
8+
ENV PROXY_CACHE_MAX_SIZE "10g"
9+
ENV PROXY_CACHE_INACTIVE "60m"
810
ENV PROXY_CACHE_VALID_OK "1h"
911
ENV PROXY_CACHE_VALID_NOTFOUND "1m"
1012
ENV PROXY_CACHE_VALID_FORBIDDEN "30s"

‎common/etc/nginx/nginx.conf‎

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ env S3_STYLE;
2323
env ALLOW_DIRECTORY_LIST;
2424
env PROVIDE_INDEX_PAGE;
2525
env APPEND_SLASH_FOR_POSSIBLE_DIRECTORY;
26+
env PROXY_CACHE_MAX_SIZE;
27+
env PROXY_CACHE_INACTIVE;
2628
env PROXY_CACHE_VALID_OK;
2729
env PROXY_CACHE_VALID_NOTFOUND;
2830
env PROXY_CACHE_VALID_FORBIDDEN;
@@ -50,13 +52,5 @@ http {
5052

5153
#gzip on;
5254

53-
# Settings for S3 cache
54-
proxy_cache_path /var/cache/nginx/s3_proxy
55-
levels=1:2
56-
keys_zone=s3_cache:10m
57-
max_size=10g
58-
inactive=60m
59-
use_temp_path=off;
60-
6155
include /etc/nginx/conf.d/*.conf;
6256
}

‎common/etc/nginx/templates/cache.conf.template‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
# Settings for S3 cache
2+
3+
proxy_cache_path /var/cache/nginx/s3_proxy
4+
levels=1:2
5+
keys_zone=s3_cache:10m
6+
max_size=$PROXY_CACHE_MAX_SIZE
7+
inactive=$PROXY_CACHE_INACTIVE
8+
use_temp_path=off;

‎docs/getting_started.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ running as a Container or as a Systemd service.
1919
| `AWS_SIGS_VERSION` | Yes | 2, 4 | | AWS Signatures API version |
2020
| `AWS_ACCESS_KEY_ID` | Yes | | | Access key |
2121
| `AWS_SECRET_ACCESS_KEY` | Yes | | | Secret access key |
22-
| `AWS_SESSION_TOKEN` | No | | | Session token. |
22+
| `AWS_SESSION_TOKEN` | No | | | Session token. |
2323
| `S3_BUCKET_NAME` | Yes | | | Name of S3 bucket to proxy requests to |
2424
| `S3_REGION` | Yes | | | Region associated with API |
2525
| `S3_SERVER_PORT` | Yes | | | SSL/TLS port to connect to |
@@ -29,6 +29,8 @@ running as a Container or as a Systemd service.
2929
| `DEBUG` | No | `true`, `false` | `false` | Flag enabling AWS signatures debug output |
3030
| `APPEND_SLASH_FOR_POSSIBLE_DIRECTORY` | No | `true`, `false` | `false` | Flag enabling the return a 302 with a `/` appended to the path. This is independent of the behavior selected in `ALLOW_DIRECTORY_LIST` or `PROVIDE_INDEX_PAGE`. |
3131
| `DNS_RESOLVERS` | No | | | DNS resolvers (separated by single spaces) to configure NGINX with |
32+
| `PROXY_CACHE_MAX_SIZE` | No | | | Limits cache size |
33+
| `PROXY_CACHE_INACTIVE` | No | | | Cached data that are not accessed during the time specified by the parameter get removed from the cache regardless of their freshness |
3234
| `PROXY_CACHE_VALID_OK` | No | | | Sets caching time for response code 200 and 302 |
3335
| `PROXY_CACHE_VALID_NOTFOUND` | No | | | Sets caching time for response code 404 |
3436
| `PROXY_CACHE_VALID_FORBIDDEN` | No | | | Sets caching time for response code 403 |

‎settings.example‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ AWS_SIGS_VERSION=4
1212
ALLOW_DIRECTORY_LIST=false
1313
PROVIDE_INDEX_PAGE=false
1414
APPEND_SLASH_FOR_POSSIBLE_DIRECTORY=false
15+
PROXY_CACHE_MAX_SIZE=10g
16+
PROXY_CACHE_INACTIVE=60m
1517
PROXY_CACHE_VALID_OK=1h
1618
PROXY_CACHE_VALID_NOTFOUND=1m
1719
PROXY_CACHE_VALID_FORBIDDEN=30s

‎standalone_ubuntu_oss_install.sh‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,8 @@ echo "Addressing Style: ${S3_STYLE}"
8585
echo "AWS Signatures Version: v${AWS_SIGS_VERSION}"
8686
echo "DNS Resolvers: ${DNS_RESOLVERS}"
8787
echo "Directory Listing Enabled: ${ALLOW_DIRECTORY_LIST}"
88+
echo "Cache size limit: ${PROXY_CACHE_MAX_SIZE}"
89+
echo "Cache inactive timeout: ${PROXY_CACHE_INACTIVE}"
8890
echo "Proxy Caching Time for Valid Response: ${PROXY_CACHE_VALID_OK}"
8991
echo "Proxy Caching Time for Not Found Response: ${PROXY_CACHE_VALID_NOTFOUND}"
9092
echo "Proxy Caching Time for Forbidden Response: ${PROXY_CACHE_VALID_FORBIDDEN}"
@@ -149,6 +151,10 @@ S3_SERVER=${S3_SERVER}
149151
S3_STYLE=${S3_STYLE}
150152
# Flag (true/false) enabling AWS signatures debug output (default: false)
151153
DEBUG=${DEBUG}
154+
# Cache size limit
155+
PROXY_CACHE_MAX_SIZE=${PROXY_CACHE_MAX_SIZE}
156+
# Cached data that are not accessed during the time get removed
157+
PROXY_CACHE_INACTIVE=${PROXY_CACHE_INACTIVE}
152158
# Proxy caching time for response code 200 and 302
153159
PROXY_CACHE_VALID_OK=${PROXY_CACHE_VALID_OK}
154160
# Proxy caching time for response code 404

‎test/docker-compose.yaml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,8 @@ services:
2828
APPEND_SLASH_FOR_POSSIBLE_DIRECTORY:
2929
AWS_SIGS_VERSION:
3030
STATIC_SITE_HOSTING:
31+
PROXY_CACHE_MAX_SIZE: "10g"
32+
PROXY_CACHE_INACTIVE: "60m"
3133
PROXY_CACHE_VALID_OK: "1h"
3234
PROXY_CACHE_VALID_NOTFOUND: "1m"
3335
PROXY_CACHE_VALID_FORBIDDEN: "30s"

0 commit comments

Comments
 (0)