github.com/artpar/rclone@v1.67.3/docs/content/compress.md (about)

     1  ---
     2  title: "Compress"
     3  description: "Compression Remote"
     4  versionIntroduced: "v1.54"
     5  status: Experimental
     6  ---
     7  
     8  # {{< icon "fas fa-compress" >}} Compress
     9  
    10  ## Warning
    11  
    12  This remote is currently **experimental**. Things may break and data may be lost. Anything you do with this remote is
    13  at your own risk. Please understand the risks associated with using experimental code and don't use this remote in
    14  critical applications.
    15  
    16  The `Compress` remote adds compression to another remote. It is best used with remotes containing
    17  many large compressible files.
    18  
    19  ## Configuration
    20  
    21  To use this remote, all you need to do is specify another remote and a compression mode to use:
    22  
    23  ```
    24  Current remotes:
    25  
    26  Name                 Type
    27  ====                 ====
    28  remote_to_press      sometype
    29  
    30  e) Edit existing remote
    31  $ rclone config
    32  n) New remote
    33  d) Delete remote
    34  r) Rename remote
    35  c) Copy remote
    36  s) Set configuration password
    37  q) Quit config
    38  e/n/d/r/c/s/q> n
    39  name> compress
    40  ...
    41   8 / Compress a remote
    42     \ "compress"
    43  ...
    44  Storage> compress
    45  ** See help for compress backend at: https://rclone.org/compress/ **
    46  
    47  Remote to compress.
    48  Enter a string value. Press Enter for the default ("").
    49  remote> remote_to_press:subdir 
    50  Compression mode.
    51  Enter a string value. Press Enter for the default ("gzip").
    52  Choose a number from below, or type in your own value
    53   1 / Gzip compression balanced for speed and compression strength.
    54     \ "gzip"
    55  compression_mode> gzip
    56  Edit advanced config? (y/n)
    57  y) Yes
    58  n) No (default)
    59  y/n> n
    60  Remote config
    61  --------------------
    62  [compress]
    63  type = compress
    64  remote = remote_to_press:subdir
    65  compression_mode = gzip
    66  --------------------
    67  y) Yes this is OK (default)
    68  e) Edit this remote
    69  d) Delete this remote
    70  y/e/d> y
    71  ```
    72  
    73  ### Compression Modes
    74  
    75  Currently only gzip compression is supported. It provides a decent balance between speed and size and is well
    76  supported by other applications. Compression strength can further be configured via an advanced setting where 0 is no
    77  compression and 9 is strongest compression.
    78  
    79  ### File types
    80  
    81  If you open a remote wrapped by compress, you will see that there are many files with an extension corresponding to
    82  the compression algorithm you chose. These files are standard files that can be opened by various archive programs, 
    83  but they have some hidden metadata that allows them to be used by rclone.
    84  While you may download and decompress these files at will, do **not** manually delete or rename files. Files without
    85  correct metadata files will not be recognized by rclone.
    86  
    87  ### File names
    88  
    89  The compressed files will be named `*.###########.gz` where `*` is the base file and the `#` part is base64 encoded 
    90  size of the uncompressed file. The file names should not be changed by anything other than the rclone compression backend.
    91  
    92  {{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/compress/compress.go then run make backenddocs" >}}
    93  ### Standard options
    94  
    95  Here are the Standard options specific to compress (Compress a remote).
    96  
    97  #### --compress-remote
    98  
    99  Remote to compress.
   100  
   101  Properties:
   102  
   103  - Config:      remote
   104  - Env Var:     RCLONE_COMPRESS_REMOTE
   105  - Type:        string
   106  - Required:    true
   107  
   108  #### --compress-mode
   109  
   110  Compression mode.
   111  
   112  Properties:
   113  
   114  - Config:      mode
   115  - Env Var:     RCLONE_COMPRESS_MODE
   116  - Type:        string
   117  - Default:     "gzip"
   118  - Examples:
   119      - "gzip"
   120          - Standard gzip compression with fastest parameters.
   121  
   122  ### Advanced options
   123  
   124  Here are the Advanced options specific to compress (Compress a remote).
   125  
   126  #### --compress-level
   127  
   128  GZIP compression level (-2 to 9).
   129  
   130  Generally -1 (default, equivalent to 5) is recommended.
   131  Levels 1 to 9 increase compression at the cost of speed. Going past 6 
   132  generally offers very little return.
   133  
   134  Level -2 uses Huffman encoding only. Only use if you know what you
   135  are doing.
   136  Level 0 turns off compression.
   137  
   138  Properties:
   139  
   140  - Config:      level
   141  - Env Var:     RCLONE_COMPRESS_LEVEL
   142  - Type:        int
   143  - Default:     -1
   144  
   145  #### --compress-ram-cache-limit
   146  
   147  Some remotes don't allow the upload of files with unknown size.
   148  In this case the compressed file will need to be cached to determine
   149  it's size.
   150  
   151  Files smaller than this limit will be cached in RAM, files larger than 
   152  this limit will be cached on disk.
   153  
   154  Properties:
   155  
   156  - Config:      ram_cache_limit
   157  - Env Var:     RCLONE_COMPRESS_RAM_CACHE_LIMIT
   158  - Type:        SizeSuffix
   159  - Default:     20Mi
   160  
   161  #### --compress-description
   162  
   163  Description of the remote
   164  
   165  Properties:
   166  
   167  - Config:      description
   168  - Env Var:     RCLONE_COMPRESS_DESCRIPTION
   169  - Type:        string
   170  - Required:    false
   171  
   172  ### Metadata
   173  
   174  Any metadata supported by the underlying remote is read and written.
   175  
   176  See the [metadata](/docs/#metadata) docs for more info.
   177  
   178  {{< rem autogenerated options stop >}}