jonny_bro/JaBa
1
0
Fork 0
mirror of https://github.com/JonnyBro/JaBa.git synced 2024-11-25 14:44:58 +05:00
Code Issues Projects Releases Packages Wiki Activity

update wiki

Jonny_Bro (Nikita) 2024-02-09 18:10:48 +05:00
parent 0f119adf26
commit 6deac0fdbe
No known key found for this signature in database
GPG key ID: 391C19BE62D36B33
1 changed files with 15 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
Self-Hosting.md

@ -1,36 +1,39 @@
# Self Hosting # Self Hosting
## Before we start ## Before We Start
To self-host JaBa you will need this: To host JaBa yourself you will need this:
* Some free time. * Some free time.
* Machine that runs Linux (I use Ubuntu myself) capable of running Node.js applications. * Machine that runs Linux (I use Ubuntu myself) capable of running Node.js applications.
* [Node.js v18.15.0 or above](https://nodejs.org/). * [Node.js v18.15.0 or above](https://nodejs.org/) (You can use NVM to manage your Node installations).
* [Git](https://git-scm.com). * [Git](https://git-scm.com).
* [pnpm](https://pnpm.io/). * [pnpm](https://pnpm.io/).
* [MongoDB v5.0 or above](https://www.mongodb.com/docs/v5.0/tutorial/install-mongodb-on-ubuntu/). * [MongoDB v5.0 or above](https://www.mongodb.com/docs/v5.0/tutorial/install-mongodb-on-ubuntu/).
## Edit configs > [!NOTE]
> I'm not sure about memory requirements because right now JaBa can consume up to several GBs of RAM when restart is not scheduled!
## Edit Configs
1. Copy `config.sample.js` to `config.js`. 1. Copy `config.sample.js` to `config.js`.
2. Open `config.js` and go through it, everything is commented. 2. Open `config.js` and go through it, everything is commented.
* apiKeys are for any API key if you want to implement something yourself. * apiKeys are for any API key if you want to implement something yourself.
> [!IMPORTANT] > [!IMPORTANT]
> Unfortunately, *dashboard-core* package that is used for Dashboard is private for now, I'll open it later when it is done! > Unfortunately, *dashboard-core* package that is used for Dashboard is private for now, I'll open it when it's done!
## Custom Emojis ## Custom Emojis
JaBa uses AtlantaBot's emojis. You need to join and invite your bot to their server to gain access to them or you can make your own. JaBa uses AtlantaBot's emojis. You need to join and invite your bot to their server to gain access to them or you can make your own.
## Installing dependencies ## Installing Dependencies
1. `sudo apt update`. 1. For your bot to support music you need to install FFmpeg - `sudo apt update && sudo apt install ffmpeg`.
2. For your bot to support music you need to install FFmpeg - `sudo apt install ffmpeg`. 2. `pnpm install`.
3. `pnpm install`. 3. `node .`.
4. `node .`.
> [!NOTE] > [!NOTE]
> You can use PM2, it will manage your bot's process and run the bot automatically if machine is restarted. > You can use PM2, it will manage your bot's process and run the bot automatically if machine is restarted.\
> [Get PM2 here](https://pm2.keymetrics.io/) > [Get PM2 here](https://pm2.keymetrics.io/)\
> To run JaBa with PM2 use this command `pm2 start --name bot-name index.js`