Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/calinux-py/ephemeral

Simple Remote Management Tool using Discord & Google Remote Desktop
https://github.com/calinux-py/ephemeral

bot discord discord-bot discord-powershell discord-python discord-python-bot ephemeral managed-service-providers managed-services powershell powershell-bot python python-bot remote-control remote-desktop remote-desktop-bot remote-desktop-manager remote-management rmm

Last synced: 4 days ago
JSON representation

Simple Remote Management Tool using Discord & Google Remote Desktop

Host: GitHub
URL: https://github.com/calinux-py/ephemeral
Owner: calinux-py
Created: 2024-08-09T01:09:26.000Z (about 2 months ago)
Default Branch: main
Last Pushed: 2024-09-07T03:25:23.000Z (27 days ago)
Last Synced: 2024-09-29T09:21:21.300Z (4 days ago)
Topics: bot, discord, discord-bot, discord-powershell, discord-python, discord-python-bot, ephemeral, managed-service-providers, managed-services, powershell, powershell-bot, python, python-bot, remote-control, remote-desktop, remote-desktop-bot, remote-desktop-manager, remote-management, rmm
Language: Python
Homepage:
Size: 19 MB
Stars: 3
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

# [ Ephemeral Logo ](https://github.com/calinux-py/Ephemeral) EphemeralRMM

Ephemeral is a free RMM using Discord and Chrome Remote Desktop API. It allows you to receive updates and control your devices from anywhere in the world using Discord.
It is a fun project.

| Supported | Features |
|--------|--------------------|
| ✅ | **Control devices remotely from Discord** |
| ✅ | **Remote into any device from Discord** |
| ✅ | **Guided enrollment of new devices** |
| ✅ | **List enrolled devices** |
| ✅ | **Status check on enrolled devices** |
| ✅ | **Real-time device feed** |
| ✅ | **Execute terminal cmds from Discord** |
| ✅ | **Real-time process monitoring** |

## Requirements
![Windows](https://img.shields.io/badge/platform-Windows-blue)![Python](https://img.shields.io/badge/language-Python-darkgreen)![PowerShell](https://img.shields.io/badge/language-PowerShell-purple)![Discord](https://img.shields.io/badge/Discord-7289DA?logo=discord&logoColor=white)![Google](https://img.shields.io/badge/Google-4285F4?logo=google&logoColor=white)

- Python 3.8+
- Discord Bot Token
- Discord Webhooks
- Google Remote Desktop
- PowerShell
- discord.py
- psutil
- requests

## Features

- **Device Enrollment**: Easily enroll new devices to the network using the `/enroll-device` command.
- **Device Listing**: View all enrolled devices and their details using the `/device-list` command.
- **Status Check**: Remotely check the status of any enrolled device with the `/check-status` command.
- **Discord Shell**: Execute Terminal (CMD) commands directly from Discord using the `/run` command. Return the output back to you in Discord.
- **Guided Enrollment**: Step-by-step instructions for enrolling a new device via the `/howto-enroll` command.

[ Ephemeral Logo ](https://github.com/calinux-py/Ephemeral)

## Setup

1. **Clone the Repository**:
```bash
git clone https://github.com/calinux-py/Ephemeral.git
cd ephemeral; cd ephemeral
```

2. **Install Dependencies**:
```powershell
pip install -r requirements.txt
```

3. **Configure Ephemeral**:
- Update `config/config.ini` with your Discord bot token and webhooks.
- `[LiveFeed]` is the Discord webhook where your devices will actively post device information in realtime.
- `[AgentStatus]` is the Discord webhook where agents will post device information when inquired.
- `[AgentCommands]` is the Discord webhook used by agents to return output from PowerShell commands.
- `[ProcessFeed]` is the Discord webhook used to update new running processes.
- LiveFeed, AgentStatus, and ProcessFeed can be the same Discord webhook (but not recommended).
- `[DiscordToken]` is where you enter your Discord Bot token.

4. **Convert Ephemeral source code into an .exe**:
```powershell
pyinstaller --onefile PATH/TO/EPHEMERAL.py
```

5. **Run Ephemeral**:
- Run Ephemeral-Head on a server or computer you are controlling.
- Run Ephemeral-Client on a Windows client device you want to control.

6. **Start Ephemeral (Hidden) Upon Each Boot**:
- Save the below PowerShell script as a `.ps1` file in your `Startup Folder`. You can easily access your `Startup Folder` by holding `CTRL+R` and typing `shell:startup`.
```powershell
cd "PATH\TO\Ephemeral\";
Start-Process -FilePath .\ephemeral.exe -WindowStyle hidden; Start-Process -FilePath .\agent3.ps1 -WindowStyle hidden
```

7. Optional: **Start Ephemeral (Hidden) Upon Each Boot WITHOUT Process Monitor**:
- Save the below PowerShell script as a `.ps1` file in your `Startup Folder`. You can easily access your `Startup Folder` by holding `CTRL+R` and typing `shell:startup`.

```powershell
cd "PATH\TO\Ephemeral\";
Start-Process -FilePath .\ephemeral.exe -WindowStyle hidden
```

## Commands

- `/device-list`: Lists all devices currently enrolled in the system.
- `/enroll-device`: Enrolls a new device into the system.
- `/check-status`: Checks the status of devices.
- `/run`: Execute PowerShell or cmd commands directly from Discord.
- `/howto-enroll`: Provides detailed instructions on how to enroll a new device.

[ Ephemeral Logo ](https://github.com/calinux-py/Ephemeral)

## PowerShell Agents
- **Agent.ps1**: used for checking statuses of all client agents. Returns output back to user in Discord.
- **Agent2.ps1**: used for running shell commands and returning output back to the user in Discord.
- **Agent3.ps1**: used for monitoring new processes and updating the user in Discord.

## License

MIT

[ Ephemeral Logo ](https://github.com/calinux-py/Ephemeral)