Update README.md to improve Docker setup instructions
- Clarified Docker setup section, indicating that the setup is in progress and directing users to the `docker` branch for the latest changes. - Added instructions to copy the `.env.example` file to `.env` for environment configuration. - Enhanced clarity on configuring the environment variables in the `.env` file, emphasizing the need for user-specific values.
This commit is contained in:
24
README.md
24
README.md
@@ -67,19 +67,22 @@ npm install
|
|||||||
npm run build
|
npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
### Docker Setup (Recommended)
|
### Docker Setup
|
||||||
|
|
||||||
|
> Note: This setup is currently in progress. You can use the `docker` branch to get the latest changes.
|
||||||
|
|
||||||
1. **Clone and prepare:**
|
1. **Clone and prepare:**
|
||||||
```bash
|
```bash
|
||||||
git clone https://github.com/jango-blockchained/homeassistant-mcp.git
|
git clone -b docker https://github.com/jango-blockchained/homeassistant-mcp.git
|
||||||
cd homeassistant-mcp
|
cd homeassistant-mcp
|
||||||
|
cp .env.example .env
|
||||||
```
|
```
|
||||||
|
|
||||||
2. **Configure environment:**
|
2. **Configure environment `.env` file:**
|
||||||
```env
|
```env
|
||||||
NODE_ENV=production
|
...
|
||||||
HASS_HOST=your_home_assistant_url
|
|
||||||
HASS_TOKEN=your_home_assistant_token
|
HASS_TOKEN=your_home_assistant_token
|
||||||
|
...
|
||||||
```
|
```
|
||||||
|
|
||||||
3. **Launch with Docker Compose:**
|
3. **Launch with Docker Compose:**
|
||||||
@@ -89,12 +92,17 @@ npm run build
|
|||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
Create a `.env` file with:
|
Copy `.env.example` to `.env`.
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cp .env.example .env
|
||||||
|
```
|
||||||
|
|
||||||
|
Configure environment `.env` file:
|
||||||
```env
|
```env
|
||||||
|
...
|
||||||
HASS_TOKEN=your_home_assistant_token
|
HASS_TOKEN=your_home_assistant_token
|
||||||
HASS_HOST=your_home_assistant_url # e.g., http://homeassistant.local:8123
|
...
|
||||||
PORT=3000 # Optional, defaults to 3000
|
|
||||||
```
|
```
|
||||||
|
|
||||||
## Development
|
## Development
|
||||||
|
|||||||
Reference in New Issue
Block a user