proksi 0.3.8

A batteries-included reverse proxy with automatic HTTPS using Cloudflare Pingora and Let's Encrypt.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46

# Cache configuration

Proksi can be configured to use a cache to improve the performance of your proxy server.

## Cache configuration

The cache configuration is defined in the `routes` section of the Proksi configuration file.

Each route can have a `cache` section that specifies the cache configuration for that route.

The cache configuration includes the following options:

- `enabled`: Whether the cache is enabled for the route. Defaults to `false`.
- `expires_in_secs`: The number of seconds the cache should be valid for. Defaults to `360`.
- `stale_if_error_secs`: The number of seconds the cache should be valid for if an error occurs. Defaults to `60`.
- `stale_while_revalidate_secs`: The number of seconds the cache should be valid for if the response is revalidated. Defaults to `60`.
- `path`: The path to the cache directory. Defaults to `./tmp`.

Here's an example of a route with a cache configuration:

```hcl
routes = [
  {
    host: "example.com",
    cache: {
      enabled: true,
      expires_in_secs: 360,
      stale_if_error_secs: 60,
      stale_while_revalidate_secs: 60,
      path: "/tmp"
    },
    upstreams: [{
      ip: "10.0.1.3/25",
      port: 3000,
      network: "public",
      weight: 1
    }]
  }
]
```

## Cache usage

When a request is made to a route with a cache configuration, Proksi will check if the response is already in the cache. If it is, the response will be served from the cache instead of making a new request to the upstream server.

If the response is not in the cache, Proksi will make a new request to the upstream server and cache the response. The cache will be updated with the new response if the response is valid for the configured expiration time.