.config/example.ymlに記述可能な"db.extra"のコメントを補強

[samunohito]

Summary

misskey/.config/example.yml

Lines 108 to 127 in 7bdc4e8

	# ┌──────────────────────────┐
	#───┘ PostgreSQL configuration └────────────────────────────────
	db:
	host: localhost
	port: 5432
	# Database name
	db: misskey
	# Auth
	user: example-misskey-user
	pass: example-misskey-pass
	# Whether disable Caching queries
	#disableCache: true
	# Extra Connection options
	#extra:
	# ssl: true

上記に記述されているextraについてのコメントを増強する必要があると考えています。
このextraはMisskeyのconfig -> TypeORM（DataSourceクラス） -> pgの流れでリレーされるもので、pgが作るコネクションプールのオプションとして使用されます。このオプションは、既に記載されているsslのほかにもコネクションタイムアウト秒数やコネクションプール最大数など有益なものを含んでいます。

なので…コネクションプール最大数とタイムアウト秒数の設定サンプルと、pgの該当ドキュメントへのリンクをコメントとして追記しておくと親切かと考えました。

Purpose

情報が充実してdb.extraをより有効に活用できるサーバ管理者が増える

Do you want to implement this feature yourself?

• Yes, I will implement this by myself and send a pull request