alex/homeassistant-mcp
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
c11b40da9ee6d344a11edb69221d69676a892906
homeassistant-mcp/docs/getting-started/installation.md
jango-blockchained b0ad1cf0ad docs: add comprehensive documentation for MCP project 
- Create comprehensive documentation structure using MkDocs
- Add markdown files for API reference, architecture, getting started, and troubleshooting
- Configure GitHub Pages deployment workflow
- Include custom Jekyll and MkDocs configurations
- Add custom styling and layout for documentation site
2025-02-04 17:14:39 +01:00

2.3 KiB
Raw Blame History

Installation Guide

Prerequisites

System Requirements

  • Operating System: Linux, macOS, or Windows (Docker recommended)
  • Runtime: Bun v1.0.26 or higher
  • Home Assistant: v2023.11 or higher
  • Minimum Hardware:
    • 2 CPU cores
    • 2GB RAM
    • 10GB free disk space

Software Dependencies

  • Bun runtime
  • Docker (optional, recommended for deployment)
  • Git
  • Node.js (for some development tasks)

Installation Methods

1. Basic Setup

Install Bun

curl -fsSL https://bun.sh/install | bash

Clone Repository

git clone https://github.com/jango-blockchained/homeassistant-mcp.git
cd homeassistant-mcp

Install Dependencies

bun install

Configure Environment

  1. Copy environment template
cp .env.example .env
  1. Edit .env file with your Home Assistant configuration
    • Set HASS_HOST
    • Configure authentication tokens
    • Adjust other settings as needed

Build and Start

bun run build
bun start

2. Docker Setup (Recommended)

Prerequisites

  • Docker
  • Docker Compose

Deployment Steps

# Clone repository
git clone https://github.com/jango-blockchained/homeassistant-mcp.git
cd homeassistant-mcp

# Configure environment
cp .env.example .env
# Edit .env file with your settings

# Deploy with Docker Compose
docker compose up -d

3. Home Assistant Add-on (Coming Soon)

We're working on a direct Home Assistant add-on for even easier installation.

Verification

Check Installation

Troubleshooting

  • Ensure all environment variables are correctly set
  • Check network connectivity to Home Assistant
  • Verify authentication tokens

Updating

Basic Setup

git pull
bun install
bun run build
bun start

Docker

git pull
docker compose up -d --build

Uninstallation

Basic Setup

cd homeassistant-mcp
bun stop  # Stop the application
rm -rf node_modules dist

Docker

docker compose down
docker rmi homeassistant-mcp  # Remove image

Next Steps