Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Recommend MySQL for production setups #1281

Merged
merged 1 commit into from
Jun 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading