mir/MEGAcmd
2
0
Fork 0
mirror of https://github.com/meganz/MEGAcmd synced 2025-08-22 01:47:24 +00:00
Code Issues Releases Wiki Activity

Complete the FUSE guide, and several fixes and improvements

Browse Source
This commit is contained in:
Diego Ximenez 2025-03-21 14:44:03 +01:00
parent bc2218cedc
commit fc12c7eec5
No known key found for this signature in database
GPG Key ID: 8E94095CB5DBCBA0
1 changed files with 69 additions and 30 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

99
contrib/docs/FUSE.md
View File

@ -1,53 +1,92 @@
# MEGA-FUSE - Serve you files as a Filesystem in User SpacE server with MEGAcmd
# MEGA-FUSE — Serve your files as a "Filesystem in Userspace" (FUSE) with MEGAcmd
This is a brief tutorial on how to configure and manage [FUSE](https://en.wikipedia.org/wiki/Filesystem_in_Userspace) with MEGAcmd.
This is a brief tutorial on how to configure [fuse](https://wikipedia.org/wiki/WebDAV) mount point.
Configuring a FUSE mount will let you access your MEGA files as if they were located in your computer. After enabling a FUSE mount, you can use your favourite tools to browse, play, and edit your MEGA files.
Currently this is only supported for Linux.
Configuring a FUSE mount will let you access your MEGA files as if they were located in your computer. After configuring a FUSE mount, you can use your favourite tools to browse, play and edit your MEGA files.
Notice: the commands listed here assume you are using the interactive interaction mode: they are supposed to be executed within MEGAcmd Shell.
Note: this functionality is in beta, and only supported on Linux.
## Local cache
MEGAcmd will use a cache to place files while working with mount points. This cache will be used to store both files downloaded from MEGA, and files being uploaded to MEGA. It will be created automatically in `$HOME/.megaCmd/fuse-cache` for Linux and macOS, and `%LOCALAPPDATA%\MEGAcmd\.megaCmd\fuse-cache` for Windows.
MEGAcmd will use a cache to place files while working with mount points. Such cache will be used to store both files downloaded from MEGA and files being uploaded to MEGA. These will be created under the hood in a cache folder.
FUSE cache is locate at .... TODO
Bear in mind that this cache is fundamental to be able to work with FUSE mounts.
Cache files are removed automatically. Restarting MEGAcmd Server may help reduce the space used by the cache.
Bear in mind that this cache is fundamental to be able to work with FUSE mounts. Cache files are removed automatically. Restarting the MEGAcmd Server may help reduce the space used by the cache.
### Important caveats
Files/folders created within your local computer may not be immediately available in your Cloud. The mount engine will transfer your files in the background and create folders in your cloud. This will work transparantly. But its important to
be aware that MEGAcmd Server need to be running in order for these actions to complete.
Files and folders created locally may not be immediately available in your MEGA cloud: the mount engine will transfer them transparently in the background. Note that the MEGAcmd Server needs to be running in order for these actions to complete.
## Streaming
Currently, streaming is not directly supported. In order to open a file within a FUSE mount point, the file need to be downloaded completely within the local cache folder. You will need space in your hard-drive to accomodate for these files.
Currently, streaming is not directly supported. In order to open files in a FUSE mount point, they need to be downloaded completely to the local cache folder. You will need space in your hard drive to accomodate for these files.
## Usage
### Creating a new mount
You can create a new FUSE mount with:
```
$ fuse-add /local/path/to/fuse/mountpoint /cloud/dir
```
After creating the mount, MEGAcmd will try to enable it; if it fails, the mount will remain disabled. See [`fuse-add`](commands/fuse-add.md) for all the possible options and arguments.
### Creating a new mount point
....
The mount will have an associated name that we can use to refer to it when managing it. The name must be unique. A custom name can be chosen on creation with the `--name=custom_name` argument. We might also refer to a mount by its local path, but this is not necessarily unique: if multiple mounts share the same local path, we *must* use the name so we can distinguish between them.
### Disable/enable
### Displaying mounts
The list of existing mounts can be displayed with:
```
$ fuse-show
NAME LOCAL_PATH REMOTE_PATH PERSISTENT ENABLED
dir /local/path/to/fuse/mountpoint /cloud/dir YES YES
```
Use `fuse-show <NAME|LOCAL_PATH>` to get further details on a specific mount. See [`fuse-show`](commands/fuse-show.md) for the list of all possible options and arguments.
### Enabling/disabling mounts
To make your cloud files available in your local filesystem, the mount must be enabled. We can do so with:
```
$ fuse-enable <NAME|LOCAL_PATH>
```
Note: mounts are enabled when created by default (unless `--disabled` is used).
Similarly, we can stop exposing our cloud files locally with:
```
$ fuse-disable <NAME|LOCAL_PATH>
```
Note: disabled mounts still exist and are shown in `fuse-show`. See [`fuse-enable`](commands/fuse-enable.md) and [`fuse-disable`](commands/fuse-disable.md) for more information on these commands.
### Adjusting configuration
As we've mentioned before, the full details of a mount can be displayed with:
```
$ fuse-show dir
Showing details of mount "dir"
Local path: /local/path/to/fuse/mountpoint
Remote path: /cloud/dir
Name: dir
Persistent: YES
Enabled: YES
Enable at startup: YES
Read-only: NO
```
### Remove
To configure these flags, we can use the [`fuse-config`](commands/fuse-config.md) command. For example, to make the mount read-only, we would do:
```
$ fuse-config --read-only=yes dir
Mount "dir" now has the following flags
Name: dir
Enable at startup: YES
Persistent: YES
Read-only: YES
```
### Removing mounts
A mount can be removed with:
```
$ fuse-remove <NAME|LOCAL_PATH>
```
Note: mounts must be disabled before they can be removed.
## Issues
Occasionally you may encounter a situation in which there is a FUSE mount configured. e.g: if MEGAcmd Server is closed abruptly. Consider using fusermount command to disable the mounting:
Occasionally, you may encounter issues in FUSE mounts that cannot be directly resolved within MEGAcmd (for example, if the MEGAcmd server was closed abruptly). The most common one is: "Error: cannot access '/local/path/to/fuse/mountpoint': Transport endpoint is not connected". To fix them you might need to use the `fusermount` command like so:
```
fusermount -u /local/path/to/use/mountpoint
fusermount -u /local/path/to/fuse/mountpoint
```
Adding a `-z` may help if the above fails. See ... TODO: link man page.
Adding `-z` may help if the above fails. See the [fusermount man page](https://www.man7.org/linux/man-pages/man1/fusermount3.1.html).