{"id":26093180,"url":"https://github.com/homettp/homettp","last_synced_at":"2025-04-13T10:53:14.167Z","repository":{"id":50302201,"uuid":"330038467","full_name":"homettp/homettp","owner":"homettp","description":"🏠 An HTTP-based command runner for home automation.","archived":false,"fork":false,"pushed_at":"2025-03-08T00:11:23.000Z","size":1111,"stargazers_count":65,"open_issues_count":0,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-27T02:11:19.558Z","etag":null,"topics":["command","go","golang","home-automation","http","inertiajs","redis","tailwindcss","vuejs"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/homettp.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-01-15T22:44:04.000Z","updated_at":"2025-03-08T00:11:26.000Z","dependencies_parsed_at":"2024-06-19T00:22:12.820Z","dependency_job_id":"de6aebf8-d179-4ab5-855b-ee08e11ca9a2","html_url":"https://github.com/homettp/homettp","commit_stats":{"total_commits":184,"total_committers":1,"mean_commits":184.0,"dds":0.0,"last_synced_commit":"dd0dc60aaafc4d78fde6cad5796ba8f4e753262e"},"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/homettp%2Fhomettp","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/homettp%2Fhomettp/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/homettp%2Fhomettp/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/homettp%2Fhomettp/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/homettp","download_url":"https://codeload.github.com/homettp/homettp/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248702999,"owners_count":21148116,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command","go","golang","home-automation","http","inertiajs","redis","tailwindcss","vuejs"],"created_at":"2025-03-09T11:56:09.818Z","updated_at":"2025-04-13T10:53:14.138Z","avatar_url":"https://github.com/homettp.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Homettp](https://user-images.githubusercontent.com/1419087/194723881-3ae9add0-f5a0-404c-aab0-2025dd5572a8.png)\n\n## Badges\n\n[![Build Status](https://github.com/homettp/homettp/workflows/tests/badge.svg)](https://github.com/homettp/homettp/actions)\n[![License: MIT](https://img.shields.io/badge/License-MIT-brightgreen.svg)](LICENSE.md)\n\n## Features\n\n- HTTP-based command runner\n- Call history with collapsible command output\n- Command management with re-generable tokens\n- User authentication with remember me option\n- User management\n\n## Getting Started\n\nBefore you start, you need to install the prerequisites.\n\n### Prerequisites\n\n- Redis: `Version \u003e= 5.0` for data storage\n- `/bin/sh` on Linux/MacOS for command execution\n- `cmd.exe` on Windows for command execution\n\n### Run with Docker\n\nImage can be found at package page on [GitHub](https://github.com/homettp/homettp/pkgs/container/homettp).\n\n```\ndocker run --rm \\\n-e APP_URL=http://127.0.0.1:4000 \\\n-e APP_KEY=$(openssl rand -hex 16) \\\n-e REDIS_URL=redis://192.168.0.200:6379/0 \\\n-p 4000:4000 \\\nghcr.io/homettp/homettp\n```\n\n### Install from binary\n\nDownloads can be found at releases page on [GitHub](https://github.com/homettp/homettp/releases).\n\n---\n\n### Install from source\n\n#### Prerequisites for building\n\n- GO: `Version \u003e= 1.20`\n- Node.js: `Version \u003e= 18.0`\n- Yarn or NPM\n\n#### 1. Clone the repository:\n\n```\ngit clone git@github.com:homettp/homettp.git\n```\n\n#### 2. Open the folder:\n\n```\ncd homettp\n```\n\n#### 3. Install the UI dependencies\n\n```\nyarn install\n```\n\n#### 4. Build the UI\n\n```\nyarn prod\n```\n\n#### 5. Build the Homettp:\n\n```\ngo build\n```\n\n#### 6. Copy the example configuration:\n\n```\ncp .env.example .env\n```\n\n## Configuration\n\nThe configruation is stored in the `.env` file.\n\n### Application Key (encryption key)\n\n- For example generate with `openssl rand -hex 16` command\n\n```\nAPP_KEY=\n```\n\n### Application Address\n\n```\nAPP_ADDR=:4000\n```\n\n### Application URL\n\n```\nAPP_URL=http://127.0.0.1:4000\n```\n\n---\n\n### Redis URL\n\n```\nREDIS_URL=redis://127.0.0.1:6379/0\n```\n\n### Redis Key Prefix\n\n```\nREDIS_KEY_PREFIX=homettp:\n```\n\n---\n\n### Command Timeout (in seconds)\n\n```\nCOMMAND_TIMEOUT=60\n```\n\n### Command Worker Count\n\n```\nCOMMAND_WORKER_COUNT=2\n```\n\n### Command Histroy Limit\n\n```\nCOMMAND_HISTORY_LIMIT=100\n```\n\n## Usage\n\nThe following commands show how to use the package.\n\n### 1. Make a user\n\n```\n./homettp make user \u003cusername\u003e \u003cemail\u003e \u003cpassword\u003e\n```\n\n### 2. Run the app\n\n```\n./homettp web serve\n```\n\n## Reporting Issues\n\nIf you are facing a problem with this package or found any bug, please open an issue on [GitHub](https://github.com/homettp/homettp/issues).\n\n## License\n\nThe MIT License (MIT). Please see [License File](LICENSE.md) for more information.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhomettp%2Fhomettp","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhomettp%2Fhomettp","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhomettp%2Fhomettp/lists"}