Clam Shell is a self-hosted anti-virus engine for Discord servers, powered by the open-source ClamAV engine. It provides real-time scanning of files and URLs shared within your Discord server, ensuring a safe and secure environment for your community. Clam Shell also features phishing detection by referencing a list of phishing URLs, which is automatically updated every 12 hours. Additionally, it supports posting logs to a designated Discord channel for easy monitoring if desired.
- Discord Bot Integration: Monitors your Discord server for file and URL sharing, and queues them for scanning.
- ClamAV Engine: Utilizes the powerful and open-source ClamAV engine for virus scanning.
- Phishing Detection: Detects phishing URLs by referencing an up-to-date list, ensuring protection against online threats.
- Automatic Updates: The phishing URL list is automatically updated every 12 hours to keep your server protected against new threats.
- Discord Logging: Posts logs to a designated Discord channel for easy monitoring.
- Automated Safety: Deletes, removes, reports messages that are sending infected attachment/urls.
- Improve Phishing bank ( currently this is only pulling from Phishing Database )
- Improve Discord Bot message formatting
- Add other malicious URL type processing & checks
- Add editing configurations through Discord Bot
If you find any of my work useful and want to help support Development
- Before you begin, ensure you have Docker and Docker Compose installed on your system.
- According to ClamAV Docs, the av server recommends having 4GiB of available RAM, with a minimum of 3GiB
-
Obtain the Docker Compose file and the configuration template:
- Create a
docker-compose.yamlfile:
- Create a
version: '3.8'
services:
clamshell_server:
image: clamav/clamav:latest
container_name: clamshell_server
networks:
- clamshell_network
rabbitmq:
image: rabbitmq:3-management
ports:
- "5672:5672"
- "15672:15672" # For RabbitMQ management interface
networks:
- clamshell_network
clamshell_worker:
image: qolors/clamshell_worker:latest
container_name: clamshell_worker
volumes:
- ./config.json:/app/config.json
networks:
- clamshell_network
clamshell_bot:
image: qolors/clamshell_bot:latest
container_name: clamshell_bot
volumes:
- ./config.json:/app/config.json
networks:
- clamshell_network
networks:
clamshell_network:- Create a
config.jsonfile:
{
"Settings": {
"BOT_TOKEN": "YOUR_BOT_TOKEN",
"WEBHOOK_URL": "YOUR_WEBHOOK_URL",
"USE_LOGS": true,
"USE_REACTIONS": true
}
}-
Configure Clam Shell:
- Edit
config.jsonto set your Discord bot token, webhook URL for logging, and other configuration options - If your
config.jsonfile is not in the same location as yourdocker-compose.yaml, update the volumes path
- Edit
-
Start Clam Shell:
docker-compose up -d
- "BOT_TOKEN": Required Bot Token. If unfamiliar take a look here
- "WEBHOOK_URL":" This is required if you desire to log the bot's messages. If unfamiliar take a look here
- "USE_LOGS": If you do not want to enable the logging, set this to false otherwise keep true
- "USE_REACTIONS": If enabled, the bot will react to all files it processes with a ✅ to let you know it's been verified
Once Clam Shell is up and running, it will automatically start monitoring your Discord server for file and URL sharing. If a file or URL is detected, it will be queued for scanning by the ClamAV engine. Detected threats and logs will be reported in the designated Discord channel.
To update Clam Shell, pull the latest Docker images and restart the services:
docker-compose pull
docker-compose down
docker-compose up -dContributions are welcome! Please feel free to submit pull requests or open issues to improve the software.
Clam Shell is released under the MIT License.