Install HomeDrive on Custom Hardware

If you want to run HomeDrive on your own hardware, like an old PC of yours, you can install it by yourself (and it is completely free). You can also use a virtual machine at a cloud service provider (such as Amazon Web Services, Google Cloud, Vultr or DigitalOcean).

Note that we only support amd64 and arm64 architectures for now. If you are interested in using particular hardware that we do not support, you can express your interests here, and we will consider prioritize supporting them in the future.

If you want to use HomeDrive on a Raspberry Pi 3 or 4, you can follow these more specific steps.

Install Linux and Docker

First, prepare your machine with a clean installation of Linux and Docker.

Our hardware offer uses RancherOS, a container-based operating system with fewer moving parts to maintain. You can also use Ubuntu or your own favorite Linux distro, as long as it can run docker.

Make sure your Linux user can run docker command, and has Internet access. The docker server needs to support API version 1.40 or above:

$ docker version
Client: Docker Engine - Community
 ...

Server: Docker Engine - Community
 Engine:
  Version:          20.10.2
  API version:      1.41 (minimum version 1.12)
 ...

Note that unlike using our official hardware, you are responsible to maintain and upgrade the operating system by yourself.

Some links that might be helpful:

Create an Endpoint

Click here to create an endpoint.

This step creates an endpoint account with a subdomain at HomeDrive, which makes your services easily accessible from the Internet with end-to-end TLS encryption.

Install HomeDrive

The endpoint creation comes with a one-time installation code. You can use the code to install HomeDrive using the following command (with <endpoint name> and <one-time installation code> replaced):

docker run -ti --rm \
  --mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock \
  homedrv/homeboot /bin/homeboot install \
  -name <endpoint name> -code <one-time installation code>

The homeboot container will download and run a container called core.homedrv, where this "core" will download, install, configure Nextcloud, and also its backend storage systems and its reverse proxy. The whole installation process normally takes about 10 minutes.

When core.homedrv is running, you can monitor the installation progress via docker logs core.homedrv command.

After HomeDrive is successfully installed, you can visit it at your-endpoint.homedrv.com (or your-endpoint.homedrv.eu for Europe region ones). The installation generates a password with random characters, and you can find the password on the specific endpoint's page from the HomeDrive endpoints dashboard. The user name is admin.

Change your Nextcloud password and set up some form of 2-factor authentication. Since your Nextcloud is exposed to the Internet, setting up 2-factor authentication is very important to keep your service and data secure.

All HomeDrive managed docker containers and volumes has the .homedrv suffix, and also a label with key io.homedrive.name. This avoids introducing naming conflicts with docker objects that HomeDrive does not manage.

Run the occ Command

If you want to fine-tune your Nextcloud instance, you might need to access the occ command. The Nextcloud is hosted inside its own docker container, so in order to run occ, you need to get into the container first:

docker exec -ti -u www-data nextcloud.homedrv /bin/bash

Then you can run occ:

$ ./occ status
  - installed: true
  - version: 20.0.7.1
  - versionstring: 20.0.7
  - edition:

Uninstall HomeDrive

In case that your installation failed and needs cleaning things up, or you simply decided to stop using HomeDrive and want to unintall it, run:

docker run -ti --rm \
  --mount type=bind,source=/var/run/docker.sock,target=/var/run/docker.sock \
  homedrv/homeboot /bin/homeboot uninstall

This will also delete all HomeDrive managed data.


If you need help, feel free to chat with us using the chat bottom on the bottom right corner, or send us an email at support@homedrive.io .

If you still find these steps too complicated to follow, you can buy a preinstalled HomeDrive device, starting at $299.