Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs updates following PR #2442 #2448

Open
wants to merge 14 commits into
base: gh-pages
Choose a base branch
from
Open
2 changes: 1 addition & 1 deletion _docs/installing/arch.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ category: Installing the bot
order: 7
---

<img class="doc-img" src="{{ site.baseurl }}/images/arch.png" alt="centos" style="width: 75px; float: right;"/>
<img class="os-icon" src="{{ site.baseurl }}/images/arch.png" alt="Arch logo" />
Installation on Arch Linux is like many other Linux distributions, however these steps may be out-of-date at any moment due to Arch being a rolling distribution, which tends to provide very new versions of packages.
Please keep this in mind when seeking support.

Expand Down
35 changes: 31 additions & 4 deletions _docs/installing/centos.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,15 @@ title: CentOS
category: Installing the bot
order: 8
---
<img class="doc-img" src="{{ site.baseurl }}/images/centos.png" alt="centos" style="width: 75px; float: right;"/>
Installation on CentOS is **majorly untested and is not officially supported** due to issues. Please keep this in mind when seeking support.
<img class="os-icon" src="{{ site.baseurl }}/images/centos.png" alt="CentOS logo"/>
Installation on CentOS is possible, however **support is no longer provided for any version of CentOS**.
CentOS is considered End-of-Life, and so packages and repositories used in these steps may not exist today!

The installation steps for CentOS vary depending on your version of the OS.
CentOS Stream version 8 was included in the [Auto Installer]({{ site.baseurl }}/installing/installers) script.
It may or may not work for you, please read the script before using it.
If you are interested in installing on CentOS or other RHEL-like OS versions, please consider contributing up-to-date install steps for the OS of your choice.

> **NOTICE:** These steps are provided for reference only. Carefully examine and update these steps to comply with your system.

## CentOS 6.9

Expand Down Expand Up @@ -53,6 +58,7 @@ python3 -m pip install -U pynacl

~~~


## CentOS 7.4

~~~sh
Expand Down Expand Up @@ -89,6 +95,27 @@ python3 -m pip install -U -r requirements.txt

~~~

{: title="CentOS 7.4" }
## CentOS Stream 8

These are the steps used by the auto-installer script for CentOS Stream version 8.

```bash

# Add extra repositories to system package manager.
sudo dnf install epel-release
sudo dnf install --nogpgcheck https://mirrors.rpmfusion.org/free/el/rpmfusion-free-release-8.noarch.rpm
sudo dnf config-manager --enable powertools

# Install available required packages.
sudo yum -y install opus-devel libffi-devel git curl jq ffmpeg python39 python39-devel

# Clone the MusicBot
git clone https://github.com/Just-Some-Bots/MusicBot.git MusicBot -b master
cd MusicBot

# Install bot requirements
python3 -m pip install -U -r requirements.txt

```

Once everything has been completed, you can go ahead and [configure]({{ site.baseurl }}/using/configuration) the bot and then run with `sudo ./run.sh`.
6 changes: 3 additions & 3 deletions _docs/installing/debian.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Debian
category: Installing the bot
order: 5
---
<img class="doc-img" src="{{ site.baseurl }}/images/debian.png" alt="debian" style="width: 75px; float: right;"/>
<img class="os-icon" style="mix-blend-mode: color;" src="{{ site.baseurl }}/images/debian.png" alt="Debian logo"/>

Installing the bot on Debian is similar to [Ubuntu]({{ site.baseurl }}/installing/ubuntu), but requires some additional system dependencies obtained through `apt`.

Expand Down Expand Up @@ -70,7 +70,7 @@ If you need to manually update python libraries for MusicBot, you will need to a
<details>
<summary>Debian 11 (bullseye) install steps.</summary>

For Debian version 11 (bullseye), the Python 3.8+ is available as a system package, so installing is pretty simple.<br>
For Debian version 11 (bullseye), Python 3.9 or higher is available as a system package, so installing is pretty simple.<br>
Just follow these commands:

