Skip to content

Commit 24ea33e

Browse files
authored
Update requirements.md
1 parent c58055c commit 24ea33e

File tree

1 file changed

+32
-17
lines changed

1 file changed

+32
-17
lines changed

docs/setup/requirements.md

Lines changed: 32 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,43 @@
11
---
2-
title: Requirements
2+
title: System Requirements
33
sidebar_position: 1
44
---
55

6-
# Requirements
7-
BryanBot is very easy to set up and use, but there are some requirements you need to meet before you can start using it.
6+
# BryanBot System Requirements
87

9-
## Hosting
10-
For hosting the bot, you will need a machine that can run Node.js. This can be your personal computer, a VPS, or a managed hosting service. For keeping the bot online 24/7, it is recommended to use a VPS or a managed hosting service.
8+
BryanBot is designed to be **efficient, scalable, and easy to deploy**. Whether you're running it on a personal computer, a VPS, or a dedicated server, meeting these requirements will ensure a smooth and reliable experience.
119

12-
The option that you choose needs to have Node.js installed on it. If you are going to use a VPS or personal computer, you can download Node.js from the [official website](https://nodejs.org/). Managed hosting services usually come with Node.js pre-installed.
10+
## Hosting Requirements
11+
BryanBot requires a system capable of running **Node.js**. This can be:
1312

14-
### Recommended hosting services
15-
We recommend using one of the following hosting services:
16-
- [Hetzner](https://www.hetzner.com/) - affordable VPS hosting
17-
- [NovoNode](https://novonode.com/) - affordable managed hosting
18-
- [Sparked Host](https://sparkedhost.com/) - user-friendly managed hosting
13+
- A **personal computer** (suitable for testing or temporary use)
14+
- A **VPS (Virtual Private Server)** (recommended for 24/7 uptime)
15+
- A **dedicated hosting service** (for ease of use without setup headaches)
1916

20-
## Installation methods
21-
:::note
17+
### Minimum System Requirements
18+
- **Processor:** 1 Core @ 2 GHz
19+
- **Memory:** 200 MB RAM (1 GB recommended for improved stability)
20+
- **Storage:** 500 MB available disk space
21+
- **Operating System:** Linux (Ubuntu/Debian recommended), Windows, or macOS
22+
- **Node.js Version:** Latest **LTS release** ([Download Here](https://nodejs.org/))
2223

23-
This part is still under development. Please check back later for more information.
24+
### Recommended System Specifications
25+
- **Processor:** 2+ Cores @ 3 GHz+ (for larger servers and heavier workloads)
26+
- **Memory:** 1 GB+ RAM (for optimal performance and addon usage)
27+
- **Storage:** 2 GB+ SSD (ensures faster data access and stability)
28+
- **Operating System:** Linux (Ubuntu 20.04+ preferred for security and efficiency)
29+
- **Node.js Version:** Latest **LTS release**
2430

25-
:::
31+
## Hosting Options
32+
If you prefer not to run BryanBot on your own hardware, consider using a hosting provider. These services offer VPS and managed hosting solutions tailored for running Discord bots.
33+
Using a dedicated host normally comes with a panel **designed for bots** allowing you to easily start and **manage your bot conveniently**. Whether you are using a **VPS** or a **bot host**, you should be able to
34+
achieve a **24/7** uptime on your **BryanBot Instance**
2635

27-
As of now, the only way to install and use BryanBot is to upload and run it from source.
28-
Other installation methods such as Docker installation are currently under development and will be available in the future.
36+
### Recommended Hosting Providers
37+
- **(Host) [NovoNode](https://novonode.com/)** – Managed hosting with simplified setup.
38+
- **(Host) [Sparked Host](https://sparkedhost.com/)** – Performance-focused bot hosting.
39+
- **(VPS) [Hetzner](https://www.hetzner.com/)** – Cost-effective and reliable VPS hosting.
40+
- **(VPS) [Contabo](https://contabo.com/)** – Affordable VPS solutions with generous resource allocations.
41+
42+
## Need Help?
43+
If you run into any issues or need assistance with installation, join our **[Discord Community](https://discord.gg/GvyuDDFeZU)** for support and discussions.

0 commit comments

Comments
 (0)