From 6574b5ac6afe773a5b3372cdcd6651358af49484 Mon Sep 17 00:00:00 2001 From: StuartIanNaylor Date: Fri, 15 Mar 2019 12:10:22 +0000 Subject: [PATCH] Update README.md --- README.md | 23 +++++------------------ 1 file changed, 5 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 12bac06..a96ff57 100644 --- a/README.md +++ b/README.md @@ -29,32 +29,19 @@ In the file `/etc/log2zram.conf` sudo nano /etc/log2zram.conf to edit: # Configuration file for Log2Ram (https://github.com/azlux/log2ram) under MIT license. # This configuration file is read by the log2ram service -# Size for the ram folder, it defines the size the log folder will reserve into the RAM. -# If it's not enough, log2ram will not be able to use ram. Check you /var/log size folder. -# The default is 40M and is basically enough for a lot of applications. -# You will need to increase it if you have a server and a lot of log for example. +# Size for the zram memory used, it defines the mem_limit for the zram device. +# The default is 20M and is basically enough for minimal applications. +# Because aplications can often vary in logging frequency this may have to be tweaked to suit application . SIZE=20M - -# This variable can be set to true if you prefer "rsync" rather than "cp". -# I use the command cp -u and rsync -X, so I don't copy the all folder every time for optimization. -# You can choose which one you want. Be sure rsync is installed if you use it. -USE_RSYNC=false - -# If there are some errors with available RAM space, a system mail will be send -# Change it to false and you will have only a log if there is no place on RAM anymore. -MAIL=false - -# **************** Zram backing conf ************************************************* - # ZL2R Zram Log 2 Ram enables a zram drive when ZL2R=true ZL2R=false is mem only tmpfs ZL2R=true # COMP_ALG this is any compression algorithm listed in /proc/crypto # lz4 is fastest with lightest load but deflate (zlib) and Zstandard (zstd) give far better compression ratios # lzo is very close to lz4 and may with some binaries have better optimisation -# COMP_ALG=lz4 for speed or Zstd for compression, lzo or zlib if optimisation or availabilty is a problem +# COMP_ALG=lz4 for speed or deflate for compression, lzo or zlib if optimisation or availabilty is a problem COMP_ALG=lz4 # LOG_DISK_SIZE is the uncompressed disk size. Note zram uses about 0.1% of the size of the disk when not in use -# LOG_DISK_SIZE is expected compression ratio of alg chosen multiplied by log SIZE +# LOG_DISK_SIZE is expected compression ratio of alg chosen multiplied by log SIZE where 300% is an approx good level. # lzo/lz4=2.1:1 compression ratio zlib=2.7:1 zstandard=2.9:1 # Really a guestimate of a bit bigger than compression ratio whilst minimising 0.1% mem usage of disk size LOG_DISK_SIZE=60M