Giter VIP home page Giter VIP logo

script-server's Introduction

script-server

A tiny http server to run scripts.

Installation

Download the binary file from release page.

Building

script-server is written in Rust, so you will need to grab a Rust installation in order to compile it.

To build script-server

$ git clone https://github.com/jerrykingxyz/script-server
$ cd script-server
$ cargo build --release
$ ./target/release/script-server --help

To run the full test

$ cargo test

Usage

Run script-server --help to show command usage help.

Usage: script-server [OPTIONS] <SCRIPTS_DIR>

Arguments:
  <SCRIPTS_DIR> Scripts dir

Options:
  -l, --listen <LISTEN>  Listen address [default: 0.0.0.0:8000]
  -t, --token <TOKEN>    Access token in header
  -h, --help             Print help
  -V, --version          Print version

The request API is

curl -XPOST -H "X-ACCESS-TOKEN: <TOKEN>" -d "<Args>" http://<LISTEN>/<SCRIPT_PATH>
  • The method only supports POST, others will response with 404
  • The X-ACCESS-TOKEN header is required to configure the access token if exist
  • You can add script parameters to the http body and separate each parameter with \n
  • The <SCRIPT_PATH> is the relative path of the execute script in <SCRIPTS_DIR>

The response is

status code description body
404 Request method is not POST -
401 Incorrect access token -
403 The execution script does not exist or does not have execution permission -
500 The stderr is not empty after script execution stderr content
200 Execute the script successfully stdout content

See the test case for more usage examples

License

MIT licensed

script-server's People

Contributors

jerrykingxyz avatar

Stargazers

 avatar BenMix avatar

Watchers

 avatar

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.