CopyBot/Red-DiscordBot
1
0
Fork 0
mirror of https://github.com/Cog-Creators/Red-DiscordBot.git synced 2026-03-07 04:38:35 -05:00
Code Issues Packages Projects Releases Wiki Activity

[Docs] Red backup and restore instructions. (#6654)

Browse Source
This commit is contained in:
EternalllZM
2026-03-03 15:30:29 -08:00
committed by GitHub
parent 18154465c3
commit 8626aef36f
5 changed files with 40 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

35
docs/backup_red.rst Normal file
View File

@@ -0,0 +1,35 @@
.. _backup-red:
============================
Backing Up and Restoring Red
============================
Red can be backed up and restored to any device as long as it is supported operating system. See page: :ref:`end-user-guarantees`.
Backup steps are to be done in order and carefully to avoid any issues.
#. Take note of the installed cogs with ``[p]cogs``; and cog repositories with ``[p]load downloader``, then ``[p]repo list`` (``[p]`` is your bot's prefix).
#. Stop the bot, ideally with ``[p]shutdown``.
#. Activate your venv, and run ``redbot-setup backup <instancename>``, replacing ``<instancename>`` with the name of your instance.
#. Copy your backup file to the new machine/location.
#. Extract the file to a location of your choice (remember the full path and make sure that the user you are going to install/run Red under can access this path).
#. :ref:`Install Red <install-guides>` as normal on the new machine/location.
#. Run ``redbot-setup`` in your venv to create a new instance, using the path you remembered above as your data path.
#. Start your new instance.
#. Re-add the cog repositories using the same names as before.
#. Do ``[p]cog update``.
#. Re-add any cogs that were not re-installed (you may have to uninstall them first as Downloader may think they are still installed).
.. note::
The config (data) from cogs has been saved, but not the code itself.
.. tip::
You can fix permissions (if needed) on your directory using:
.. code-block:: bash
sudo chown -R <user>:<user> ~/.local
Replace ``<user>`` with your actual username.

5
docs/host-list.rst
View File

@@ -32,12 +32,11 @@ First, we would like to make something clear:
Hosting on a VPS or Dedicated Server
------------------------------------
| You can host Red in a VPS running Linux or Windows. Using a Linux VPS is the
| You can host Red on a VPS running Linux or Windows. Using a Linux VPS is the
recommended option. Dedicated servers also work but are overpowered and cost
ineffective unless one plans to run a very large bot or use their server for
more than just hosting Red. If you have already created an instance, Red can be moved to a different
server for hosting with a backup/restore process. More information and guidance
about this process is available in the `Red Support Server <https://discord.com/invite/red>`_.
server for hosting using the :doc:`backup/restore process </backup_red>`.
.. warning::
Please be aware that a Linux server is controlled through a command line.

1
docs/index.rst
View File

@@ -15,6 +15,7 @@ Welcome to Red - Discord Bot's documentation!
install_guides/index
bot_application_guide
update_red
backup_red
about_venv
autostart_windows
autostart_mac

2
docs/install_guides/_includes/linux-preamble.rst
View File

@@ -2,4 +2,4 @@
For safety reasons, DO NOT install Red with a root user. If you are unsure how to create
a new user on Linux, see `DigitalOcean's tutorial: How To Create a New Sudo-enabled User
<https://www.digitalocean.com/community/tutorials/how-to-create-a-new-sudo-enabled-user-on-ubuntu-20-04-quickstart>`_.
<https://www.digitalocean.com/community/tutorials/how-to-create-a-new-sudo-enabled-user-on-ubuntu>`_.