/[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 599 by rakinar2,
Wed Aug  7 14:51:05 2024 UTC
+revision 632 by rakinar2,
Thu Oct 10 17:53:11 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
- Before you start, you need to have the following installed on your system:
+ <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:
  - 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.
  - A [PostgreSQL](https://www.postgresql.org/) database server. You can use a local server or use a cloud service like [Supabase](https://supabase.com/).
-Line 71 
 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 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 **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
-Line 116 
 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 125 
 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 141 
 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 209 
 To force the bot to clear the commands g
+Line 223 
 To force the bot to clear the commands 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 223 
 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.599
 


changed lines


 
Added in v.632
 Legend:



Removed from v.599
 


changed lines


 
Added in v.632
-Removed from v.599
+Added in v.632

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