https://github.com/homettp/homettp
🏠 An HTTP-based command runner for home automation.
https://github.com/homettp/homettp
command go golang home-automation http inertiajs redis tailwindcss vuejs
Last synced: 9 months ago
JSON representation
🏠 An HTTP-based command runner for home automation.
- Host: GitHub
- URL: https://github.com/homettp/homettp
- Owner: homettp
- License: mit
- Created: 2021-01-15T22:44:04.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-08T00:11:23.000Z (10 months ago)
- Last Synced: 2025-03-27T02:11:19.558Z (10 months ago)
- Topics: command, go, golang, home-automation, http, inertiajs, redis, tailwindcss, vuejs
- Language: Go
- Homepage:
- Size: 1.06 MB
- Stars: 65
- Watchers: 3
- Forks: 6
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## Badges
[](https://github.com/homettp/homettp/actions)
[](LICENSE.md)
## Features
- HTTP-based command runner
- Call history with collapsible command output
- Command management with re-generable tokens
- User authentication with remember me option
- User management
## Getting Started
Before you start, you need to install the prerequisites.
### Prerequisites
- Redis: `Version >= 5.0` for data storage
- `/bin/sh` on Linux/MacOS for command execution
- `cmd.exe` on Windows for command execution
### Run with Docker
Image can be found at package page on [GitHub](https://github.com/homettp/homettp/pkgs/container/homettp).
```
docker run --rm \
-e APP_URL=http://127.0.0.1:4000 \
-e APP_KEY=$(openssl rand -hex 16) \
-e REDIS_URL=redis://192.168.0.200:6379/0 \
-p 4000:4000 \
ghcr.io/homettp/homettp
```
### Install from binary
Downloads can be found at releases page on [GitHub](https://github.com/homettp/homettp/releases).
---
### Install from source
#### Prerequisites for building
- GO: `Version >= 1.20`
- Node.js: `Version >= 18.0`
- Yarn or NPM
#### 1. Clone the repository:
```
git clone git@github.com:homettp/homettp.git
```
#### 2. Open the folder:
```
cd homettp
```
#### 3. Install the UI dependencies
```
yarn install
```
#### 4. Build the UI
```
yarn prod
```
#### 5. Build the Homettp:
```
go build
```
#### 6. Copy the example configuration:
```
cp .env.example .env
```
## Configuration
The configruation is stored in the `.env` file.
### Application Key (encryption key)
- For example generate with `openssl rand -hex 16` command
```
APP_KEY=
```
### Application Address
```
APP_ADDR=:4000
```
### Application URL
```
APP_URL=http://127.0.0.1:4000
```
---
### Redis URL
```
REDIS_URL=redis://127.0.0.1:6379/0
```
### Redis Key Prefix
```
REDIS_KEY_PREFIX=homettp:
```
---
### Command Timeout (in seconds)
```
COMMAND_TIMEOUT=60
```
### Command Worker Count
```
COMMAND_WORKER_COUNT=2
```
### Command Histroy Limit
```
COMMAND_HISTORY_LIMIT=100
```
## Usage
The following commands show how to use the package.
### 1. Make a user
```
./homettp make user
```
### 2. Run the app
```
./homettp web serve
```
## Reporting Issues
If you are facing a problem with this package or found any bug, please open an issue on [GitHub](https://github.com/homettp/homettp/issues).
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.