My Cloud Home FUSE file system

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.

Installing latest release

To quickly install the latest pre-built binary of mchfuse you can execute the following command:

curl -L https://github.com/mnencia/mchfuse/raw/master/install_latest.sh | sudo sh

Installing from source

• 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
  make

  After the build, you find a mchfuse executable in the project root.

• If you want to make mchfuse available as a system command, install it

  sudo make install

Quickstart

You can mount your device using the following command:

cat > mchfuse.conf < 'EOF'
username = YOURUSERNAME
password = PASSWORD
EOF

chmod 600 mchfuse.conf

./mchfuse -c mchfuse.conf DEVICE_NAME[:device/path] /mount/point &

You can specify all the command line options in a config file with the following format:

umount /mount/point

Usage

Usage: mchfuse [flags] deviceName:devicePath mountpoint
  -a, --allow-other       allow other users
  -c, --config string     config file path
  -d, --debug             activate debug output
  -G, --gid int           set the group of the files in the filesystem (default -1)
  -p, --password string   mycloud.com password
  -U, --uid int           set the owner of the files in the filesystem (default -1)
  -u, --username string   mycloud.com username

All the options can be specified in a configuration file with the format:

flag-name = value

You can pass the configuration using the --config flag, otherwise mchfuse loads the options from /etc/mchfuse.conf if it exists.

If you do not specify a UID or a GID, it inherits the missing setting from the user that runs the command.

Maturity

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.

Known Limits

• For the moment, you must be on the same network of the device

TODO

• Device locality detection to allow accessing the device remotely
• Mount helper, to support mounting from /etc/fstab
• Performance tests
• Device list command
• Support for extended attributes
• More documentation
• More testing

Feedback

You can send your feedback through the issue tracker

License

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.

Disclaimer

I'm not affiliated in any way with Western Digital.