Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/erfjab/runner
This repository serves as a template for running various scripts with different services.
https://github.com/erfjab/runner
automation docker git installer runner script uv
Last synced: about 1 month ago
JSON representation
This repository serves as a template for running various scripts with different services.
- Host: GitHub
- URL: https://github.com/erfjab/runner
- Owner: erfjab
- License: mit
- Created: 2024-11-27T20:18:56.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2024-11-27T23:10:55.000Z (about 1 month ago)
- Last Synced: 2024-11-28T00:20:17.938Z (about 1 month ago)
- Topics: automation, docker, git, installer, runner, script, uv
- Language: Shell
- Homepage: https://t.me/ErfJabs
- Size: 5.86 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Runner Template Repository
This repository serves as a template for running various scripts with different services, such as Git, Docker, and [UV](https://docs.astral.sh/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:
```bash
sudo bash -c "$(curl -sL {GITHUB_INSTALL_URL})" @ install-script
```
- private repo:
```bash
sudo bash -c "$(curl -H 'Authorization: token {GITHUB_TOKEN}' -sL {GITHUB_INSTALL_URL})" @ install-script
```
- **Install the source**:
```bash
{SCRIPT_NAME} install
```
- **Install the service**:
```bash
{SCRIPT_NAME} install-service
```
- **Start the service and run the source**:
```bash
{SCRIPT_NAME} start
```
- **Stop the service**:
```bash
{SCRIPT_NAME} stop
```
- **Restart the service**:
```bash
{SCRIPT_NAME} restart
```
- **View status**:
```bash
{SCRIPT_NAME} status
```
- **View logs**:
```bash
{SCRIPT_NAME} logs
```
- **Update the script**:
```bash
{SCRIPT_NAME} update
```
- **Uninstall the service**:
```bash
{SCRIPT_NAME} uninstall
```
## Contact & Support
- Telegram Channel: [@ErfJabs](https://t.me/ErfJabs)
Feel free to ⭐ the project to show your support!
[](https://starchart.cc/erfjab/runner)