qugalet/gotosocial
1
0
Fork 0
mirror of https://github.com/superseriousbusiness/gotosocial.git synced 2024-11-26 05:36:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[documentation] update database docs (#355)

Browse source 
* update config to new db defaults
* update database docs
This commit is contained in:
tobi 2021-12-21 12:24:19 +01:00 committed by GitHub
parent ed9158fa05
commit a01b178467
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 19 additions and 19 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
docs/configuration/database.md
View file

@ -16,7 +16,9 @@ Note that the `:memory:` setting will use an *in-memory database* which will be
Postgres is a heavier database format, which is useful for larger instances where you need to scale performance, or where you need to run your database on a dedicated machine separate from your GoToSocial instance (or do funky stuff like run a database cluster). Postgres is a heavier database format, which is useful for larger instances where you need to scale performance, or where you need to run your database on a dedicated machine separate from your GoToSocial instance (or do funky stuff like run a database cluster).
GoToSocial supports connecting to Postgres using SSL/TLS. If you're running Postgres on a different machine from GoToSocial, and connecting to it via an IP address or hostname (as opposed to just running on localhost), then SSL/TLS is **CRUCIAL** to avoid leaking data all over the place! You can connect to Postgres using either a Unix socket connection, or via TCP, depending on what you've set as your `db-address` value.
GoToSocial also supports connecting to Postgres using SSL/TLS over TCP. If you're running Postgres on a different machine from GoToSocial, and connecting to it via an IP address or hostname (as opposed to just running on localhost), then SSL/TLS is **CRUCIAL** to avoid leaking data all over the place!
When you're using Postgres, GoToSocial expects whatever you've set for `db-user` to already be created in the database, and to have ownership of whatever you've set for `db-database`. When you're using Postgres, GoToSocial expects whatever you've set for `db-user` to already be created in the database, and to have ownership of whatever you've set for `db-database`.
@ -56,8 +58,8 @@ db-type: "postgres"
# String. Database address or parameters. # String. Database address or parameters.
# Examples: ["localhost","my.db.host","127.0.0.1","192.111.39.110",":memory:"] # Examples: ["localhost","my.db.host","127.0.0.1","192.111.39.110",":memory:"]
# Default: "localhost" # Default: ""
db-address: "127.0.0.1" db-address: ""
# Int. Port for database connection. # Int. Port for database connection.
# Examples: [5432, 1234, 6969] # Examples: [5432, 1234, 6969]
@ -66,19 +68,18 @@ db-port: 5432
# String. Username for the database connection. # String. Username for the database connection.
# Examples: ["mydbuser","postgres","gotosocial"] # Examples: ["mydbuser","postgres","gotosocial"]
# Default: "postgres" # Default: ""
db-user: "postgres" db-user: ""
# REQUIRED
# String. Password to use for the database connection # String. Password to use for the database connection
# Examples: ["password123","verysafepassword","postgres"] # Examples: ["password123","verysafepassword","postgres"]
# Default: "postgres" # Default: ""
db-password: "postgres" db-password: ""
# String. Name of the database to use within the provided database type. # String. Name of the database to use within the provided database type.
# Examples: ["mydb","postgres","gotosocial"] # Examples: ["mydb","postgres","gotosocial"]
# Default: "postgres" # Default: "gotosocial"
db-database: "postgres" db-database: "gotosocial"
# String. Disable, enable, or require SSL/TLS connection to the database. # String. Disable, enable, or require SSL/TLS connection to the database.
# If "disable" then no TLS connection will be attempted. # If "disable" then no TLS connection will be attempted.

17
example/config.yaml
View file

@ -94,8 +94,8 @@ db-type: "postgres"
# String. Database address or parameters. # String. Database address or parameters.
# Examples: ["localhost","my.db.host","127.0.0.1","192.111.39.110",":memory:"] # Examples: ["localhost","my.db.host","127.0.0.1","192.111.39.110",":memory:"]
# Default: "localhost" # Default: ""
db-address: "127.0.0.1" db-address: ""
# Int. Port for database connection. # Int. Port for database connection.
# Examples: [5432, 1234, 6969] # Examples: [5432, 1234, 6969]
@ -104,19 +104,18 @@ db-port: 5432
# String. Username for the database connection. # String. Username for the database connection.
# Examples: ["mydbuser","postgres","gotosocial"] # Examples: ["mydbuser","postgres","gotosocial"]
# Default: "postgres" # Default: ""
db-user: "postgres" db-user: ""
# REQUIRED
# String. Password to use for the database connection # String. Password to use for the database connection
# Examples: ["password123","verysafepassword","postgres"] # Examples: ["password123","verysafepassword","postgres"]
# Default: "postgres" # Default: ""
db-password: "postgres" db-password: ""
# String. Name of the database to use within the provided database type. # String. Name of the database to use within the provided database type.
# Examples: ["mydb","postgres","gotosocial"] # Examples: ["mydb","postgres","gotosocial"]
# Default: "postgres" # Default: "gotosocial"
db-database: "postgres" db-database: "gotosocial"
# String. Disable, enable, or require SSL/TLS connection to the database. # String. Disable, enable, or require SSL/TLS connection to the database.
# If "disable" then no TLS connection will be attempted. # If "disable" then no TLS connection will be attempted.