Skip to content

A Custom Script Executor & Service Runner for Ubuntu

Notifications You must be signed in to change notification settings

SamHDev/blumerun

Repository files navigation

blumerun

A Custom Script Executor & Service Runner for Ubuntu

Features

  • Setup a script in a single command
  • Easy Install with a quick copy paste solution

Manage an Install

Install

sudo apt-get install wget -y -qq
sudo -q --no-cache wget https://raw.githubusercontent.com/SamHDev/blumerun/master/install.sh 
sudo chmod 777 install.sh
sudo bash install.sh
sudo rm install.sh

or as one quick copy paste solution:

sudo apt-get install wget -y -qq;sudo wget -q --no-cache https://raw.githubusercontent.com/SamHDev/blumerun/master/install.sh;sudo chmod 777 install.sh;sudo bash install.sh;sudo rm install.sh

Update

blumerun update

or if there is an issue:

sudo bash /usr/local/blumerun/update.sh

Uninstall

blumerun uninstall

or

sudo bash /usr/local/blumerun/uninstall.sh

Usage

Add a Script

All scripts are run from a bash file, regardless if they are python or java. You first need to create a .sh file to run your code. In this example I'm running a simple python script called looptest.py here is a quick demo script:

import time
count = 0
while True:
    print("LOOP! (",count,")")
    time.sleep(1)
    count = count + 1

Then I create a .sh file to run this named looptest.sh inside is the command to execute the python script:

#!/bin/sh
python3 -u loop.py

The -u argument for the python flushes all output from print commands allowing blumerun the see the output Next we add the script. We can run

blumerun add looptest

This should enter us into a wizard. Fill in the prompts like this example

Add Session Wizard:
        Description Name[Looptest]: Loop Demo #Pretty Print Name
        Working Directory[/root/]: 
        Script File[looptest.sh]:
Successfuly Added Script Loop Demo (looptest)

And done, its that simple, and it starts automagicly

Start/Stop/Restart a script

(Replace looptest with the id you added your script with)

To Start a stop script, simply run:

blumerun start looptest

Or to stop a script

blumerun stop looptest

And to restart the script

blumerun restart looptest

We can see if the script is running by using

blumerun status looptest

View a script's output

(Replace looptest with the id you added your script with)

To Get a quick snapshot of your programs latest output you can run:

blumerun output looptest

This should print out the last 260 lines

To see a constantly updating version, you can launch a console session by running:

blumerun console looptest

You can press CTRL+C to exit this.

Edit a script's details

(Replace looptest with the id you added your script with)

We can edit certian feature of a script using the blumerun edit command in this syntax:

blumerun edit <id> <key> <value>

Using our above examples we can change a value like so:

blumerun edit looptest restart false

or like so

blumerun edit looptest name Loop Test Demo

Here are the values you can change:

Key Example Value Desc
name Loop Test Demo The pretty print name of the script. Purely Asthetic
dir /root/loop/ The Working Directory for the script. Must end in a /
script start-loop.sh The file to execute on script start. Must have permissions to run chmod 777 <file>
onstart true / false Enable or Disable script start on startup or on server restart
restart true / false Enable or Disable script start on script crash or close

About

A Custom Script Executor & Service Runner for Ubuntu

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published