tgpholly/Binato
1
0
Fork 0
Code Issues 4 Pull requests Projects Releases Packages Wiki Activity Actions

Update README.md

Browse source
This commit is contained in:
Holly Stubbs 2022-07-11 10:39:15 +01:00 committed by GitHub
parent b7a4e8c451
commit eb9522a670
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 18 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -15,14 +15,24 @@ i'm sorry peppy
- Minimum Viable Product of a bot - Minimum Viable Product of a bot
- For a command list check [BotCommandHandler](https://github.com/tgpethan/Binato/blob/master/server/BotCommandHandler.js) or use !help on a live server - For a command list check [BotCommandHandler](https://github.com/tgpethan/Binato/blob/master/server/BotCommandHandler.js) or use !help on a live server
### [List of bugs](https://github.com/tgpethan/Binato/issues?q=is%3Aopen+is%3Aissue+label%3Abug) ### [Planned additions](https://github.com/tgpethan/Binato/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement) | [List of currently known bugs](https://github.com/tgpethan/Binato/issues?q=is%3Aopen+is%3Aissue+label%3Abug)
<hr> <hr>
## Support: ## Setup:
While I don't support setting this up yourself (although this is pretty flexible as it stands right now) I will try my best to support this in the time I have. Just make sure you have general knowlage of databases (MySQL in this case) and Node.js . While I don't support setting this up yourself it is fairly easy to do, all that should be required is:
- **NodeJS >= 10**
- **MariaDB or MySQL** (MariaDB is prefered as that is what this is tested and ran against in prod)
- Optional (Disabled via config):
- **Redis**
- **Prometheus**
Just open a issue and I will get around to it eventually. Clone the repo and run `npm i` to install required packages, then copy `config.example.json` to `config.json` and edit to your liking (this is where http compression, prometheus and redis can be enabled/disabled)
After doing this running `node .` should start the server
## Reporting bugs:
To report a bug [create a new issue](https://github.com/tgpethan/Binato/issues/new) and include information such as your OS / Distro, Node version, disabled Binato features (e.g. Prometheus, Redis, compression) and console output at the time of the bug if applicable.
<hr> <hr>
@ -33,6 +43,7 @@ Stable fallback uses HTTP so for that you just need to direct it to the server<b
You can do this using the hosts file You can do this using the hosts file
Location on Linux: /etc/hosts<br> Location on Linux: /etc/hosts<br>
Location on Mac: /private/etc/hosts<br>
Location on Windows: C:/Windows/system32/drivers/etc/hosts Location on Windows: C:/Windows/system32/drivers/etc/hosts
Add an entry in the hosts file that looks like the following: Add an entry in the hosts file that looks like the following:
@ -64,8 +75,8 @@ An example setup would be:
- a.example.com (Profile pictures) - a.example.com (Profile pictures)
<hr> <hr>
## Things not included in this repo: ## Other Binato components:
### Website ### Website:
Binato's website is handled by [Binato-Website](https://github.com/tgpethan/Binato-Website) Binato's website is handled by [Binato-Website](https://github.com/tgpethan/Binato-Website)
### Profile Pictures: ### Profile Pictures:
Profile pictures can be handled by any standard HTTP server, there is also one I made for the task here: [Binato-ProfilePicture](https://github.com/tgpethan/Binato-ProfilePicture) Profile pictures can be handled by any standard HTTP server, there is also one I made for the task here: [Binato-ProfilePicture](https://github.com/tgpethan/Binato-ProfilePicture)