2018-05-03 23:31:06 +08:00
|
|
|
---
|
|
|
|
title: "Memory"
|
|
|
|
description: "Rclone docs for Memory backend"
|
2022-12-21 04:05:05 +08:00
|
|
|
versionIntroduced: "v1.51"
|
2018-05-03 23:31:06 +08:00
|
|
|
---
|
|
|
|
|
2021-07-21 02:45:41 +08:00
|
|
|
# {{< icon "fas fa-memory" >}} Memory
|
2018-05-03 23:31:06 +08:00
|
|
|
|
|
|
|
The memory backend is an in RAM backend. It does not persist its
|
|
|
|
data - use the local backend for that.
|
|
|
|
|
2021-11-04 19:50:43 +08:00
|
|
|
The memory backend behaves like a bucket-based remote (e.g. like
|
2018-05-03 23:31:06 +08:00
|
|
|
s3). Because it has no parameters you can just use it with the
|
|
|
|
`:memory:` remote name.
|
|
|
|
|
2021-10-14 21:40:18 +08:00
|
|
|
## Configuration
|
|
|
|
|
2018-05-03 23:31:06 +08:00
|
|
|
You can configure it as a remote like this with `rclone config` too if
|
|
|
|
you want to:
|
|
|
|
|
|
|
|
```
|
2021-11-02 04:34:46 +08:00
|
|
|
No remotes found, make a new one?
|
2018-05-03 23:31:06 +08:00
|
|
|
n) New remote
|
|
|
|
s) Set configuration password
|
|
|
|
q) Quit config
|
|
|
|
n/s/q> n
|
|
|
|
name> remote
|
|
|
|
Type of storage to configure.
|
|
|
|
Enter a string value. Press Enter for the default ("").
|
|
|
|
Choose a number from below, or type in your own value
|
|
|
|
[snip]
|
|
|
|
XX / Memory
|
|
|
|
\ "memory"
|
|
|
|
[snip]
|
|
|
|
Storage> memory
|
|
|
|
** See help for memory backend at: https://rclone.org/memory/ **
|
|
|
|
|
|
|
|
Remote config
|
|
|
|
|
|
|
|
--------------------
|
|
|
|
[remote]
|
|
|
|
type = memory
|
|
|
|
--------------------
|
|
|
|
y) Yes this is OK (default)
|
|
|
|
e) Edit this remote
|
|
|
|
d) Delete this remote
|
|
|
|
y/e/d> y
|
|
|
|
```
|
|
|
|
|
|
|
|
Because the memory backend isn't persistent it is most useful for
|
2020-10-14 05:49:58 +08:00
|
|
|
testing or with an rclone server or rclone mount, e.g.
|
2018-05-03 23:31:06 +08:00
|
|
|
|
|
|
|
rclone mount :memory: /mnt/tmp
|
|
|
|
rclone serve webdav :memory:
|
|
|
|
rclone serve sftp :memory:
|
|
|
|
|
2023-11-18 20:36:46 +08:00
|
|
|
### Modification times and hashes
|
2018-05-03 23:31:06 +08:00
|
|
|
|
|
|
|
The memory backend supports MD5 hashes and modification times accurate to 1 nS.
|
|
|
|
|
2021-10-14 21:40:18 +08:00
|
|
|
### Restricted filename characters
|
2018-05-03 23:31:06 +08:00
|
|
|
|
|
|
|
The memory backend replaces the [default restricted characters
|
|
|
|
set](/overview/#restricted-characters).
|
|
|
|
|
2020-05-22 19:22:52 +08:00
|
|
|
{{< rem autogenerated options start" - DO NOT EDIT - instead edit fs.RegInfo in backend/memory/memory.go then run make backenddocs" >}}
|
2024-03-10 19:22:43 +08:00
|
|
|
### Advanced options
|
|
|
|
|
|
|
|
Here are the Advanced options specific to memory (In memory object storage system.).
|
|
|
|
|
|
|
|
#### --memory-description
|
|
|
|
|
2024-06-14 23:04:51 +08:00
|
|
|
Description of the remote.
|
2024-03-10 19:22:43 +08:00
|
|
|
|
|
|
|
Properties:
|
|
|
|
|
|
|
|
- Config: description
|
|
|
|
- Env Var: RCLONE_MEMORY_DESCRIPTION
|
|
|
|
- Type: string
|
|
|
|
- Required: false
|
|
|
|
|
2020-05-22 19:22:52 +08:00
|
|
|
{{< rem autogenerated options stop >}}
|