summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorsyuilo <syuilotan@yahoo.co.jp>2017-11-23 05:43:00 +0900
committersyuilo <syuilotan@yahoo.co.jp>2017-11-23 05:43:00 +0900
commit3f8ebac466ece8e9598432f3f574ec44e420c03b (patch)
tree05114fce9728d6ce1deecc1f2eb8a903a22b0100 /docs
parent:v: (diff)
downloadsharkey-3f8ebac466ece8e9598432f3f574ec44e420c03b.tar.gz
sharkey-3f8ebac466ece8e9598432f3f574ec44e420c03b.tar.bz2
sharkey-3f8ebac466ece8e9598432f3f574ec44e420c03b.zip
なんかもうめっちゃ変えた
Closes #940
Diffstat (limited to 'docs')
-rw-r--r--docs/config.md55
-rw-r--r--docs/setup.en.md27
-rw-r--r--docs/setup.ja.md29
3 files changed, 73 insertions, 38 deletions
diff --git a/docs/config.md b/docs/config.md
new file mode 100644
index 0000000000..0e23e09ae8
--- /dev/null
+++ b/docs/config.md
@@ -0,0 +1,55 @@
+``` yaml
+# サーバーのメンテナ情報
+maintainer:
+ # メンテナの名前
+ name:
+
+ # メンテナの連絡先(URLかmailto形式のURL)
+ url:
+
+# プライマリURL
+url:
+
+# セカンダリURL
+secondary_url:
+
+# 待受ポート
+port:
+
+# TLSの設定
+https:
+ # TLSを有効にするか否か
+ enable: false
+
+ key: null
+ cert: null
+ ca: null
+
+# MongoDBの設定
+mongodb:
+ host: localhost
+ port: 27017
+ db: misskey
+ user:
+ pass:
+
+# Redisの設定
+redis:
+ host: localhost
+ port: 6379
+ pass:
+
+# reCAPTCHAの設定
+recaptcha:
+ site_key:
+ secret_key:
+
+# ServiceWrokerの設定
+sw:
+ # VAPIDの公開鍵
+ public_key:
+
+ # VAPIDの秘密鍵
+ private_key:
+
+```
diff --git a/docs/setup.en.md b/docs/setup.en.md
index 5ad57d5abd..9c31e4f177 100644
--- a/docs/setup.en.md
+++ b/docs/setup.en.md
@@ -36,6 +36,15 @@ Note that Misskey uses following subdomains:
Misskey requires reCAPTCHA tokens.
Please visit https://www.google.com/recaptcha/intro/ and generate keys.
+*(optional)* Generating VAPID keys
+----------------------------------------------------------------
+If you want to enable ServiceWroker, you need to generate VAPID keys:
+
+``` shell
+npm install web-push -g
+web-push generate-vapid-keys
+```
+
*3.* Install dependencies
----------------------------------------------------------------
Please install and setup these softwares:
@@ -51,24 +60,6 @@ Please install and setup these softwares:
*4.* Install Misskey
----------------------------------------------------------------
-There is **two ways** to install Misskey:
-
-### WAY 1) Using built code (recommended)
-We have the official release of Misskey.
-The built code is automatically pushed to https://github.com/syuilo/misskey/tree/release after the CI test succeeds.
-
-1. `git clone -b release git://github.com/syuilo/misskey.git`
-2. `cd misskey`
-3. `npm install`
-
-#### Update
-1. `git fetch`
-2. `git reset --hard origin/release`
-3. `npm install`
-
-### WAY 2) Using source code
-If you want to build Misskey manually, you can do it via the
-`build` command after download the source code of Misskey and install dependencies:
1. `git clone -b master git://github.com/syuilo/misskey.git`
2. `cd misskey`
diff --git a/docs/setup.ja.md b/docs/setup.ja.md
index 602fd9b6a1..1e8bb553fa 100644
--- a/docs/setup.ja.md
+++ b/docs/setup.ja.md
@@ -37,6 +37,15 @@ Misskeyは以下のサブドメインを使います:
MisskeyはreCAPTCHAトークンを必要とします。
https://www.google.com/recaptcha/intro/ にアクセスしてトークンを生成してください。
+*(オプション)* VAPIDキーペアの生成
+----------------------------------------------------------------
+ServiceWorkerを有効にする場合、VAPIDキーペアを生成する必要があります:
+
+``` shell
+npm install web-push -g
+web-push generate-vapid-keys
+```
+
*3.* 依存関係をインストールする
----------------------------------------------------------------
これらのソフトウェアをインストール・設定してください:
@@ -52,26 +61,6 @@ https://www.google.com/recaptcha/intro/ にアクセスしてトークンを生
*4.* Misskeyのインストール
----------------------------------------------------------------
-Misskeyをインストールするには**2つの方法**があります:
-
-### 方法 1) ビルドされたコードを利用する (推奨)
-Misskeyには公式のリリースがあります。
-ビルドされたコードはCIテストに合格した後、自動で https://github.com/syuilo/misskey/tree/release にpushされています。
-
-1. `git clone -b release git://github.com/syuilo/misskey.git`
-2. `cd misskey`
-3. `npm install`
-
-#### アップデートするには:
-1. `git fetch`
-2. `git reset --hard origin/release`
-3. `npm install`
-
-### 方法 2) ソースコードを利用する
-> 注: この方法では正しくビルド・動作できることは保証されません。
-
-Misskeyを手動でビルドしたい場合は、Misskeyのソースコードと依存関係をインストールした後、
-`build`コマンドを用いることができます:
1. `git clone -b master git://github.com/syuilo/misskey.git`
2. `cd misskey`