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/macOS: chmod +x homedock-install.sh && ./homedock-install.sh
   • Windows: Open homedock-install.exe or homedock-install.ps1.

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, CentOS, etc.)
• macOS
• Windows

Note

Please always ensure you download the correct installer for your operating system.

Step 2: Pre-Installation Requirements

Before running the installer, confirm 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.

• Dependencies: Ensure the following packages are installed (specific to each platform):

  • Linux: curl, wget, git, pip
  • Windows: PowerShell script execution enabled
  • macOS: Homebrew (for dependency management)
  • Python3 is required on all systems

HomeDock OS is optimized to run on a wide range of devices, including lower-spec hardware like the Raspberry Pi Zero 1. While the core system functions efficiently, some applications may require more resources for optimal performance. The technical specifications listed here are recommended minimums.

Step 3: Run the Installer

Once downloaded, follow these steps to initiate the setup:

1. Linux:

   chmod +x homedock-install.sh
   ./homedock-install.sh

2. macOS:

   chmod +x homedock-install.sh
   ./homedock-install.sh

3. Windows:

   Double-click the homedock-install.exe or homedock-install.ps1 file and follow the installation prompts.

The installer will guide you through the setup 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. 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.

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!