From fe60b73ad0a7a158b7f799648dcb278200665d6d Mon Sep 17 00:00:00 2001 From: "Jonny_Bro (Nikita)" Date: Sun, 22 Oct 2023 00:29:37 +0500 Subject: [PATCH] Update wiki (finally) --- Home.md | 4 +++- Self-Hosting.md | 36 +++++++++++++++++++++++++++++++ Главная.md | 1 - Установка-JaBa-на-своей-машине.md | 1 - 4 files changed, 39 insertions(+), 3 deletions(-) create mode 100644 Self-Hosting.md delete mode 100644 Главная.md delete mode 100644 Установка-JaBa-на-своей-машине.md diff --git a/Home.md b/Home.md index ef9b6b0..edd1f61 100644 --- a/Home.md +++ b/Home.md @@ -1 +1,3 @@ -Welcome to the JaBa wiki! +# Welcome to JaBa' wiki + +1. [How to self-host JaBa](https://github.com/JonnyBro/JaBa/wiki/Self-Hosting) \ No newline at end of file diff --git a/Self-Hosting.md b/Self-Hosting.md new file mode 100644 index 0000000..56f3da8 --- /dev/null +++ b/Self-Hosting.md @@ -0,0 +1,36 @@ +# Self Hosting + +## Before we start + +To self-host JaBa you will need this: + +* Some free time. +* Machine that runs Linux (I use Ubuntu myself) capable of running Node.js applications. +* [Node.js v18.15.0 or above](https://nodejs.org/). +* [Git](https://git-scm.com). +* [pnpm](https://pnpm.io/). +* [MongoDB v5.0 or above](https://www.mongodb.com/docs/v5.0/tutorial/install-mongodb-on-ubuntu/). + +## Edit configs + +1. Copy `config.sample.js` to `config.js`. +2. Open `config.js` and go through it, everything is commented. + * apiKeys are for any API key if you want to implement something yourself. + +> [!IMPORTANT] +> Unfortunately, *dashboard-core* package that is used for Dashboard is private for now, I'll open it later when it is done! + +## 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. + +## Installing dependencies + +1. `sudo apt update`. +2. For your bot to support music you need to install FFmpeg - `sudo apt install ffmpeg`. +3. `pnpm install`. +4. `node .`. + +> [!NOTE] +> 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/) diff --git a/Главная.md b/Главная.md deleted file mode 100644 index e7197f5..0000000 --- a/Главная.md +++ /dev/null @@ -1 +0,0 @@ -Добро пожаловать на вики JaBa! \ No newline at end of file diff --git a/Установка-JaBa-на-своей-машине.md b/Установка-JaBa-на-своей-машине.md deleted file mode 100644 index 58e8d16..0000000 --- a/Установка-JaBa-на-своей-машине.md +++ /dev/null @@ -1 +0,0 @@ -скоро будет... \ No newline at end of file