{% highlight bash %}
Expand Down Expand Up @@ -102,7 +102,7 @@ After configuring you can use the command <code>./run.sh</code> to start the bot
<details>
<summary>Debian 10 (buster) install steps.</summary>

For Debian version 10 (buster) and earlier versions, you will need to compile a version of Python 3.8 or higher as well as installing pip.<br>
For Debian version 10 (buster) and earlier versions, you will need to compile a version of Python 3.9 or higher as well as installing pip.<br>
This can take a bit of time to complete and may require a little troubleshooting know-how if these steps are out-of-date or incomplete in some way.<br>
<br>
If you're willing to carefully follow along, these steps <i>should</i> get MusicBot working:
Expand Down
31 changes: 20 additions & 11 deletions _docs/installing/mac.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,34 +3,43 @@ title: MacOS
category: Installing the bot
order: 4
---
<img class="doc-img" src="{{ site.baseurl }}/images/mac.png" alt="Mac" style="width: 75px; float: right;"/>
<img class="os-icon" src="{{ site.baseurl }}/images/mac.png" alt="mac OS Logo"/>

Installing MusicBot on Mac is simple using homebrew and xcode.

Installing MusicBot on Mac is quite simple.
> Note: On ARM-based mac (M1, M4, etc.) you may encounter an issue with Opus not loading.
You can bypass this by enabling `UseOpusAudio` in your options.ini file.

> **The steps below are for macOS Catalina and above. They may not work on older versions of macOS.**

You will need to open Terminal and run the following commands:
### Catalina & above
These steps were made for macOS Catalina and above.

To install, you will need to open Terminal and use the following commands (adjust them as needed for your system):

```bash
# Install Homebrew and Xcode command line tools
# Install Homebrew and Xcode command line tools.
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
echo; echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> /Users/$(id -un)/.zprofile \
eval "$(/opt/homebrew/bin/brew shellenv)" # To fix "zsh: command not found: brew"
brew update

# set up xcode.
xcode-select --install

# Install dependencies
brew install python libsodium libffi opus ffmpeg git
# update brew package index.
brew update

# Install system dependencies
brew install libsodium libffi ffmpeg git opus-tools

# Install python using version 3.10, or any version from 3.9 to 3.13
brew install [email protected]

# Clone the MusicBot
# Clone the MusicBot using master branch, you may also use review or dev.
cd desktop
git clone https://github.com/Just-Some-Bots/MusicBot.git MusicBot -b master
git clone https://github.com/Just-Some-Bots/MusicBot.git MusicBot -b master

# Install Python dependencies
cd MusicBot
python3 -m pip install -U pip
python3 -m pip install -U -r requirements.txt
```

Expand Down
6 changes: 5 additions & 1 deletion _docs/installing/openbsd.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,17 @@ title: OpenBSD
category: Installing the bot
order: 11
---

<img class="os-icon" style="width: 5.8em;" src="{{ site.baseurl }}/images/openbsd.svg"/>
MusicBot can run on OpenBSD systems as well. Note that the X11 sets must be installed, due to the `ffmpeg` dependency.

> Note: These steps are out of date, and must be changed for modern versions of OpenBSD. Please consider sharing up-to-date install steps.

## OpenBSD 6.6

~~~bash
# Install Python and libraries available as packages
doas pkg_add python # select version 3.8 or above
doas pkg_add python # select version 3.9 or above
doas pkg_add py3-aiohttp youtube-dl ffmpeg libsodium git

# Ensure pip is set up
Expand Down
6 changes: 3 additions & 3 deletions _docs/installing/raspbian.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ category: Installing the bot
order: 6
---

<img class="doc-img" src="{{ site.baseurl }}/images/raspbian.png" alt="Raspbian" style="width: 75px; float: right;"/>
<img class="os-icon" src="{{ site.baseurl }}/images/raspbian.png" alt="Raspbian or Pi OS logo"/>

