Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bugy/script-server

Web UI for your scripts with execution management
https://github.com/bugy/script-server

bash material-design python scripting ssh vuejs web-gui web-server websockets

Last synced: about 1 month ago
JSON representation

Web UI for your scripts with execution management

Awesome Lists containing this project

README 

        
[![Build Status](https://travis-ci.com/bugy/script-server.svg?branch=master&status=passed)](https://travis-ci.com/bugy/script-server) [![Gitter](https://badges.gitter.im/script-server/community.svg)](https://gitter.im/script-server/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)



# script-server

Script-server is a Web UI for scripts.  



As an administrator, you add your existing scripts into Script server and other users would be able to execute them via a web interface.

The UI is very straightforward and can be used by non-tech people.



No script modifications are needed - you configure each script in Script server and it creates the corresponding UI with parameters and takes care of validation, execution, etc.  



[DEMO server](https://script-server.net/)



[Admin interface screenshots](https://github.com/bugy/script-server/wiki/Admin-interface)



## Features

- Different types of script parameters (text, flag, dropdown, file upload, etc.)

- Real-time script output

- Users can send input during script execution

- Auth (optional): LDAP, Google OAuth, htpasswd file

- Access control

- Alerts

- Logging and auditing

- Formatted output support (colors, styles, cursor positioning, clearing)

- Download of script output files

- Execution history

- Admin page for script configuration



For more details check [how to configure a script](https://github.com/bugy/script-server/wiki/Script-config)

or [how to configure the server](https://github.com/bugy/script-server/wiki/Server-configuration)



## Requirements



### Server-side



Python 3.7 or higher with the following modules:



* Tornado 5 / 6



Some features can require additional modules. Such requirements are specified in a corresponding feature description.



OS support:



- Linux (main). Tested and working on Debian 10,11

- Windows (additional). Light testing

- macOS (additional). Light testing



### Client-side



Any more or less up to date browser with enabled JS



Internet connection is **not** needed. All the files are loaded from the server.



## Installation

### For production

1. Download script-server.zip file from [Latest release](https://github.com/bugy/script-server/releases/latest) or [Dev release](https://github.com/bugy/script-server/releases/tag/dev)

2. Create script-server folder anywhere on your PC and extract zip content to this folder



(For detailed steps on linux with virtualenv, please see [Installation guide](https://github.com/bugy/script-server/wiki/Installing-on-virtualenv-(linux)))



##### As a docker container

Please find pre-built images here: https://hub.docker.com/r/bugy/script-server/tags  

For the usage please check [this ticket](https://github.com/bugy/script-server/issues/171#issuecomment-461620836)



### For development

1. Clone/download the repository

2. Run 'tools/init.py --no-npm' script



`init.py` script should be run after pulling any new changes



If you are making changes to web files, use `npm run build` or `npm run serve`



### A issue running on OpenBSD and maybe other UNIX systems

See [A issue running on OpenBSD and maybe other UNIX systems](https://github.com/bugy/script-server/wiki/OpenBSD-process-termination-issues).



## Setup and run

1. Create configurations for your scripts in *conf/runners/* folder (see [script config page](https://github.com/bugy/script-server/wiki/Script-config) for details)

2. Launch launcher.py from script-server folder

  * Windows command: launcher.py

  * Linux command: ./launcher.py

3. Add/edit scripts on the admin page



By default, the server will run on http://localhost:5000



### Server config

All the features listed above and some other minor features can be configured in *conf/conf.json* file. 

It is allowed not to create this file. In this case, default values will be used.

See [server config page](https://github.com/bugy/script-server/wiki/Server-configuration) for details



### Admin panel

Admin panel is accessible on admin.html page (e.g. http://localhost:5000/admin.html)



## Logging



All web/operating logs are written to the *logs/server.log*

Additionally each script logs are written to separate file in *logs/processes*. File name format is

{script\_name}\_{client\_address}\_{date}\_{time}.log.



## Testing/demo



Script-server has bundled configs/scripts for testing/demo purposes, which are located in samples folder. You can

link/copy these config files (samples/configs/\*.json) to server config folder (conf/runners).



## Security



I do my best to make script-server secure and invulnerable to attacks, injections or user data security. However to be

on the safe side, it's better to run Script server only on a trusted network.  

Any security leaks report or recommendations are greatly appreciated!



### Shell commands injection



Script server guarantees that all user parameters are passed to an executable script as arguments and won't be executed

under any conditions. There is no way to inject fraud command from a client-side. However, user parameters are not

escaped, so scripts should take care of not executing them also (general recommendation for bash is at least to wrap all

arguments in double-quotes). It's recommended to use typed parameters when appropriate, because they are validated for

proper values and so they are harder to be subject of commands injection. Such attempts would be easier to detect also.



_Important!_ Command injection protection is fully supported for Linux, but _only_ for .bat and .exe files on Windows



### XSS and CSRF



_(v1.0 - v1.16)_  

Script server _is_ vulnerable to these attacks.



_(v1.17+)_  

Script server is protected against XSRF attacks via a special token.      

XSS protection: the code is written according to

[OWASP Cheat Sheet](https://cheatsheetseries.owasp.org/cheatsheets/DOM_based_XSS_Prevention_Cheat_Sheet.html)

and the only **known** vulnerabilities are:



* `output_format`=`html_iframe`, see the reasoning in the

  linked [Wiki page]((https://github.com/bugy/script-server/wiki/Script-config#output_format))



## Contribution



If you like the project and think you could help with making it better, there are many ways you can do it:



- Create a new issue for new feature proposal or a bug

- Implement existing issues (there are quite some of them: frontend/backend, simple/complex, choose whatever you like)

- Help with improving the documentation

- Set up a demo server

- Spread a word about the project to your colleagues, friends, blogs or any other channels

- Any other things you could imagine



Any contribution would be of great help and I will highly appreciate it! 

If you have any questions, please create a new issue, or contact me via [email protected]



## Asking questions

If you have any questions, feel free to:

- Ask in gitter: https://gitter.im/script-server/community

- or [create a ticket](https://github.com/bugy/script-server/issues/new)

- or contact me via email: [email protected] (for some non-shareable questions)



## Special thanks

![JetBrains logo](https://github.com/JetBrains/logos/blob/master/web/jetbrains/jetbrains.svg)