Skip to content
This repository was archived by the owner on Aug 14, 2025. It is now read-only.

erfjab/runner

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

2 Commits
 
 
 
 
 
 
 
 

Repository files navigation

Runner Template Repository

This repository serves as a template for running various scripts with different services, such as Git, Docker, and UV. Currently, it supports UV with Git and Alembic, with plans to expand support for additional services, including Docker, in the future.

Note: It's a new repo, so if you find any bugs, please let me know via issues

Script Overview

The script provided automates the installation, configuration, and management of a service. It includes functions for:

  • Checking dependencies: Verifies the required system and Python packages are installed.
  • Cloning the repository: Fetches the script source code from GitHub.
  • Managing the service: Supports starting, stopping, restarting, and checking the status of the service.
  • Logging: Captures both standard and error logs during execution.
  • Uninstalling the service: Completely removes the installation, service files, and logs.

Notes:

  • Installation: This script installs the necessary dependencies and prepares the service for running.
  • Service Management: Start, stop, or restart the service with systemd commands.
  • Logging: Logs are written to a specified log file for easy tracking of service operations.

Installation

  1. Fork this repository to your own account.
  2. Customize the installation script according to your needs.

Usage

After completing the installation, you can use the following commands:

  • Install Script:

    • public repo:

      sudo bash -c "$(curl -sL {GITHUB_INSTALL_URL})" @ install-script
    • private repo:

      sudo bash -c "$(curl -H 'Authorization: token {GITHUB_TOKEN}' -sL {GITHUB_INSTALL_URL})" @ install-script
  • Install the source:

    {SCRIPT_NAME} install
  • Install the service:

    {SCRIPT_NAME} install-service
  • Start the service and run the source:

    {SCRIPT_NAME} start
  • Stop the service:

    {SCRIPT_NAME} stop
  • Restart the service:

    {SCRIPT_NAME} restart
  • View status:

    {SCRIPT_NAME} status
  • View logs:

    {SCRIPT_NAME} logs
  • Update the script:

    {SCRIPT_NAME} update
  • Uninstall the service:

    {SCRIPT_NAME} uninstall

Contact & Support

Feel free to ⭐ the project to show your support!

Stargazers over time

About

This repository serves as a template for running various scripts with different services.

Topics

Resources

License

Stars

Watchers

Forks

Contributors

Languages