Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jstzwj committed Sep 6, 2024
1 parent d1cdc94 commit 40ffa99
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,8 @@ port = 8090
ssl-key = ""
ssl-cert = ""
repos-path = "./repos"
cache-size-limit = ""
cache-clean-strategy = "LRU"
hf-scheme = "https"
hf-netloc = "huggingface.co"
hf-lfs-netloc = "cdn-lfs.huggingface.co"
Expand All @@ -144,6 +146,8 @@ mirrors-path = ["./mirrors_dir"]
- `port`: Sets the port that Olah listens to.
- `ssl-key` and `ssl-cert`: When enabling HTTPS, specify the file paths for the key and certificate.
- `repos-path`: Specifies the directory for storing cached data.
- `cache-size-limit`: Specifies cache size limit (For example, 100G, 500GB, 2TB). Olah will scan the size of the cache folder every hour. If it exceeds the limit, olah will delete some cache files.
- `cache-clean-strategy`: Specifies cache cleaning strategy (Available strategies: LRU, FIFO, LARGE_FIRST).
- `hf-scheme`: Network protocol for the Hugging Face official site (usually no need to modify).
- `hf-netloc`: Network location of the Hugging Face official site (usually no need to modify).
- `hf-lfs-netloc`: Network location for Hugging Face official site's LFS files (usually no need to modify).
Expand Down
4 changes: 4 additions & 0 deletions README_zh.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,8 @@ port = 8090
ssl-key = ""
ssl-cert = ""
repos-path = "./repos"
cache-size-limit = ""
cache-clean-strategy = "LRU"
hf-scheme = "https"
hf-netloc = "huggingface.co"
hf-lfs-netloc = "cdn-lfs.huggingface.co"
Expand All @@ -146,6 +148,8 @@ mirrors-path = ["./mirrors_dir"]
- port: 设置olah监听的端口
- ssl-key和ssl-cert: 当需要开启HTTPS时传入key和cert的文件路径
- repos-path: 用于保存缓存数据的目录
- cache-size-limit: 指定缓存大小限制(例如,100G,500GB,2TB)。Olah会每小时扫描缓存文件夹的大小。如果超出限制,Olah会删除一些缓存文件
- cache-clean-strategy: 指定缓存清理策略(可用策略:LRU,FIFO,LARGE_FIRST)
- hf-scheme: huggingface官方站点的网络协议(一般不需要改动)
- hf-netloc: huggingface官方站点的网络位置(一般不需要改动)
- hf-lfs-netloc: huggingface官方站点LFS文件的网络位置(一般不需要改动)
Expand Down

0 comments on commit 40ffa99

Please sign in to comment.