docs: add images to the guide
BIN
.github/guide/cloudflare-dns.webp
vendored
Normal file
|
After Width: | Height: | Size: 136 KiB |
BIN
.github/guide/hostinger-1.location.webp
vendored
Normal file
|
After Width: | Height: | Size: 30 KiB |
BIN
.github/guide/hostinger-2.os.webp
vendored
Normal file
|
After Width: | Height: | Size: 25 KiB |
BIN
.github/guide/hostinger-3.malware.webp
vendored
Normal file
|
After Width: | Height: | Size: 18 KiB |
BIN
.github/guide/hostinger-4.configuration.webp
vendored
Normal file
|
After Width: | Height: | Size: 86 KiB |
BIN
.github/guide/hostinger-5.configuration.webp
vendored
Normal file
|
After Width: | Height: | Size: 110 KiB |
BIN
.github/guide/hostinger-6.complete.webp
vendored
Normal file
|
After Width: | Height: | Size: 62 KiB |
BIN
.github/guide/hostinger-7.wait.webp
vendored
Normal file
|
After Width: | Height: | Size: 26 KiB |
BIN
.github/guide/hostinger-8.connect.webp
vendored
Normal file
|
After Width: | Height: | Size: 89 KiB |
BIN
.github/guide/hostinger-9.panel.webp
vendored
Normal file
|
After Width: | Height: | Size: 132 KiB |
37
README.md
@@ -61,18 +61,37 @@ docker compose up -d
|
||||
|
||||
To get started, find yourself a suitable server to deploy onto, we recommend starting with at least 2 vCPUs and 2 GB of memory.
|
||||
|
||||
<!-- TODO: promo -->
|
||||
> [!TIP] > **We've partnered with Hostinger to bring you a 20% discount off VPS hosting!**
|
||||
>
|
||||
> 👉 https://www.hostinger.com/vps-hosting?REFERRALCODE=REVOLTCHAT
|
||||
>
|
||||
> We recommend using the _KVM 2_ plan at minimum! <br> Our testing environment for self-hosted currently sits on a KVM 2 instance and are happy to assist with issues.
|
||||
|
||||
<!-- select location -->
|
||||
<!-- select ubuntu -->
|
||||
The instructions going forwards will use Hostinger as an example hosting platform, but you should be able to adapt these to other platforms if necessary. There are important details throughout.
|
||||
|
||||

|
||||
|
||||
When asked, choose **Ubuntu Server** as your operating system, this is used by us in production and we recommend its use.
|
||||
|
||||
<!-- anti virus upsell -->
|
||||
<!-- set secure root password (practice good security >64 chars) (OR disable password login, explained after) & RECOMMEND add ssh key (instructions provided by them) -->
|
||||
<!-- confirm everything is correct -->
|
||||
<!-- wait for setup! -->
|
||||
<!-- 7Aq4qTBMT1Gzt3K4J2oRzhzdqOn2wE5xvcu9ZpvxDeeO3tR32# -->
|
||||

|
||||
|
||||
If you've chosen to go with Hostinger, they include integrated malware scanning which may be of interest:
|
||||
|
||||

|
||||
|
||||
You should set a secure root password for login (_or disable password login after setup, which is explained later! but you shouldn't make the password trivial until after this is secured at least!_) and we recommend that you configure an SSH key:
|
||||
|
||||

|
||||

|
||||
|
||||
Make sure to confirm everything is correct!
|
||||
|
||||

|
||||
|
||||
Wait for your VPS to be created...
|
||||
|
||||
|  |  |
|
||||
| --------------------------------------------------------- | ------------------------------------------------------------ |
|
||||
|
||||
After install, SSH into the machine:
|
||||
|
||||
@@ -106,7 +125,7 @@ reboot
|
||||
|
||||
Your system is now ready to proceed with installation, but before we continue you should configure your domain.
|
||||
|
||||
<!-- screenshot -->
|
||||

|
||||
|
||||
Your domain (or a subdomain) should point to the server's IP (A and AAAA records) or CNAME to the hostname provided.
|
||||
|
||||
|
||||