/[sudobot]/trunk/docs/app/(docs)/getting-started/page.mdx

Diff of /trunk/docs/app/(docs)/getting-started/page.mdx

Parent Directory | Revision Log | View Patch Patch

-revision 575 by rakinar2,
Mon Jul 29 17:59:26 2024 UTC
+revision 626 by rakinar2,
Sat Sep  7 09:38:45 2024 UTC
 Line 1
  ---
- title: Getting Started - SudoBot
+ title: Getting Started
  short_name: Getting Started
  ---
 Line 17 
 This guide will help you get started wit
  ## Prerequisites
+ <Callout type="warning">
+     This guide assumes you have a Linux/Unix-based system where you'll install SudoBot. Windows users, please [scroll down](#windows-compatibility) to see how you can run SudoBot on Windows.
+ </Callout>
  Before you start, you need to have the following installed on your system:
  - A Discord API Application token (bot token). Go to the [Discord Developer Portal](https://discord.com/developers/applications) to create a new application, and get the token.
-Line 34 
 Lastly, we expect you to have a very bas
+Line 38 
 Lastly, we expect you to have a very bas
  ## Installation
- To install SudoBot, you need to clone the repository first, if you have Git installed. Run the following command in your terminal:
+ To install SudoBot, you need to clone the [git](https://git-scm.com) repository or checkout the [svn](https://subversion.apache.org/) repository first, if you have git installed. Run the following command in your terminal:
  ```bash
  git clone https://github.com/onesoft-sudo/sudobot
  ```
- If you don't have Git installed, you can download the repository as a zipball/tarball from the [GitHub Releases Page](https://github.com/onesoft-sudo/sudobot/releases/latest).
+ You can also checkout the [svn](https://subversion.apache.org/) repository:
+ ```bash
+ svn checkout https://svn.onesoftnet.eu.org/svn/sudobot sudobot
+ ```
+ If you don't have git or svn installed, you can download the repository as a zipball/tarball from the [GitHub Releases Page](https://github.com/onesoft-sudo/sudobot/releases/latest).
  Then, extract the downloaded file to a directory of your choice.
  Next, navigate to the directory where you have cloned the repository using Git, or extracted the zipball/tarball, by running the following command in your terminal:
-Line 49 
 Next, navigate to the directory where yo
+Line 59 
 Next, navigate to the directory where yo
  cd sudobot
  ```
+ ### Building SudoBot for Node.js
  Now, to build the project, we'll use [BlazeBuild](https://github.com/onesoft-sudo/sudobot/tree/main/blazebuild), which is a blazingly fast build tool, for TypeScript and JavaScript projects.
  To use BlazeBuild, you don't need to install anything including BlazeBuild itself, as it will be installed and set-up automatically during the build process.
  BlazeBuild will also make sure to install any missing SDKs or tools required for building the project.
-Line 63 
 This will build, compile and package the
+Line 75 
 This will build, compile and package the
  Depending on your system, the build process may take a few seconds to a few minutes to complete.
  We recommend using a system with at least 8GB of RAM and 2 CPU cores for faster build times.
- If you don't have enough resources, this command will fail with heap allocation errors. If that happens, or if you don't want to build it yourself, don't worry. You can download prebuilt versions for every release. The builds are tested on Node.js **v21**, however they should also work with **v20**.
+ If you don't have enough memory, this command might fail with heap allocation errors. If that happens, or if you don't want to build it yourself, don't worry. You can download prebuilt versions for every release. The builds are tested on Node.js **v22**, however they should also work with **v20** and **v21**.
  You might see that only Linux and macOS (darwin) releases are available. This doesn't mean you cannot run the bot on Windows systems - only the native bindings are platform dependent. You don't need to worry about that in most cases and the bot will just work fine.
  You can download the prebuilt versions in the GitHub releases page: https://github.com/onesoft-sudo/sudobot/releases/latest
  As always if you ever encounter errors with commands or you see something is not working as you expect, you can join our [Discord Server](https://discord.gg/892GWhTzgs) and ask for help!
+ ### Building SudoBot for Bun
+ If you'd like to use Bun instead of Node.js to run SudoBot, then you don't need to build the bot because Bun supports TypeScript natively. Just skip to the next part and follow the commands and instructions specifically for Bun.
  ## Configuration
  After building the project, you need to configure the bot to run on your server.
-Line 104 
 HOME_GUILD_ID=your-home-guild-id
+Line 120 
 HOME_GUILD_ID=your-home-guild-id
  # separately, you can format it to look like this.
  DB_URL=postgresql://username:password@hostname:port/database
- # JWT Secret for generating JWT tokens.
+ # JWT Secret for generating JWT tokens. This is like a password for
- # On systems with openssl installed, you can generate a random
+ # the bot's internal use.
+ # On Linux/Unix systems with OpenSSL installed, you can generate a random
  # secret using the following command:
  #
  #    openssl rand -base64 32
-Line 113 
 DB_URL=postgresql://username:password@ho
+Line 130 
 DB_URL=postgresql://username:password@ho
  # Replace `your-jwt-secret` with the generated secret.
  JWT_SECRET=your-jwt-secret
+ # The directory where the bot will store persistent data like
+ # configuration files, logs, and more.
+ SUDO_PREFIX=/path/to/sudobot/storage
  # Optionally, you can uncomment the following to turn on debug mode
  # to see more detailed logs, and enable certain development features.
-Line 129 
 The guild-wide configuration file is `co
+Line 150 
 The guild-wide configuration file is `co
  The files are located at `config/` in the project root. These configuration files don't contain any specific setting, they are just a starting point for you to configure the bot.
  You can edit these files to your liking.
+ Then, go to the `SUDO_PREFIX` directory, and copy the `config` directory to the `SUDO_PREFIX` directory.
+ This should also copy the `config.json` and `system.json` files to the `SUDO_PREFIX` directory, that you just edited.
+ **Remember, this step is important. Otherwise, any updates to the configuration files will be lost when you update the bot using Git.**
  To see all the possible configuration options, please refer to these schema files:
  - [Guild Configuration Schema](https://github.com/onesoft-sudo/sudobot/blob/main/src/main/typescript/schemas/GuildConfigSchema.ts)
-Line 158 
 After configuring the bot, you can run i
+Line 184 
 After configuring the bot, you can run i
  By default, BlazeBuild will use [Bun](https://bun.sh) to run the bot. If you want to use Node.js instead, you can run the following command:
  ```bash
- ./blazew run -- --node
+ ./blazew run --node
  ```
  This will start the bot, and you should see the bot online in your Discord server.
-Line 172 
 The bot uses [Discord's Application Comm
+Line 198 
 The bot uses [Discord's Application Comm
  To register the application commands to the Discord API, you can run the following command:
  ```bash
- ./blazew run -- -- -u
+ ./blazew run -- -u
  ```
  If you have debug mode enabled and have `HOME_GUILD_ID` set in the `.env` file, the bot will register the commands in the development guild.
-Line 181 
 If you don't have debug mode enabled, th
+Line 207 
 If you don't have debug mode enabled, th
  If you want to force the bot to register the commands globally, you can run the following command:
  ```bash
- ./blazew run -- -- -u -g
+ ./blazew run -- -u -g
  ```
  To clear the registered commands, you can run the following command:
  ```bash
- ./blazew run -- -- -c
+ ./blazew run -- -c
  ```
  Once again, if you have debug mode enabled, the bot will clear the commands in the development guild. Otherwise, it will clear the commands globally.
  To force the bot to clear the commands globally, you can run the following command:
  ```bash
- ./blazew run -- -- -c -g
+ ./blazew run -- -c -g
+ ```
+ ## Windows Compatibility
+ SudoBot was created with Linux/Unix-based systems in mind, since in most cases you're going to end up running SudoBot on a production server which is usually Linux/Unix-based.
+ However, that doesn't mean you can't run SudoBot on Windows &mdash; but please keep in mind that some things might need tweaks or you might need to do some things differently to make it work on Windows.
+ **First of all**, BlazeBuild on Windows is still experimental, known to have some issues. So please run the following commands as alternatives:
+ **Install dependencies**
+ ```bash
+ bun install
+ ```
+ If using Node:
+ ```bash
+ npm install -D
+ ```
+ You might get an error saying something like `symlink(): Operation not permitted` &mdash; this is fine and you can safely ignore it.
+ **Build the project (Skip this if using Bun)**
+ ```bash
+ npm run build
+ ```
+ **Copy the resource files**
+ Please copy the following resources from `src` to `build`:
+ * `src/main/resources` should be copied to `build/out/main` and the name should still be `resources`
+ **Run the Database Migrations**
+ Please first make sure you have the right credentials in your `.env` file. Then, create a new file named `migrate.ts` in the project root with the following contents:
+ ```typescript
+ import "dotenv/config";
+ const { drizzle } = await import(String("drizzle-orm/node-postgres"));
+ const { migrate } = await import(String("drizzle-orm/node-postgres/migrator"));
+ const { Pool } = await import(String("pg"));
+ const pool = new Pool({
+     connectionString: process.env.DB_URL
+ });
+ const db = drizzle(pool);
+ await migrate(db, { migrationsFolder: "drizzle" });
+ await pool.end();
+ ```
+ Then run this file:
+ ```bash
+ bun migrate.ts
+ ```
+ If you'd like to use Node.js for this, then create a `migrate.js` file instead and paste the following:
+ ```javascript
+ require("dotenv/config");
+ async function main() {
+     const { drizzle } = await import(String("drizzle-orm/node-postgres"));
+     const { migrate } = await import(String("drizzle-orm/node-postgres/migrator"));
+     const { Pool } = await import(String("pg"));
+     const pool = new Pool({
+         connectionString: process.env.DB_URL
+     });
+     const db = drizzle(pool);
+     await migrate(db, { migrationsFolder: "drizzle" });
+     await pool.end();
+ }
+ main();
  ```
+ And run:
+ ```bash
+ node migrate.js
+ ```
+ And if everything was correctly set up, your database will have the new tables created for SudoBot.
+ **Starting the Bot**
+ Be sure to set up the configuration files before starting the bot! After doing that, run the following:
+ ```bash
+ bun dev
+ ```
+ Or, if using Node:
+ ```bash
+ npm run start
+ ```
+ Also note, to pass any options that you could pass to `./blazew run`, you can just pass it normally to `bun dev` if using `bun`, or after a `--` argument if using `npm run start`.
  ## Emojis
  The bot uses some custom emojis and it will try to find those emojis in the Home Guild (The main server, which is configured in `HOME_GUILD_ID` environment variable).
-Line 211 
 In case if you're facing issues, feel fr
+Line 342 
 In case if you're facing issues, feel fr
  -   Email: [rakinar2@onesoftnet.eu.org](mailto:rakinar2@onesoftnet.eu.org)
  -   Discord: [@rakinar2](https://discord.com/users/774553653394538506)
- -   Discord Servers: [Official OSN Server](https://discord.gg/JJDy9SHzGv)
+ -   Discord Servers: [Official OSN Server](https://sudobot.online/discord)
  Give the repository a star to show your support! We'll be really thankful if you do.

 Legend:



Removed from v.575
 


changed lines


 
Added in v.626
 Legend:



Removed from v.575
 


changed lines


 
Added in v.626
-Removed from v.575
+Added in v.626

team@onesoftnet.eu.org	ViewVC Help
Powered by ViewVC 1.1.26