mirror of
https://github.com/Cog-Creators/Red-DiscordBot.git
synced 2026-03-07 04:38:35 -05:00
[Docs] Red backup and restore instructions. (#6654)
This commit is contained in:
1
.github/labeler.yml
vendored
1
.github/labeler.yml
vendored
@@ -273,6 +273,7 @@
|
|||||||
- docs/bot_application_guide.rst
|
- docs/bot_application_guide.rst
|
||||||
- docs/install_guides/**/*
|
- docs/install_guides/**/*
|
||||||
- docs/update_red.rst
|
- docs/update_red.rst
|
||||||
|
- docs/backup_red.rst
|
||||||
"Category: Docs - Other":
|
"Category: Docs - Other":
|
||||||
- docs/host-list.rst
|
- docs/host-list.rst
|
||||||
- docs/index.rst
|
- docs/index.rst
|
||||||
|
|||||||
35
docs/backup_red.rst
Normal file
35
docs/backup_red.rst
Normal 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.
|
||||||
@@ -32,12 +32,11 @@ First, we would like to make something clear:
|
|||||||
Hosting on a VPS or Dedicated Server
|
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
|
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
|
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
|
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
|
server for hosting using the :doc:`backup/restore process </backup_red>`.
|
||||||
about this process is available in the `Red Support Server <https://discord.com/invite/red>`_.
|
|
||||||
|
|
||||||
.. warning::
|
.. warning::
|
||||||
Please be aware that a Linux server is controlled through a command line.
|
Please be aware that a Linux server is controlled through a command line.
|
||||||
|
|||||||
@@ -15,6 +15,7 @@ Welcome to Red - Discord Bot's documentation!
|
|||||||
install_guides/index
|
install_guides/index
|
||||||
bot_application_guide
|
bot_application_guide
|
||||||
update_red
|
update_red
|
||||||
|
backup_red
|
||||||
about_venv
|
about_venv
|
||||||
autostart_windows
|
autostart_windows
|
||||||
autostart_mac
|
autostart_mac
|
||||||
|
|||||||
@@ -2,4 +2,4 @@
|
|||||||
|
|
||||||
For safety reasons, DO NOT install Red with a root user. If you are unsure how to create
|
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
|
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>`_.
|
||||||
|
|||||||
Reference in New Issue
Block a user