MCHFuse is a FUSE file system for mounting Western Digital My Cloud Home devices.
It exposes the main storage area of your device using the WD My Cloud Home Off-Device API.
Western Digital deprecated My Cloud Home SDK/API in favor of direct local access to the device using Samba (SMB) protocol
MCHFuse will continue to work as long as the API it uses remains available; however, it will not receive any further updates.
To compile MCHFuse, you need at least go 1.13.
To run MCHFuse on OSX, you need osxfuse extension. You can install it with Homebrew
using the command:
brew cask install osxfuseTo quickly install the latest pre-built binary of MCHFuse, you can execute the following command:
curl -sSfL https://github.com/mnencia/mchfuse/raw/main/install.sh | sudo sh -s -- -b /usr/local/bin-
Install the Go compiler suite and make; e.g. on Ubuntu:
sudo apt-get install git golang-go ca-certificates make
-
Then check out MCHFuse project
git clone https://github.com/mnencia/mchfuse.git
-
Then change directory to the just-checked-out work tree and build it
cd mchfuse makeAfter the build, you find a
mchfuseexecutable in the project root. -
If you want to make
mchfuseavailable as a system command, install itsudo make install
You can mount your device using the following command:
cat > mchfuse.conf << 'EOF'
username = "EMAIL"
password = "PASSWORD"
EOF
chmod 600 mchfuse.conf
mchfuse -c mchfuse.conf DEVICE_NAME MOUNT_POINTThe EMAIL and PASSWORD are the ones used to access https://home.mycloud.com/.
The DEVICE_NAME is the name assigned to the device during the initial configuration.
If you happen to use a wrong name, the resulting error message contains the list
of valid discovered device names.
Footnote: semi-automatic device names contain a single quote. To enter such a string on a commandline you need to enclose it in double quotes. (No amount of escaping inside single quotes seems to work these days).
Replace MOUNT_POINT with the actual path where you want to see the content
of the device. (e.g. /mnt/mydevice)
After the last command, you should see the content of the mounted device available in the mount point folder.
NOTE: the filesystem will be only accessible from the user who executed the
mchfusecommand unless you specify the flag--allow-othereither on the command line or in the configuration file (i.e.allow-other = true)
You can unmount the device using the usual umount command:
umount MOUNT_POINTUsage: mchfuse [flags] deviceName[:devicePath] mountpoint
-c, --config string config file path
-u, --username string mycloud.com username
-p, --password string mycloud.com password
-a, --allow-other allow other users
-U, --uid int set the owner of the files in the filesystem (default disabled)
-G, --gid int set the group of the files in the filesystem (default disabled)
-f, --foreground do not demonize
-d, --debug activate debug output (implies --foreground)
-h, --help display this help and exit
-v, --version display the version and exit
All the options can be specified in a configuration file with the format:
flag-name = valueYou can pass the configuration using the --config flag, otherwise mchfuse
loads the options from /etc/mchfuse.conf if it exists and is readable.
If you do not specify a UID or a GID, it inherits the missing setting from the user that runs the command.
The deviceName is the name assigned to the device during the initial configuration.
If you happen to use a wrong name, the resulting error message contain the list of
valid discovered device names.
By default, MCHFuse mounts the root of the device, but you can append a devicePath
after a : separator, to start from a subdirectory.
(e.g. myDevice:linuxData uses the linuxData folder inside myDevice root)
The mountpoint is any directory accessible from the current user.
If the path doesn't exist, MCHFuse tries to create it.
NOTE:
mchfusedemonize itself, eventual errors raised by the background process will end up in the syslog with priority NOTICE and tag "mchfuse".
To keep your volume mounted on your system through reboots, create
a persistent mount. This is accomplished by updating
your system's /etc/fstab file.
On a new line, add a mount directive to your /etc/fstab file which matches
the following syntax:
deviceName[:devicePath] mountpoint fuse.mchfuse noauto,x-systemd.automount,_netdev,allow_other 0 0
You can specify any option available on the command line adding it in the field
containing noauto,x-systemd.automount,_netdev,allow_other separated by commas.
Please avoid using explicit username and password parameters, because
they will be readable both in /etc/fstab file and in the system process list.
Use the default configuration file /etc/mchfuse.conf or specify one
using config option instead.
NOTE You will need to use sudo privileges to edit this file from your limited user.
After setting the line in /etc/fstab, reboot your system.
Then, list the contents of the mounted directory. You should see the content
of your device.
This project is in alpha state. I've made it to access my device from Linux, and it works quite well for me. There are many things to improve, starting from performances.
- Write performances need improvements
- Performance tests
- Device list command
- Support for extended attributes
- More documentation
- More testing
You can send your feedback through the issue tracker
Copyright 2020 Marco Nenciarini [email protected]
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
I'm not affiliated in any way with Western Digital.