HomeDock OS Installation Guide

Step-by-step instructions for installing HomeDock OS on both Cloud Instances and Self-Hosted environments.

Cloud Instances

For users opting for the Cloud Instance deployment, installation is handled entirely by our infrastructure. Simply choose your subscription plan, and our systems will set up everything you need automatically within minutes. Here’s a quick overview of the process:

1. Subscription: Select a plan on the HomeDock OS website.
2. Instance Provisioning: Once subscribed, your instance will be automatically provisioned.
3. Access Panel: You’ll receive access to the Administration Panel where you can log in and manage your instance.

Note

On Cloud Instances no further installation steps are needed on your end; the infrastructure setup, SSL certificates, firewall, and security configurations are all handled for you.

Self-Hosted Environments

For users choosing to deploy HomeDock OS on their own infrastructure, follow the steps below to complete the installation.

Step-by-step Installation

1. Download Installer: Get the HomeDock OS installer for your OS.

2. Requirements: Ensure minimum 2 cores, 1 GB RAM, 4 GB storage, and Python3 installed. Additional dependencies vary by OS.

3. Run Installer:

   • Linux: curl -fsSL https://get.homedock.cloud | sudo bash
   • macOS: Open HomeDockOS-macOS-Setup.dmg.
   • Windows: Open HomeDockOS-Windows-Setup.exe.

4. SSL Setup (Optional): Place SSL certificates in /DATA/SSLCerts for HTTPS.

5. Login & Configure: Access http://localhost:8080, log in, and customize the hostname.

Step 1: Download the Installer

Visit the HomeDock OS Download page to access the latest installers for your preferred platform:

• Linux (Ubuntu, Debian, Raspberry Pi, etc.)
• macOS
• Windows

Note

Please always ensure you download the correct installer for your operating system on our downloads website get.homedock.cloud

Step 2: Pre-Installation Requirements

Before running the installer, ensure that your system meets the following requirements.

System Requirements:

• CPU: Minimum 2 cores (4 recommended).
• RAM: At least 1 GB (8 GB recommended for optimal performance).
• Disk Space: 4 GB available.
• OS: Officially supported platforms:
  • Linux: Tested on Debian 12+ and Ubuntu 22.04+.
  • macOS: Intel & Apple Silicon running Sonoma 14+.
  • Windows: Windows 10 Pro and higher (64-bit).

Dependencies:

The following dependencies are required for HomeDock OS to function correctly:

• Linux:

  • git, python3, python3-venv, python3-pip, docker, docker-compose
  • If missing, they will be automatically installed by the installer when running curl -fsSL https://get.homedock.cloud | sudo bash

• macOS:

  • Currently: Requires Docker Desktop and Python 3.
  • Starting March 21, 2025: HomeDock OS Nexus Launcher will handle all dependencies, removing the need for Docker Desktop. It will use Lima/Colima for containerization.

• Windows:

  • Currently: Requires Docker Desktop and Python 3.
  • Starting March 21, 2025: HomeDock OS Nexus Launcher will integrate WSL2, eliminating the need for Docker Desktop.

Let us know at support@homedock.cloud if you would like to beta-test HomeDock OS Nexus Launcher for Windows and/or macOS!

Installing Dependencies Manually:

If you are on Linux and need to install the required dependencies manually, run:

sudo apt-get install git python3 python3-venv python3-pip docker docker-compose

Important:
The HomeDock OS installation script has been tested on Debian 12+ and Ubuntu 22.04+. It may not work as expected on other distributions. If you encounter issues, you may need to manually install dependencies and set up a virtual environment inside HomeDockOS/venv:

cd HomeDockOS
python3 -m venv venv
source venv/bin/activate
pip install -r requirements.txt

This ensures compatibility with the HomeDock OS built-in and hash-based Python dependency auto-update system.

Step 3: Run the Installer

Once downloaded, follow these steps to start the setup:

1. Linux (Debian 12 / Ubuntu 22.04+):

   curl -fsSL https://get.homedock.cloud | sudo bash

2. macOS:

   Once HomeDock OS Nexus Launcher is out, you will need to run the HomeDockOS-macOS-Setup.dmg file to mount the HomeDock OS Nexus Launcher device on macOS and drag the application to the Applications list. Then run the HomeDock OS icon from Launchpad and follow the prompts in the Nexus Launcher. If Docker Desktop and / or Python is missing they will be installed. You may also manually install them if needed.

3. Windows 10 Pro:

   Once HomeDock OS Nexus Launcher is out, you will need to run the HomeDockOS-Windows-Setup.exe file to install HomeDock OS Nexus Launcher. After installation, run the HomeDock OS desktop icon and follow the prompts in the Nexus Launcher. If Docker Desktop and / or Python is missing, administrator privileges may be required, and a system restart might be necessary. You may also manually install them if needed.

The installer will let you know what’s happening through the process, including virtual environment configuration and dependencies installation automatically.

Step 4: Configure SSL Certificates (Optional)

For HTTPS connections, place your SSL certificates in the /DATA/SSLCerts directory (only available on Linux systems at this moment). Self-hosted environments automatically recognize certificates in this directory. For further information please check SSL/HTTPS Section.

Tip

Set up a renewal hook to transfer new SSL certificates to /DATA/SSLCerts upon renewal for continued HTTPS support.

Step 5: Initial Login and Configuration

After installation:

1. Access the Login Panel: Go to http://homedock.local (or your configured IP/hostname) to access the login page.
2. Login: Use the initial credentials set during installation.
3. Configure Hostname: Change the default hostname to personalize your instance.
4. Default Login: Please use user and passwd as the default login credentials then change them immediately.

With these steps, you’re all set to start using HomeDock OS, whether on a Cloud Instance or with your own Self-Hosted setup. Explore the platform and enjoy seamless, secure cloud management!