Giter Site home page Giter Site logo

hartl3y94 / black-mesa Goto Github PK

View Code? Open in Web Editor NEW

This project forked from blackmesadev/black-mesa

0.0 0.0 0.0 1.06 MB

An Aperture/Rowboat alternative written in Go for performance, with a target being that it can utilize existing configuration with no compatibility issues.

License: GNU General Public License v3.0

Go 99.81% Dockerfile 0.19%

black-mesa's Introduction

Black Mesa

CodeFactor Discord Lines of code GitHub tag (latest SemVer)

Black Mesa is a Discord Moderation bot designed with Performance, Reliability and Customization in mind.

Self Host Guide

Docker

The prefered and supported method of running the bot is via Docker with the provided docker-compose.yml.example file, you will be up and running in no time!

Installation (Linux)

  • You must first ensure you have up to date versions of Docker and Docker Compose
  • Download the source code for the project with git clone https://github.com/blackmesadev/black-mesa.git
  • You will then need to cp docker-compose.yml.example docker-compose.yml
  • Open the docker-compose.yml file with your preferred text editor and ensure you set the correct enviornment variables, they are listed accordingly. Do NOT forget to set a password for mongodb.
  • Once your docker-compose.yml file is in a state that you are happy with it, simply run docker-compose up --build -d to build and bring up the container detached.

Installation (Windows)

  • why are you trying to run a bot on windows

Usage

MongoDB

Black Mesa uses MongoDB as the database and will use it to read and write configuration data, actions and logs.

Black Mesa also uses Redis for short term variable sharing such as keeping record of CPU/Memory Usage, Automod Data, etc.

Black Mesa configuration is in docker-compse.yml, this is where you will store your Token, Mongo DB URI and Redis URI

If you are using Docker you will need to docker-compose build again before the configuration updates.

black-mesa's People

Contributors

coolyukii avatar damaredayo avatar lewisakura avatar lurr avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.