https://github.com/erfjab/ServerManagerBot
ServerManagerBot is a Telegram bot for managing Hetzner servers. It allows admins to control server actions.
https://github.com/erfjab/ServerManagerBot
Last synced: 14 days ago
JSON representation
ServerManagerBot is a Telegram bot for managing Hetzner servers. It allows admins to control server actions.
- Host: GitHub
- URL: https://github.com/erfjab/ServerManagerBot
- Owner: erfjab
- Created: 2024-09-11T18:20:57.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2025-02-13T23:46:48.000Z (2 months ago)
- Last Synced: 2025-03-18T16:40:50.575Z (28 days ago)
- Language: Python
- Homepage: https://t.me/Erfjabs
- Size: 71.3 KB
- Stars: 47
- Watchers: 1
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
- awesome-hcloud - ServerManagerBot
README
## Prerequisites
Ensure the following requirements are met before proceeding with installation:
- **Operating System**: Ubuntu
- **Permissions**: Root or sudo access
## Installation
To install the `ServerManagerBot` bot, execute the following commands:
1. Download and set up the script:
```bash
sudo bash -c "$(curl -sL https://raw.githubusercontent.com/erfjab/ServerManagerBot/master/install.sh)" @ install-script
```
2. Install the bot:
```bash
ServerManagerBot install
```
3. Set up the system service:
```bash
ServerManagerBot install-service
```
4. Start the handler:
```bash
ServerManagerBot start
```
### Installation Details
The above steps will:
1. **Check and Install Dependencies**: Ensure all necessary software is installed.
2. **Clone Repository**: Retrieve the `ServerManagerBot` repository securely.
3. **Create Python Environment**: Set up an isolated environment for Python packages.
4. **Create and Enable Service**: Register `ServerManagerBot` as a system service.
5. **Launch the Bot**: Start the bot, which will run continuously in the background.
## Usage
After installation, you can manage the `ServerManagerBot` bot using the following commands:
```bash
ServerManagerBot
```
### Commands
- `install`: Set up the bot, including dependencies and initial configuration.
- `start`: Start the bot service.
- `stop`: Stop the bot service.
- `restart`: Restart the bot service.
- `status`: Check the current status of the bot service.
- `logs`: View the bot’s logs in real time.
- `update`: Pull the latest changes from the repository and apply updates.
- `uninstall`: Fully remove the bot and all related files.
- `help`: Display a help message with all available commands.
## Directory Structure
- **Installation Directory**: `/opt/erfjab/ServerManagerBot`
- **Log File**: `/opt/erfjab/ServerManagerBot/ServerManagerBot.log`
- **Service File**: `/etc/systemd/system/ServerManagerBot.service`
## Uninstallation
To completely remove `ServerManagerBot` and all associated files, execute:
```bash
sudo ServerManagerBot uninstall
```