Skip to content

robertjauss/RocketAudit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Rocket Audit

Overview

A simple admin dashboard for moderating user DMs in a Rocket.Chat instance. Such tools are normally only available in the enterprise (i.e. paid) editions of Rocket.Chat, but this uses the RC API to give that functionality to the masses. Definitely helps with community chats to make sure nothing against TOS is going on in DMs.

Technologies Used

  • Python
  • Django
  • Web Awesome
  • Docker
  • Docker Compose

Getting Started

  • Local development
    1. Ensure Python is installed
    2. Clone the repository: git clone <repository_url>
    3. Navigate to the project directory and create a virtual environment: python -m venv venv && source venv/bin/activate
    4. Install the project's dependencies: pip install -r requirements.txt
    5. Start the development server: python manage.py runserver
  • Production deployment
    1. Clone repo
    2. Build docker image: docker build -t rocket_audit .
    3. Start container: docker run -d rocket_audit
    4. Point web server (NGINX, Apache, etc.) at localhost:8000
  • Environmental variables
    • DJANGO_SECRET_KEY
      • 60 character random string
    • DEBUG (default 0)
      • Set to 1 to enable debugging mode. Don't run debugging mode in production.
    • ALLOWED_HOSTS (default localhost 127.0.0.1)
      • Space separated list of domains allowed to access the site
    • CSRF_TRUSTED_ORIGINS
      • Space separated list of schemas + domains allowed to POST to the site
    • ROCKET_CHAT_AUTH_TOKEN
      • Your admin auth token for interacting with the API
    • ROCKET_CHAT_USER_ID
      • The user ID to use for interacting with the API
    • ROCKET_CHAT_ROOT_URL
      • The full URL of your rocket.chat instance

License

This project is licensed under Apache-2.0 license.

About

An admin interface for moderating your Rocket.Chat instance DMs

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors