Skip to main content

Run other programs in background

Project description

backrun

Run other (whitelisted) scripts (tasks) in background (and maybe as another userid) and save stdout/stderr in log. You may need this when you want to start other long-running scripts (like sync databases) from web-UI.

Run background tasks

Prepare config file backrun.toml, and run backrun.

When you need to start some background process, do this:

echo script1 > /var/backrun/task/123

This will create task file to run script1 with id 123.

Almost immediately backrun will start to execute script and write stdout/stderr to /var/backrun/tasklog/123.log.

When script will finish, backrun will delete task file.

Details

Script will be executed with uid of backrun script.

script will get environment of backrun. backrun will set two new environment variables for script: TASKID - if of task (e.g. "123"), TASKFILE - path to task file.

Backrun reads only first like of taskfile, so you can put everything (any text, YAML, JSON) starting with 2nd line and script can read it.

Example files

config file

Config file name is either passed as first argument to backrun or first existing file in: ./backrun.toml, ~/backrun.toml, /etc/backrun.toml.

taskdir = "/var/backrun/task"
logdir = "/var/backrun/tasklog"
sleep = 1
logfile = '/var/backrun/backrun.log'

[scripts]
    [scripts.script1]
    path="/usr/local/bin/script1.sh"

script file (script1.sh)

#!/bin/bash

log(){
    echo `date "+%Y-%m-%d %H:%M:%S"` $*
}

log started
sleep 10
>&2 log "error"
log finished

systemd service file

change User and ExecStart

[Unit]
Description=backrun: run whitelisted scripts in background

[Service]
ExecStart=/home/xenon/.local/bin/backrun
User=xenon

[Install]
WantedBy=multi-user.target

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

backrun-0.0.1.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

backrun-0.0.1-py3-none-any.whl (4.1 kB view details)

Uploaded Python 3

File details

Details for the file backrun-0.0.1.tar.gz.

File metadata

  • Download URL: backrun-0.0.1.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.25.2

File hashes

Hashes for backrun-0.0.1.tar.gz
Algorithm Hash digest
SHA256 245da55835f0589f19f63bf7058062d1a68f12b3c901394fc4cad85a20f4aca3
MD5 2735b72a56b254d6ac7b8717af3055a3
BLAKE2b-256 2f80474135c5e08a30600c580337d8a28fd427cf2b58121d02cd89088681a450

See more details on using hashes here.

File details

Details for the file backrun-0.0.1-py3-none-any.whl.

File metadata

  • Download URL: backrun-0.0.1-py3-none-any.whl
  • Upload date:
  • Size: 4.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-httpx/0.25.2

File hashes

Hashes for backrun-0.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 b764d3844a6a77db27fe88f23540679c0c76d9a9058c4aae1e840768e2c606f4
MD5 480ca084e055e1ce9219efeeb668f891
BLAKE2b-256 e26a32c826e9e39f6c2b74e8494a948e61a6aa1b4c9dc63b98f6e491750144cc

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page