summaryrefslogtreecommitdiff
path: root/docs/getting_started
diff options
context:
space:
mode:
authorLibravatar Daenney <daenney@users.noreply.github.com>2024-09-28 22:45:43 +0200
committerLibravatar GitHub <noreply@github.com>2024-09-28 22:45:43 +0200
commit504b3a9162d5509b7497c62baae522b4aafa1104 (patch)
treee908beaa3e390b80d622cb05402b50b7f33ac4f3 /docs/getting_started
parent[chore] Update apparmor example file (#3368) (diff)
downloadgotosocial-504b3a9162d5509b7497c62baae522b4aafa1104.tar.xz
[docs] Don't run SQLite on networked storage (#3369)
* [docs] Don't run SQLite on networked storage This updates our documentation to include warnings against running SQLite on networked storage. It also slightly reorganises and consolidates some admonitions on the Getting Started page because it was getting a bit too busy with repeated information. * [docs] Reword a few things
Diffstat (limited to 'docs/getting_started')
-rw-r--r--docs/getting_started/index.md16
1 files changed, 10 insertions, 6 deletions
diff --git a/docs/getting_started/index.md b/docs/getting_started/index.md
index cd79cb312..d8b96439b 100644
--- a/docs/getting_started/index.md
+++ b/docs/getting_started/index.md
@@ -65,14 +65,16 @@ If you decide to use a VPS instead, you can spin yourself up something cheap wit
[Greenhost](https://greenhost.net) is also great: it has zero CO2 emissions, but is a bit more costly. Their 1GB, 1-cpu VPS works great for a single-user or small instance.
+!!! warning "Cloud storage volumes"
+ Not all cloud VPS storage offerings are equal, and just because something claims to be backed by an SSD doesn't mean that it will necessarily be suitable to run a GoToSocial instance.
+
+ The [performance of Hetzner Cloud Volumes](https://github.com/superseriousbusiness/gotosocial/issues/2471#issuecomment-1891098323) is not guaranteed and seems to have very volatile latency. This will result in your GoToSocial instance performing poorly.
+
!!! danger "Oracle Free Tier"
[Oracle Cloud Free Tier](https://www.oracle.com/cloud/free/) servers are not suitable for a GoToSocial deployment if you intend to federate with more than a handful of other instances and users.
GoToSocial admins running on Oracle Cloud Free Tier have reported that their instances become extremely slow or unresponsive during periods of moderate load. This is most likely due to memory or storage latency, which causes even simple database queries to take a long time to run.
-!!! danger "Hetzner Cloud Volume"
- The [performance of Hetzner Cloud Volumes](https://github.com/superseriousbusiness/gotosocial/issues/2471#issuecomment-1891098323) is not guaranteed and seems to have very volatile latency. You're going to have a bad time running your database on those, with extremely poor query performance for even the most basic operations. Before filing performance issues against GoToSocial, make sure the problems reproduce with local storage.
-
### Distribution system requirements
Please make sure to check on your distribution system requirments, especially memory. Many distributions have baseline requirements and running them on a system that doesn't meet them will cause problems without further tuning and tweaking on your part.
@@ -99,13 +101,15 @@ GoToSocial supports both SQLite and Postgres as database drivers. Though it is p
SQLite is the default driver and it's been shown to work brilliantly for instances in the range of 1-30 users (or maybe more).
+!!! danger "SQLite on networked storage"
+ Don't put your SQLite database on remote storage, whether that's NFS/Samba, iSCSI volumes, things like Ceph/Gluster or your cloud provider's network volume storage solution.
+
+ See [SQLite on networked storage](../advanced/sqlite-networked-storage.md) for further information.
+
If you're planning on hosting more people than this on an instance, you may wish to use Postgres instead, as it offers the possibility of database clustering and redundancy, at the cost of some complexity.
Regardless of which database driver you choose, for proper performance they should be run on fast storage that operates with low and stable latency. It is possible to run databases on network attached storage, but this adds variable latency and network congestion to the mix, as well as potential I/O contention on the origin storage.
-!!! danger "Cloud Storage Volumes"
- Not all cloud VPS storage offerings are equal, and just because something claims to be backed by an SSD doesn't mean that it will necessarily be suitable to run a GoToSocial instance on. Please see the [Server/VPS section](#vps) section below.
-
!!! tip
Please [backup your database](../admin/backup_and_restore.md). The database contains encryption keys for the instance and any user accounts. You won't be able to federate again from the same domain if you lose these keys!