Guide improvements part 2 + rsar fix for v3

This commit is contained in:
Ene
2021-09-05 06:49:09 +00:00
committed by Kwoth
parent 442123a8ce
commit a89e3989a3
3 changed files with 17 additions and 15 deletions

View File

@@ -1,8 +1,8 @@
## Migration from 2.x ## Migration from 2.x
⚠ If you're already hosting NadekoBot, You **MUST** update to latest version of 2.x and **run your bot at least once** before switching over to v3. ##### ⚠ If you're already hosting NadekoBot, _You **MUST** update to latest version of 2.x and **run your bot at least once**_ before switching over to v3.
#### [Linux migration instructions](migration-instructions#linux) #### [Linux migration instructions](https://nadekobot.readthedocs.io/en/v3/guides/migration-guide/#linux)
## Linux From Source ## Linux From Source
@@ -17,9 +17,9 @@ Open Terminal (if you're on an installation with a window manager) and navigate
5. Copy the creds.yml template `cp nadekobot/output/creds_example.yml nadekobot/output/creds.yml` 5. Copy the creds.yml template `cp nadekobot/output/creds_example.yml nadekobot/output/creds.yml`
6. Open `nadekobot/output/creds.yml` with your favorite text editor. We will use nano here 6. Open `nadekobot/output/creds.yml` with your favorite text editor. We will use nano here
- `nano nadekobot/output/creds.yml` - `nano nadekobot/output/creds.yml`
7. [Enter your bot's token](#creds-guide) 7. [Enter your bot's token](https://nadekobot.readthedocs.io/en/v3/creds-guide/)
- After you're done, you can close nano (and save the file) by inputting, in order - After you're done, you can close nano (and save the file) by inputting, in order
- `CTRL`+`X` - `CTRL` + `X`
- `Y` - `Y`
- `Enter` - `Enter`
8. Run the bot (type `3` and press enter) 8. Run the bot (type `3` and press enter)
@@ -39,7 +39,7 @@ Open Terminal (if you're on an installation with a window manager) and navigate
1. Download the latest release from <https://gitlab.com/Kwoth/nadekobot/-/releases> 1. Download the latest release from <https://gitlab.com/Kwoth/nadekobot/-/releases>
- Look for the file called "X.XX.X-linux-x64-build.tar" (where X.XX.X is a series of numbers) and download it - Look for the file called "X.XX.X-linux-x64-build.tar" (where X.XX.X is a series of numbers) and download it
2. Untar it 2. Untar it
⚠ Make sure that you change X.XX.X to the same series of numbers as in step 1! - ⚠ Make sure that you change X.XX.X to the same series of numbers as in step 1!
- `tar xf X.XX.X-linux-x64-build.tar` - `tar xf X.XX.X-linux-x64-build.tar`
3. Rename the `nadekobot-linux-x64` to `nadekobot` 3. Rename the `nadekobot-linux-x64` to `nadekobot`
- `mv nadekobot-linux-x64 nadekobot` - `mv nadekobot-linux-x64 nadekobot`
@@ -51,7 +51,7 @@ Open Terminal (if you're on an installation with a window manager) and navigate
- `nano nadekobot/output/creds.yml` - `nano nadekobot/output/creds.yml`
8. [Enter your bot's token](#creds-guide) 8. [Enter your bot's token](#creds-guide)
- After you're done, you can close nano (and save the file) by inputting, in order - After you're done, you can close nano (and save the file) by inputting, in order
- `CTRL`+`X` - `CTRL` + `X`
- `Y` - `Y`
- `Enter` - `Enter`
9. Run the bot 9. Run the bot
@@ -63,7 +63,7 @@ Open Terminal (if you're on an installation with a window manager) and navigate
2. Download the latest release from <https://gitlab.com/Kwoth/nadekobot/-/releases> 2. Download the latest release from <https://gitlab.com/Kwoth/nadekobot/-/releases>
- Look for the file called "X.XX.X-linux-x64-build.tar" (where X.XX.X is a series of numbers) and download it - Look for the file called "X.XX.X-linux-x64-build.tar" (where X.XX.X is a series of numbers) and download it
3. Untar it 3. Untar it
⚠ Make sure that you change X.XX.X to the same series of numbers as in step 2! - ⚠ Make sure that you change X.XX.X to the same series of numbers as in step 2!
- `tar xf 2.99.8-linux-x64-build.tar` - `tar xf 2.99.8-linux-x64-build.tar`
4. Rename the old nadekobot directory to nadekobot-old (remove your old backup first if you have one, or back it up under a different name) 4. Rename the old nadekobot directory to nadekobot-old (remove your old backup first if you have one, or back it up under a different name)
- `rm -rf nadekobot-old 2>/dev/null` - `rm -rf nadekobot-old 2>/dev/null`
@@ -71,7 +71,7 @@ Open Terminal (if you're on an installation with a window manager) and navigate
5. Rename the new nadekobot directory to nadekobot 5. Rename the new nadekobot directory to nadekobot
- `mv nadekobot-linux-x64 nadekobot` - `mv nadekobot-linux-x64 nadekobot`
6. Remove old strings and aliases to avoid overwriting the updated versions of those files 6. Remove old strings and aliases to avoid overwriting the updated versions of those files
⚠ If you've modified said files, back them up instead - ⚠ If you've modified said files, back them up instead
- `rm nadekobot-old/data/aliases.yml` - `rm nadekobot-old/data/aliases.yml`
- `rm -r nadekobot-old/data/strings` - `rm -r nadekobot-old/data/strings`
7. Copy old data 7. Copy old data

View File

@@ -21,10 +21,10 @@
- Stop the bot - Stop the bot
2. Make sure your bot's folder is called `NadekoBot` 2. Make sure your bot's folder is called `NadekoBot`
- Run `cd ~ && ls` - Run `cd ~ && ls`
- Confirm there is a folder NadekoBot - Confirm there is a folder called NadekoBot (not nadekobot, in all lowercase)
3. Migrate your bot's data using the new installer: 3. Migrate your bot's data using the new installer:
- Run the **new** installer `cd ~ && wget -N https://gitlab.com/Kwoth/nadeko-bash-installer/-/raw/master/linuxAIO.sh && bash linuxAIO.sh` - Run the **new** installer `cd ~ && wget -N https://gitlab.com/Kwoth/nadeko-bash-installer/-/raw/master/linuxAIO.sh && bash linuxAIO.sh`
- The installer should notify you that your data is ready for migration in a message above the menu - The installer should notify you that your data is ready for migration in a message above the menu.
- Install prerequisites (type `1` and press enter), and make sure it is successful - Install prerequisites (type `1` and press enter), and make sure it is successful
- Download NadekoBot v3 (type `2` and press enter) - Download NadekoBot v3 (type `2` and press enter)
- Run the bot (type `3` and press enter) - Run the bot (type `3` and press enter)
@@ -32,7 +32,7 @@
- `.stats` to ensure owner id (credentials) is correct - `.stats` to ensure owner id (credentials) is correct
- `.lcr` to see custom reactions - `.lcr` to see custom reactions
- `.lp` to list permissions - `.lp` to list permissions
5. 🎉 Enjoy. If you want to learn how to update the bot, click (here)[#linux-updating-the-bot]. 5. 🎉 Enjoy. If you want to learn how to update the bot, click (here)[https://nadekobot.readthedocs.io/en/v3/guides/linux-guide/#update-instructions].
## Manual ## Manual

View File

@@ -137,7 +137,9 @@ asar:
rsar: rsar:
desc: "Removes a specified role from the list of self-assignable roles." desc: "Removes a specified role from the list of self-assignable roles."
args: args:
- "" - "Gamer"
- "Alliance"
- "Horde"
lsar: lsar:
desc: "Lists self-assignable roles. Shows 20 roles per page." desc: "Lists self-assignable roles. Shows 20 roles per page."
args: args: