Skip to content

Commit

Permalink
docs+deps: preparing v0.6.0
Browse files Browse the repository at this point in the history
  • Loading branch information
junkurihara committed Aug 24, 2023
1 parent 119637f commit 9bbd8fc
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 7 deletions.
4 changes: 3 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# CHANGELOG

## 0.6.0 (unreleased)
## 0.7.0 (unreleased)

## 0.6.0

### Improvement

Expand Down
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -281,9 +281,9 @@ tls = { https_redirection = true, tls_cert_path = './server.crt', tls_cert_key_p

However, currently we have a limitation on HTTP/3 support for applications that enables client authentication. If an application is set with client authentication, HTTP/3 doesn't work for the application.

### Hybrid Caching Feature Using File and On-Memory
### Hybrid Caching Feature with Temporary File and On-Memory Cache

If `[experimental.cache]` is specified, you can leverage the local caching feature using temporary files and on-memory objects. Note that `max_cache_each_size` must be larger or equal to `max_cache_each_size_on_memory`.
If `[experimental.cache]` is specified in `config.toml`, you can leverage the local caching feature using temporary files and on-memory objects. An example configuration is as follows.

```toml
# If this specified, file cache feature is enabled
Expand All @@ -294,7 +294,7 @@ max_cache_each_size = 65535 # optional. default is 64k
max_cache_each_size_on_memory = 4096 # optional. default is 4k if 0, it is always file cache.
```

Note that once `rpxy` restarts or the config is updated, the cache is totally eliminated not only from the on-memory table but also from the file system.
A *storable* (in the context of an HTTP message) response is stored if its size is less than or equal to `max_cache_each_size` in bytes. If it is also less than or equal to `max_cache_each_size_on_memory`, it is stored as an on-memory object. Otherwise, it is stored as a temporary file. Note that `max_cache_each_size` must be larger or equal to `max_cache_each_size_on_memory`. Also note that once `rpxy` restarts or the config is updated, the cache is totally eliminated not only from the on-memory table but also from the file system.

## TIPS

Expand Down
4 changes: 2 additions & 2 deletions rpxy-bin/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ rpxy-lib = { path = "../rpxy-lib/", default-features = false, features = [

anyhow = "1.0.75"
rustc-hash = "1.1.0"
serde = { version = "1.0.185", default-features = false, features = ["derive"] }
serde = { version = "1.0.186", default-features = false, features = ["derive"] }
derive_builder = "0.12.0"
tokio = { version = "1.32.0", default-features = false, features = [
"net",
Expand All @@ -38,7 +38,7 @@ rustls-pemfile = "1.0.3"
mimalloc = { version = "*", default-features = false }

# config
clap = { version = "4.3.23", features = ["std", "cargo", "wrap_help"] }
clap = { version = "4.3.24", features = ["std", "cargo", "wrap_help"] }
toml = { version = "0.7.6", default-features = false, features = ["parse"] }
hot_reload = "0.1.4"

Expand Down

0 comments on commit 9bbd8fc

Please sign in to comment.