mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2025-11-06 03:08:55 -05:00
82146eda3d
* typo fix * update docs with up to date reqs (remove old) and reccommend venv usage * remove youtube_dl from reqs * adding the mac doc update after verifying correctness * venv installation required for py3.5 ... * remove venv stuff, that can be handled on a unified page in a later PR
54 lines
1.8 KiB
ReStructuredText
54 lines
1.8 KiB
ReStructuredText
.. ubuntu install guide
|
|
|
|
==============================
|
|
Installing Red on Ubuntu 16.04
|
|
==============================
|
|
|
|
.. warning:: For safety reasons, DO NOT install Red with a root user. Instead, make a new one.
|
|
|
|
-------------------------------
|
|
Installing the pre-requirements
|
|
-------------------------------
|
|
|
|
.. code-block:: none
|
|
|
|
sudo apt install python3.5-dev python3-pip build-essential libssl-dev libffi-dev git unzip default-jre -y
|
|
|
|
|
|
------------------
|
|
Installing the bot
|
|
------------------
|
|
|
|
To install without audio:
|
|
|
|
:code:`pip3 install -U --process-dependency-links red-discordbot`
|
|
|
|
To install with audio:
|
|
|
|
:code:`pip3 install -U --process-dependency-links red-discordbot[voice]`
|
|
|
|
To install the development version (without audio):
|
|
|
|
:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot`
|
|
|
|
To install the development version (with audio):
|
|
|
|
:code:`pip3 install -U --process-dependency-links git+https://github.com/Cog-Creators/Red-DiscordBot@V3/develop#egg=red-discordbot[voice]`
|
|
|
|
------------------------
|
|
Setting up your instance
|
|
------------------------
|
|
|
|
Run :code:`redbot-setup` and follow the prompts. It will ask first for where you want to
|
|
store the data (the default is :code:`~/.local/share/Red-DiscordBot`) and will then ask
|
|
for confirmation of that selection. Next, it will ask you to choose your storage backend
|
|
(the default here is JSON). It will then ask for a name for your instance. This can be
|
|
anything as long as it does not contain spaces; however, keep in mind that this is the
|
|
name you will use to run your bot, and so it should be something you can remember.
|
|
|
|
-----------
|
|
Running Red
|
|
-----------
|
|
|
|
Run :code:`redbot <your instance name>` and run through the initial setup. This will ask for
|
|
your token and a prefix. |