From 464ce3ee4eb3a5d153d423f7797b79dfe92557a6 Mon Sep 17 00:00:00 2001 From: PJ Date: Thu, 6 Jun 2024 14:25:15 +0200 Subject: [PATCH] docs: recommend MySQL for production usage --- README.md | 6 ++++++ cmd/renterd/config.go | 4 ++-- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index be04594c1..3e52df539 100644 --- a/README.md +++ b/README.md @@ -20,6 +20,12 @@ Sia applications. Useful links: - [Project Roadmap](https://github.com/orgs/SiaFoundation/projects/5) - [Setup Guide](https://docs.sia.tech/renting/setting-up-renterd) +## Database + +`renterd` requires a database to store its operational data. We support both +SQLite and MySQL, with SQLite set as the default due to its ease of setup. +SQLite is ideal for testing and development purposes, whereas MySQL is +recommended for production environments. ## Configuration diff --git a/cmd/renterd/config.go b/cmd/renterd/config.go index 94d7c0b18..c50bb4787 100644 --- a/cmd/renterd/config.go +++ b/cmd/renterd/config.go @@ -246,8 +246,8 @@ func setAdvancedConfig() { // database fmt.Println("") fmt.Println("The database is used to store the renter's metadata.") - fmt.Println("The embedded SQLite database is recommended for small (< 50TB), single-user setups. Choose this for the easiest setup.") - fmt.Println("MySQL database is recommended for larger (> 50TB) or multi-user setups. MySQL requires a separate MySQL server to connect to.") + fmt.Println("The embedded SQLite database requires no additional configuration and is ideal for testing or demo purposes.") + fmt.Println("For production usage, we recommend MySQL, which requires a separate MySQL server.") setStoreConfig() }