Skip to content

Commit

Permalink
Recommend MySQL for production setups (#1281)
Browse files Browse the repository at this point in the history
I updated `renterd` to suggest MySQL for production usage, in my opinion
making a distinction between small/personal nodes and anything else
confuses people. It's also kind of annoying because if you turn your
10TB node into a 100TB node you'll have to migrate databases. I know
SQLite works perfectly fine up until 50TB+ even but since MySQL performs
better we might as well suggest it for usage in production?

Extending docs with MySQL setup guides can be tracked here
SiaFoundation/docs#77 - I don't think we need
to add that to `renterd`'s `README`.
  • Loading branch information
peterjan authored Jun 6, 2024
1 parent e1f5825 commit 4f8c7da
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 2 deletions.
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions cmd/renterd/config.go
Original file line number Diff line number Diff line change
Expand Up @@ -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()
}

Expand Down

0 comments on commit 4f8c7da

Please sign in to comment.