This repository has been archived by the owner on Jan 9, 2023. It is now read-only.
Clean up of readme doc #19
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
stephen-palmer
suggested changes
Mar 14, 2018
README.md
Outdated
| cachePath | `.cache_ram` | The path to the cache directory. Dirty memory pages are saved to disk periodically in this directory, and loaded at startup. | ||
| persistence | true | Enable saving and loading of page files to disk. If `false`, the cache is emptied during restart. | ||
| persistenceOptions.autosave | true | When set to `true`, automatically save changed memory pages; set to `false` to disable. If `false`, pages are only saved when the cache server is stopped with the `q` console command or with upon a SIGTERM. | ||
| persistenceOptions.autosaveInterval | 10000 | The frequency, in milliseconds, to save page that have changed. |
There was a problem hiding this comment.
page should be plural
README.md
Outdated
|
|
||
| * cache_fs is backwards compatible with v5.x Cache Server directories. | ||
| * Supports worker threads using the `--workers` option. | ||
| * When you run the cleanup script, the value of the `expireTimeSpan` option is used to determine which file to delete files. If `maxCacheSize` is specified the script checks whether the cache exceeds the value of `maxCacheSize`. If it does, the script deletes files in least-recently-used order until the cache no longer exceed maxCacheSize. |
There was a problem hiding this comment.
"which file to delete files" doesn't make sense
README.md
Outdated
| @@ -24,131 +25,183 @@ At present time this open-source repository is maintained separately from the Ca | |||
| * [License](#license) | |||
|
|
|||
| ## Server Setup | |||
| Download and install the latest LTS version of node from the [Node.JS website](`https://nodejs.org/en/download/`). | |||
|
|
|||
| Download and install the latest LTS version of Node.js from the [Node.JS website](https://nodejs.org/en/download/). | |||
There was a problem hiding this comment.
Feedback from customer .. confused about the specific version to download. Suggest adding v8.10.0 to this sentence.
README.md
Outdated
| #### Notes | ||
| * Does not support worker threads | ||
| pageSize | 100000000 | The page size, in bytes, used to grow the cache. | ||
| maxPageCount | 10 | The maximum number of pages to allocate in the cache. The combination of `pageSize` and `maxPageCount` limits the overall memory footprint of the cache. When this threshold is reached, memory recovered using a Least Recently Used (LRU) algorithm. |
There was a problem hiding this comment.
memory is recovered
stephen-palmer
approved these changes
Mar 14, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.