https://github.com/avatarkava/beavisbot

A node.js powered bot for plug.dj and dubtrack.fm
https://github.com/avatarkava/beavisbot

Last synced: about 1 month ago
JSON representation

A node.js powered bot for plug.dj and dubtrack.fm

• Host: GitHub
• URL: https://github.com/avatarkava/beavisbot
• Owner: avatarkava
• License: mit
• Created: 2014-01-12T11:25:54.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2022-12-12T04:30:20.000Z (about 2 years ago)
• Last Synced: 2024-08-01T21:55:07.282Z (5 months ago)
• Language: JavaScript
• Homepage: https://github.com/avatarkava/beavisbot/wiki
• Size: 9.55 MB
• Stars: 22
• Watchers: 8
• Forks: 20
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• starred - avatarkava/beavisbot - A node.js powered bot for plug.dj and dubtrack.fm (JavaScript)

README

        
BeavisBot

==========

BeavisBot is a heavily-adapted port of the turntable.fm SparkleBot that has migrated from TT.fm to plug.dj to dubtrack.fm.

This bot uses https://github.com/anjanms/DubAPI as its API dependency and is designed to be run using a node.JS instance.

Quick Installation

-----------------------

1. Run `npm install` in the root folder of the checkout

2. Copy the config.sample.json from /documentation to the root folder and rename it config.json

3. Edit config.json to suit your needs

4a. If you are using MySQL, run the documentation/tables.sql file against the database to create all the necessary tables

4b. If you are using SQLite, copy the supplied sample.sqlite to the root folder and rename it to align with your settings in config.json

Known issues are located at https://github.com/AvatarKava/beavisbot/issues - please submit any bug reports or feature requests there!

Logging and Log Rotation

------------------------

Full details are here: https://github.com/Unitech/pm2

Start the process in pm2 with custom log locations:

```

pm2 start /srv/web/apps/plug.dj/BeavisBot/bot.js --name beavisbot -o /var/log/node/beavisbot.log -e /var/log/node/beavisbot.err --log-date-format 'YYYY-MM-DD HH:mm:ss'

```

Set pm2 to automatically run on startup

```

pm2 startup 

```

Save the processes running so they get restored any time pm2 is started

```

pm2 save

```

then in /etc/logrotate.d, create a file (name it whatever you like, "node" works well here) and use

this or something along these lines as the contents:

```

/var/log/node/* {

    daily

    rotate 30

    missingok

    notifempty

    sharedscripts

    copytruncate

    compress

    delaycompress

    dateext

}

```

This will do a daily rotation of the logs and save the last 30 days.