Misskey Config Sample

README.md

Misskey 設定ファイル サンプル集

情報

これらのファイルはそれぞれのsrc/config.tsを参考にしている。
WebについてはTravis Ciでビルドが通った最後のコミットDisplay title時を参考にしている。
現在は以降のコミットによりWebのjsonの書式が変更になっているので注意。
またWebのみビルド時に設定ファイルが存在しないとビルドできない。

必須環境

node、mongoDB、redis、graphicsmagickが動作する環境であれば問題がない
確認が取れているのはArchLinux、Ubuntu 16.04

このGistを書いた時点でのそれぞれのcommit

Misskey-API: Merge pull request #80 from MissKernel/fix-bug1
Misskey-File: Fix bug
Misskey-Web: Display title

ファイルの配置

ファイルの配置はそれぞれのsrc/config.tsで定義されている。デフォルトでは以下である。

[Home] - [.misskey] - [api.json]
                    - [file.json]
                    - [web.json]

型について

booleanはtrueかfalse、もしくは数字で表記、numberは数字、stringは文字列。
stringについてはダブルクオーテーションで括る。

Misskey-Fileのビルド

本家Misskey-FileレポジトリのReadmeに追記されたため不要になった

ビルド時の警告

[18:46:26] Failed to load external module ts-node/register
[18:46:26] Failed to load external module typescript-node/register
[18:46:26] Failed to load external module typescript-register

という警告が出るが無視してよい。

引っかかりそうなところ

• cookiePassはcookie暗号化のキー
• sessionKeyはなんでもいいが、伝統的にはhmskらしい
• apiのURLも伝統的にhimasaku.~らしい
• portのstreamingはsocket.ioの待ち受け、既存のポートとかぶらなければOK
• ..Url、..DomainはUrlはhttps://、http://などを付けたもの、domainは右(misskey.link -> misskey、test.misskey.link -> test)
• apiのhostはlocalhostでいいんじゃないかなど

あいまいな予測

• cookiePassはcookieのpathだと思う
  間違いでした。
• ~~ ~Url、Domainは例えばadminならadmin.misskey.xyz、adminとなると思われる ~~ これは現在Ciでビルドが通っていない新しいバージョンだと改善されており、~Urlは自動解釈するようになっているよう 間違いでした。

api.json

{
	"mongo": {
		"uri": string,
		"options": {
			"user": string,
			"pass": string
		}
	},
	"redis": {
		"host": string,
		"port": number,
		"password": string
	},
	"fileServer": {
		"passkey": string,
		"url": string,
		"ip": string,
		"port": number
	},
	"apiPasskey": string,
	"port": {
		"internal": number,
		"http": number,
		"https": number
	},
	"https": {
		"enable": boolean,
		"keyPath": string,
		"certPath": string
	}
}

file.json

{
	"passkey": string,
	"port": {
		"internal": number,
		"http": number,
		"https": number
	},
	"https": {
		"enable": boolean,
		"keyPath": string,
		"certPath": string
	},
	"url": string,
	"storagePath": string
}

web.json

{
	"mongo": {
		"uri": string,
		"options": {
			"user": string,
			"pass": string
		}
	},
	"redis": {
		"host": string,
		"password": string
	},
	"port": {
		"http": number,
		"https": number,
		"streaming": number
	},
	"https": {
		"enable": boolean,
		"keyPath": string,
		"certPath": string
	},
	"apiPasskey": string,
	"apiServerIp": string,
	"apiServerPort": number,
	"cookiePass": string,
	"sessionKey": string,
	"sessionSecret": string,
	"googleRecaptchaSecret": string,
	"publicConfig": {
		"themeColor": string,
		"domain": string,
		"host": string,
		"url": string,
		"adminUrl": string,
		"adminDomain": string,
		"authorizeUrl": string,
		"authorizeDomain": string,
		"registerUrl": string,
		"registerDomain": string,
		"signinDomain": string,
		"signinUrl": string,
		"signoutDomain": string,
		"signoutUrl": string,
		"resourcesDomain": string,
		"resourcesHost": string,
		"resourcesUrl": string,
		"shieldUrl": string,
		"shieldDomain": string,
		"aboutUrl": string,
		"aboutDomain": string,
		"searchDomain": string,
		"searchUrl": string,
		"helpUrl": string,
		"helpDomain": string,
		"talkDomain": string,
		"talkUrl": string,
		"forumDomain": string,
		"forumUrl": string,
		"apiHost": string,
		"apiUrl": string,
		"webApiDomain": string,
		"webApiHost": string,
		"webApiUrl": string,
		"webStreamingUrl": string,
		"developerCenterHost": string,
		"developerCenterUrl": string,
		"colorDomain": string,
		"colorUrl": string,
		"shareDomain": string,
		"shareUrl": string,
		"widgetsDomain": string,
		"widgetsUrl": string,
		"googleRecaptchaSiteKey": string
	}
}