Giter Site home page Giter Site logo

Homettp

Badges

Build Status License: MIT

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.

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.


Install from source

Prerequisites for building

  • GO: Version >= 1.20
  • Node.js: Version >= 18.0
  • Yarn or NPM

1. Clone the repository:

git clone [email protected]: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 <username> <email> <password>

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.

License

The MIT License (MIT). Please see License File for more information.

Homettp's Projects

Homettp doesnโ€™t have any public repositories yet.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.