diff --git a/docs/getting_started.rst b/docs/getting_started.rst index 28a38a3b8..7ebb04ef7 100644 --- a/docs/getting_started.rst +++ b/docs/getting_started.rst @@ -265,8 +265,8 @@ If you want to do it, follow these steps. 1. **Find a host** You need to find a server to host Red. You can rent a VPS (it can be free) - on an online service. Please check :ref:`this list ` for - quality VPS providers. + on an online service. Please check :ref:`this page ` for + more information. You can also buy a Raspberry Pi (~$20), which is a micro-computer that will be able to host Red. The model 3 or above is recommended. diff --git a/docs/host-list.rst b/docs/host-list.rst index d29bedb75..962d6083f 100644 --- a/docs/host-list.rst +++ b/docs/host-list.rst @@ -2,16 +2,42 @@ .. _host-list: -============= -VPS providers -============= +=================== +Hosting Information +=================== .. note:: This doc is written for the :ref:`hosting section ` of the :ref:`getting started ` guide. Please take a look - if you don't know how to host Red on a VPS. + if you don't know how to host Red. -This is a list of the recommended VPS providers. + +| For your instance of Red to stay online 24/7, it needs to be hosted on a dedicated system. + This page contains hosting related information and advice for beginners in + topics such as picking a provider. + +First, we would like to make something clear: + +.. warning:: + Due to their inability to handle Red's data structure and meet the + conditions of being a supported platform; platforms such as Heroku, + Pterodactyl, repl.it, Termux, LXC and alike are **NOT** officially supported. + Docker support found in GitHub is also a work in progress and not ready + for daily use. Workarounds for getting Red running on those platforms + are imperfect due to Red's nature. You will not be able to receive + support if an issue occurs when hosting on any of these platforms. + + +------------------------------------ +Hosting on a VPS or Dedicated Server +------------------------------------ + +| You can host Red in 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 `_. .. warning:: Please be aware that a Linux server is controlled through a command line. @@ -19,73 +45,106 @@ This is a list of the recommended VPS providers. `_ from DigitalOcean which will introduce you to the Linux basics. -------------- -Linux hosting -------------- - -+------------------------------------+------------------------------------------------------+ -|Link |Description | -+====================================+======================================================+ -|`Scaleway |Incredibly cheap but powerful VPSes, owned by | -|`_ |``_, based in Europe. | -+------------------------------------+------------------------------------------------------+ -|`DigitalOcean |US-based cheap VPSes. The gold standard. Locations | -|`_ |available world wide. | -+------------------------------------+------------------------------------------------------+ -|`OVH `_ |Cheap VPSes, used by many people. French and Canadian | -| |locations available. | -+------------------------------------+------------------------------------------------------+ -|`Time4VPS |Cheap VPSes, seemingly based in Lithuania. | -|`_ | | -+------------------------------------+------------------------------------------------------+ -|`Linode `_ |More cheap VPSes! | -+------------------------------------+------------------------------------------------------+ -|`Vultr `_ |US-based, DigitalOcean-like. | -+------------------------------------+------------------------------------------------------+ - ------- -Others ------- - -+-------------------------------------+-----------------------------------------------------+ -|Link | | -+=====================================+=====================================================+ -|`AWS `_ |Amazon Web Services. Free for a year (with certain | -| |limits), but very pricey after that. | -+-------------------------------------+-----------------------------------------------------+ -|`Google Cloud |Same as AWS, but it's Google. | -|`_| | -+-------------------------------------+-----------------------------------------------------+ -|`Microsoft Azure |Same as AWS, but it's Microsoft. | -|`_ | | -+-------------------------------------+-----------------------------------------------------+ -|`Oracle Cloud |Same as AWS, but it's Oracle. | -|`_ | | -+-------------------------------------+-----------------------------------------------------+ -|`LowEndBox `_ |A curator for lower specced servers. | -+-------------------------------------+-----------------------------------------------------+ ------------ -Self-hosting +Self Hosting ------------ -You can always self-host on your own hardware. -A Raspberry Pi 3 will be more than sufficient for small to medium sized bots. +| It's possible to self host Red with your own hardware. A Raspberry Pi 3 + will have enough computing capacity to handle a small to medium sized bot. + You can also host on your own computer or rack server. Any modern hardware + should work without issues. However, this option leaves you responsible for + keeping the bot online by paying for electricity costs and dealing with power outages. -For bigger bots, you can build your own server PC for usage, or buy a rack -server. Any modern hardware should work 100% fine. +------------------- +Choosing a Provider +------------------- + +| The following are some common providers suitable for hosting Red. With + each having their pros and cons, this list is mainly intended to act as a + starting point. You should conduct your own research and come to + a conclusion depending on your needs and budget, taking into account + providers not listed here if desired. The key is the provider offering + an OS supported by Red. + +.. tip:: + You will have better results with Audio when the region in your Discord + server settings is closer to the bulk of the server's audience and + the location you picked for your Red host. + + +----------------- +Average Providers +----------------- + +| `Scaleway `_ is a VPS and dedicated server + provider French in origin with locations in Poland and Netherlands. + +| `DigitalOcean `_ is a US based cloud services company + with locations available worldwide, the VPS service is provided under the brand name + "Droplet". + +| `OVH `_ is a company focused on providing hosting + and cloud services with locations in Europe, North America and Asia Pacific. + +| `Time4VPS `_ is a Lithuanian VPS provider mainly focused + on lower cost. + +| `GalaxyGate `_ is a VPS and dedicated server provider + with a single location in New York. + +| `Linode `_ is a US based cloud services company similar + to DigitalOcean with locations available worldwide. + +| `AWS Lightsail `_ is a VPS service from Amazon + Web Services priced lower than their enterprise offerings. + +| `Vultr `_ is a US based provider of VPS and dedicated servers + with locations available worldwide. + +| `Hetzner Online `_ is a German VPS and dedicated server + provider with locations in Germany and Finland. + +| `Contabo `_ is also a German VPS and dedicated server provider + with locations in Germany and the United States. + +| `Ramnode `_ is a US based VPS provider focused on + low to middle end VPS with locations in the US and Netherlands. + +| `LowEndBox `_ is a website where hosting providers are + discussed and curated, often with lower costs and less known providers. + +-------------------- +Higher End Providers +-------------------- + +| `AWS EC2 `__ is the enterprise offering of Amazon Web Services. + A limited free plan is available for 12 months, after which a complex pricing model with + high costs take over. + +| `Google Compute Engine `__ is Google's EC2 competitor. + However, an always free plan with limited resources is offered. + +| `Microsoft Azure VM `__ is + Microsoft's EC2 competitor with lower costs than EC2 for Windows instances, but similar + otherwise. + +| `Oracle Cloud Compute `__ is Oracle's EC2 + competitor. But an always free plan is available with slightly higher specifications + compared to that of Google Compute Engine. ------------ -Free hosting +Free Hosting ------------ -| `Google Cloud Compute Engine `_, +| `Google Compute Engine `_, `Oracle Cloud Compute `_ and `AWS EC2 `_ have free tier VPSes suitable for small bots. -| **Note:** AWS EC2's free tier does not last forever - it's a 12 month trial. -| Additionally, new Google Cloud customers get a $300 credit which is valid - for 3 months. +| **Note:** The free tier offered by AWS for EC2 only lasts for 12 months, while + Oracle Cloud and Google Cloud offer always free tiers with limited resources. -Other than that... no. There is no good free VPS hoster, outside of -persuading somebody to host for you, which is incredibly unlikely. +| Additionally, new Google Cloud customers get a $300 credit which is valid for 3 months. + +| Excluding the above, there is no recommended free VPS host. Persuasion of + another individual for hosting Red is an option, albeit low in success rate.