MusicBot can be installed on Raspbian and Raspberry Pi OS. Older versions of Pi OS (known as Raspbian) may require some manual steps.
This guide is broken into three sections depending on your version of Raspberry Pi OS or Raspbian.
Expand Down Expand Up @@ -69,7 +69,7 @@ If you need to manually update python libraries for MusicBot, you will need to a
<details>
<summary>Raspberry Pi OS 11 (bullseye) install steps.</summary>

For Pi OS version 11 (bullseye), the Python 3.8+ is available as a system package, so installing is pretty simple.<br>
For Pi OS version 11 (bullseye), Python 3.9 or higher is available as a system package, so installing is pretty simple.<br>
Just follow these commands:

{% highlight bash %}
Expand Down Expand Up @@ -101,7 +101,7 @@ After configuring you can use the command <code>./run.sh</code> to start the bot
<details>
<summary>Raspbian 10 (buster) install steps.</summary>

For Raspbian version 10 (buster) and earlier versions, you will need to compile a version of Python 3.8 or higher as well as installing pip.<br>
For Raspbian version 10 (buster) and earlier versions, you will need to compile a version of Python 3.9 or higher as well as installing pip.<br>
This can take a bit of time to complete and may require a little troubleshooting know-how if these steps are out-of-date or incomplete in some way.<br>
<br>
If you're willing to carefully follow along, these steps <i>should</i> get MusicBot working:
Expand Down
5 changes: 2 additions & 3 deletions _docs/installing/rocky.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,7 @@ category: Installing the bot
order: 12
---

<img class="doc-img" src="{{ site.baseurl }}/images/rocky.png" alt="rocky" style="width: 75px; float: right;"/>

<img class="os-icon" style="mix-blend-mode: color;" src="{{ site.baseurl }}/images/rocky.png" alt="Rocky Linux Logo"/>

Installing the bot on Rocky is similar to [Ubuntu]({{ site.baseurl }}/installing/ubuntu), but requires a different package manager.

Expand All @@ -24,7 +23,7 @@ sudo dnf config-manager --set-enabled crb
sudo dnf -y install ffmpeg


# Install Python (skip this if `python3 --version` shows python 3.8.x or newer is installed)
# Install Python (skip this if `python3 --version` shows python 3.9.x or newer is installed)
sudo dnf install -y python3

# Install pip
Expand Down
4 changes: 2 additions & 2 deletions _docs/installing/ubuntu.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ category: Installing the bot
order: 3
---

<img class="doc-img" src="{{ site.baseurl }}/images/ubuntu.png" alt="Ubuntu" style="width: 75px; float: right;"/>
<img class="os-icon" src="{{ site.baseurl }}/images/ubuntu.png" alt="Ubuntu Logo"/>

Installing MusicBot on Ubuntu is simple, and we have steps for several LTS versions.
While this guide leaves out non-LTS versions of Ubuntu, the steps here are a good place to start for interim versions.
Expand Down Expand Up @@ -80,7 +80,7 @@ After configuring you can use the command <code>./run.sh</code> to start the bot
<details>
<summary>Install steps.</summary>

For Ubuntu 20.04 and 22.04, the Python 3 packages should be 3.8 or newer which makes install pretty simple.
For Ubuntu 20.04 and 22.04, the Python 3 packages should be 3.9 or newer which makes install pretty simple.

{% highlight bash %}
# Update system packages first
Expand Down
2 changes: 1 addition & 1 deletion _docs/installing/windows.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Windows
category: Installing the bot
order: 2
---
<img class="doc-img" src="{{ site.baseurl }}/images/windows.png" alt="Windows" style="width: 75px; float: right;"/>
<img class="os-icon" src="{{ site.baseurl }}/images/windows.png" alt="Windows Logo"/>

> If you do not clone the bot using Git, and instead download the ZIP file from GitHub and attempt to run it, you will receive an error.

Expand Down
3 changes: 3 additions & 0 deletions _docs/using/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -439,6 +439,9 @@ Select from these services:<br>
- yt, youtube (default)<br>
- sc, soundcloud<br>
- yh, yahoo<br>
- gv, google<br>
- nv, nico<br>
- bb, bili<br>

</details>

Expand Down
Loading