Browse Source

Update README.md

Log2Ram handles the detection of rsync automatically. If rsync is available on your system, it will be used for synchronization; otherwise, the script will fall back to using cp.

The documentation has been updated to reflect that `USE_RSYNC` is no longer required in the config file (/etc/log2ram.conf).
pull/223/head
Adam Matthews 5 months ago
committed by GitHub
parent
commit
9e802499c4
No known key found for this signature in database GPG Key ID: B5690EEEBB952194
1 changed files with 3 additions and 3 deletions
  1. +3
    -3
      README.md

+ 3
- 3
README.md View File

@@ -37,7 +37,8 @@ cd ..
rm -r log2ram-master rm -r log2ram-master
``` ```


For better performances, `RSYNC` is a recommended package.
For better performances, `rsync` is a recommended package.
(Without `rsync`, `cp` will be used instead as fallback).


**REBOOT** before installing anything else (for example `apache2`) **REBOOT** before installing anything else (for example `apache2`)


@@ -78,10 +79,9 @@ You need to stop Log2Ram (`systemctl stop log2ram`) and execute the [installatio
## Customization ## Customization


#### Variables #### Variables
In the file `/etc/log2ram.conf`, there are five variables:
In the file `/etc/log2ram.conf`, there are four variables:


- `SIZE`: defines the size the log folder will reserve into the RAM (default is 40M). - `SIZE`: defines the size the log folder will reserve into the RAM (default is 40M).
- `USE_RSYNC`: (commented out by default = `true`) use `cp` instead of `rsync` (if set to `false`).
- `MAIL`: disables the error system mail if there is not enough place on RAM (if set to `false`). - `MAIL`: disables the error system mail if there is not enough place on RAM (if set to `false`).
- `PATH_DISK`: activate log2ram for other path than default one. Paths should be separated with a `;`. - `PATH_DISK`: activate log2ram for other path than default one. Paths should be separated with a `;`.
- `ZL2R`: enable zram compatibility (`false` by default). Check the comment on the config file. See https://github.com/StuartIanNaylor/zram-swap-config to configure a zram space on your raspberry before enable this option. - `ZL2R`: enable zram compatibility (`false` by default). Check the comment on the config file. See https://github.com/StuartIanNaylor/zram-swap-config to configure a zram space on your raspberry before enable this option.


Loading…
Cancel
Save