やった

2017-05-19 00:52:50 +09:00 · 2017-05-19 00:52:50 +09:00 · 6e57ef281d
commit 6e57ef281d
parent 27a519cb1c
14 changed files with 135 additions and 97 deletions
--- a/docs/BASE.pug
+++ b/docs/BASE.pug
@ -1,43 +0,0 @@
-doctype html
-
-html(lang='ja', dir='ltr')
-
-	head
-		meta(charset='utf-8')
-		meta(name='application-name', content='Misskey')
-		meta(name='theme-color', content=themeColor)
-		meta(name='referrer', content='origin')
-		meta(name='viewport', content='width=device-width, initial-scale=1, minimum-scale=1, maximum-scale=1, user-scalable=no')
-		link(rel='stylesheet', href='/assets/style.css')
-		title
-			block title
-			|  | About Misskey
-
-	body
-		nav
-			ul
-				li: a(href='/link-to-twitter') Twitterと連携する
-				li
-					p API
-					ul
-						li: a(href='/api/getting-started') Getting Started
-						li
-							p Entities
-							ul
-								li: a(href='/api/entities/post') Post
-								li: a(href='/api/entities/user') User
-						li: a(href='/api/library') ライブラリ
-				li: a(href='/tou') 利用規約
-				li: a(href='/privacy') プライバシー
-				li: a(href='/license') ライセンス
-
-		main
-			article
-				block content
-			footer
-				p.contribution
-					| 間違いを見つけた、またはドキュメントに貢献したいですか？
-					a(href='https://github.com/syuilo/misskey/blob/master/docs/' + path + '.pug', target='_blank') Github 上でこのページを編集する
-					|  か、
-					a(href='https://github.com/syuilo/misskey/fork', target='_blank') Github からこのサイトを Fork してプルリクエストしましょう！
-				p.copyright (c) syuilo 2017
--- a/docs/api/entities/post.pug
+++ b/docs/api/entities/post.pug
@ -1,149 +0,0 @@
-extend ../../BASE
-
-block title
-	| Entity: Post
-
-block content
-	h1 Post
-	p 投稿を表します。
-
-	section
-		h2 Properties
-		table.entity
-			thead: tr
-				td Name
-				td Type
-				td Description
-			tbody
-				tr.nullable.optional
-					td app
-					td: a(href='./app', target='_blank') App
-					td 投稿したアプリ
-				tr.nullable
-					td app_id
-					td ID
-					td 投稿したアプリのID
-				tr
-					td created_at
-					td Date
-					td 投稿日時
-				tr
-					td id
-					td ID
-					td 投稿ID
-				tr.optional
-					td is_liked
-					td Boolean
-					td いいね したかどうか
-				tr
-					td likes_count
-					td Number
-					td いいね数
-				tr.nullable.optional
-					td media_ids
-					td ID[]
-					td 添付されたメディアのIDの配列
-				tr.nullable.optional
-					td media
-					td: a(href='./drive-file', target='_blank') DriveFile[]
-					td 添付されたメディアの配列
-				tr
-					td replies_count
-					td Number
-					td 返信数
-				tr.optional
-					td reply_to
-					td: a(href='./post', target='_blank') Post
-					td 返信先の投稿
-				tr.nullable
-					td reply_to_id
-					td ID
-					td 返信先の投稿のID
-				tr.optional
-					td repost
-					td: a(href='./post', target='_blank') Post
-					td Repostした投稿
-				tr
-					td repost_count
-					td Number
-					td Repostされた数
-				tr.nullable
-					td repost_id
-					td ID
-					td Repostした投稿のID
-				tr.nullable
-					td text
-					td String
-					td 本文
-				tr.optional
-					td user
-					td: a(href='./user', target='_blank') User
-					td 投稿者
-				tr
-					td user_id
-					td ID
-					td 投稿者のID
-
-	section
-		h2 Example
-		pre: code.
-			{
-				"created_at": "2016-12-10T00:28:50.114Z",
-				"media_ids": null,
-				"reply_to_id": "584a16b15860fc52320137e3",
-				"repost_id": null,
-				"text": "小日向美穂だぞ！",
-				"user_id": "5848bf7764e572683f4402f8",
-				"app_id": null,
-				"likes_count": 1,
-				"replies_count": 1,
-				"id": "584b4c42d8e5186f8f755d0c",
-				"user": {
-					"birthday": null,
-					"created_at": "2016-12-08T02:03:35.332Z",
-					"bio": "女が嫌いです、女性は好きです",
-					"followers_count": 11,
-					"following_count": 11,
-					"links": null,
-					"location": "",
-					"name": "女が嫌い",
-					"posts_count": 26,
-					"likes_count": 2,
-					"liked_count": 20,
-					"username": "onnnagakirai",
-					"id": "5848bf7764e572683f4402f8",
-					"avatar_url": "https://file.himasaku.net/5848c0ec64e572683f4402fc",
-					"banner_url": "https://file.himasaku.net/5848c12864e572683f4402fd",
-					"is_following": true,
-					"is_followed": true
-				},
-				"reply_to": {
-					"created_at": "2016-12-09T02:28:01.563Z",
-					"media_ids": null,
-					"reply_to_id": "5849d35e547e4249be329884",
-					"repost_id": null,
-					"text": "アイコン小日向美穂？",
-					"user_id": "57d01a501fdf2d07be417afe",
-					"app_id": null,
-					"replies_count": 1,
-					"id": "584a16b15860fc52320137e3",
-					"user": {
-						"birthday": null,
-						"created_at": "2016-09-07T13:46:56.605Z",
-						"bio": "どうすれば君だけのために生きていけるの",
-						"followers_count": 51,
-						"following_count": 97,
-						"links": null,
-						"location": "川崎",
-						"name": "きな子",
-						"posts_count": 4813,
-						"username": "syuilo",
-						"likes_count": 3141,
-						"liked_count": 750,
-						"id": "57d01a501fdf2d07be417afe",
-						"avatar_url": "https://file.himasaku.net/583ddc6e64df272771f74c1a",
-						"banner_url": "https://file.himasaku.net/584bfc82d8e5186f8f755ec5"
-					}
-				},
-				"is_liked": true
-			}
--- a/docs/api/entities/user.pug
+++ b/docs/api/entities/user.pug
@ -1,122 +0,0 @@
-extend ../../BASE
-
-block title
-	| Entity: User
-
-block content
-	h1 User
-	p ユーザーを表します。
-
-	section
-		h2 Properties
-		table.entity
-			thead: tr
-				td Name
-				td Type
-				td Description
-			tbody
-				tr.nullable.optional
-					td avatar_id
-					td ID
-					td アバターに設定しているドライブのファイルのID
-				tr.nullable
-					td avatar_url
-					td String
-					td アバターURL
-				tr.nullable.optional
-					td banner_id
-					td ID
-					td バナーに設定しているドライブのファイルのID
-				tr.nullable
-					td banner_url
-					td String
-					td バナーURL
-				tr.nullable
-					td bio
-					td String
-					td プロフィール
-				tr.nullable
-					td birthday
-					td String
-					td 誕生日(YYYY-MM-DD)
-				tr
-					td created_at
-					td Date
-					td アカウント作成日時
-				tr.optional
-					td drive_capacity
-					td Number
-					td ドライブの最大容量(byte単位)
-				tr
-					td followers_count
-					td Number
-					td フォロワー数
-				tr
-					td following_count
-					td Number
-					td フォロー数
-				tr
-					td id
-					td ID
-					td ユーザーID
-				tr.optional
-					td is_bot
-					td Boolean
-					td botかどうか
-				tr.optional
-					td is_followed
-					td Boolean
-					td フォローされているか
-				tr.optional
-					td is_following
-					td Boolean
-					td フォローしているか
-				tr
-					td liked_count
-					td Number
-					td 投稿にいいねされた数
-				tr
-					td likes_count
-					td Number
-					td 投稿にいいねした数
-				tr.nullable
-					td location
-					td String
-					td 住処
-				tr
-					td name
-					td String
-					td ニックネーム
-				tr
-					td posts_count
-					td Number
-					td 投稿数
-				tr
-					td username
-					td String
-					td ユーザー名
-
-	section
-		h2 Example
-		pre: code.
-			{
-				"avatar_id": "583ddc6e64df272771f74c1a",
-				"avatar_url": "https://file.himasaku.net/583ddc6e64df272771f74c1a",
-				"banner_id": "584bfc82d8e5186f8f755ec5",
-				"banner_url": "https://file.himasaku.net/584bfc82d8e5186f8f755ec5",
-				"bio": "どうすれば君だけのために生きていけるの",
-				"birthday": "1997-12-06",
-				"created_at": "2016-09-07T13:46:56.605Z",
-				"drive_capacity": 1073741824,
-				"email": null,
-				"followers_count": 51,
-				"following_count": 97,
-				"id": "57d01a501fdf2d07be417afe",
-				"liked_count": 750,
-				"likes_count": 3130,
-				"links": null,
-				"location": "川崎",
-				"name": "きな子",
-				"posts_count": 4811,
-				"username": "syuilo"
-			}
--- a/docs/api/getting-started.pug
+++ b/docs/api/getting-started.pug
@ -1,82 +0,0 @@
-extend ../BASE
-
-block title
-	| Getting Started
-
-block content
-	h1 Getting Started
-
-	p MisskeyはREST APIやStreaming APIを提供しており、プログラムからMisskeyの全ての機能を利用することができます。
-	p それらのAPIを利用するには、まずAPIを利用したいアカウントのアクセストークンを取得する必要があります:
-
-	section
-		h2 自分のアクセストークンを取得したい場合
-		p 自分自身のアクセストークンは、設定 > API で確認できます。
-		p.tip
-			| アカウントを乗っ取られてしまう可能性があるため、トークンは第三者に教えないでください(アプリなどにも入力しないでください)。
-			br
-			| 万が一トークンが漏れたりその可能性がある場合は トークンを再生成できます。(副作用として、ログインしているすべてのデバイスでログアウトが発生します)
-
-	section
-		h2 他人のアクセストークンを取得する
-		p
-			| 不特定多数のユーザーからAPIを利用したい場合、アプリケーションを作成します。
-			br
-			| アプリケーションを作成すると、ユーザーが連携を許可した時に、そのユーザーのアクセストークンを取得することができます。
-		p アプリケーションを作成しアクセストークンを取得するまでの流れを見ていきます。
-
-		section
-			h3 アプリケーションを作成する
-			p まずはあなたのアプリケーションを作成しましょう。
-			p
-				| <a href=#{dev_url} target="_blank">デベロッパーセンター</a>にアクセスし、アプリ > アプリ作成 に進みます。
-				br
-				| 次に、フォームに必要事項を記入します:
-			dl
-				dt アプリケーション名
-				dd あなたのアプリケーションの名前。
-				dt Named ID
-				dd アプリを識別する/a-z-/で構成されたID。
-				dt アプリの概要
-				dd アプリの簡単な説明を入力してください。
-				dt コールバックURL
-				dd あなたのアプリケーションがWebアプリケーションである場合、ユーザーが後述するフォームで認証を終えた際にリダイレクトするURLを設定できます。
-				dt 権限
-				dd アプリケーションが要求する権限。ここで要求した機能だけがAPIからアクセスできます。
-			p.tip
-				| 権限はアプリ作成後も変更できますが、新たな権限を付与する場合、その時点で関連付けられているユーザーはすべて無効になります。
-			p
-				| アプリケーションを作成すると、作ったアプリの管理ページに進みます。
-				br
-				| アプリのシークレットキー(App Secret)が表示されていますので、メモしておいてください。
-			p.tip
-				| アプリに成りすまされる可能性があるため、極力このシークレットキーは公開しないようにしてください。
-
-		section
-			h3 ユーザーに認証させる
-			p あなたのアプリを使ってもらうには、ユーザーにアカウントへアクセスすることを許可してもらい、Misskeyにそのユーザーのアクセストークンを発行してもらう必要があります。
-			p 認証セッションを開始するには、<code>#{api_url}/auth/session/generate</code>へパラメータに<code>app_secret</code>としてApp Secretを含めたリクエストを送信します。
-			p
-				| そうすると、レスポンスとして認証セッションのトークンや認証フォームのURLが取得できます。
-				br
-				| この認証フォームのURLをブラウザで表示し、ユーザーにフォームを表示してください。
-			section
-				h4 あなたのアプリがコールバックURLを設定している場合
-				p ユーザーがアプリの連携を許可すると設定しているコールバックURLに<code>token</code>という名前でセッションのトークンが含まれたクエリを付けてリダイレクトします。
-			section
-				h4 あなたのアプリがコールバックURLを設定していない場合
-				p ユーザーがアプリの連携を許可したことを(何らかの方法で(たとえばボタンを押させるなど))確認出来るようにしてください。
-			p
-				| 次に、<code>#{api_url}/auth/session/userkey</code>へ<code>app_secret</code>としてApp Secretを、<code>token</code>としてセッションのトークンをパラメータとして付与したリクエストを送信してください。
-				br
-				| 上手くいけば、認証したユーザーのアクセストークンがレスポンスとして取得できます。おめでとうございます！
-			p
-				| 以降アクセストークンは、<strong>ユーザーのアクセストークン+アプリのシークレットキーをsha256したもの</strong>として扱います。
-
-	p アクセストークンを取得できたら、あとは簡単です。REST APIなら、リクエストにアクセストークンを<code>i</code>としてパラメータに含めるだけです。
-
-	section
-		h2 リクエスト形式
-		p <code>application/json</code>を受け付けます。
-		p.tip
-			| 現在<code>application/x-www-form-urlencoded</code>も受け付けていますが、将来的にこのサポートはされなくなる予定です。
--- a/docs/api/library.pug
+++ b/docs/api/library.pug
@ -1,14 +0,0 @@
-extend ../BASE
-
-block title
-	| ライブラリ
-
-block content
-	h1 ライブラリ
-
-	p Misskey APIを便利に利用するためのライブラリ一覧です。
-
-	section
-		h2 .NET
-		ul
-			li: strong: a(href='https://github.com/syuilo/Misq') Misq (公式)
--- a/docs/docker.en.md
+++ b/docs/docker.en.md
@ -0,0 +1,23 @@
+Setup with Docker :whale:
+================================================================
+
+Ensure that the working directory is the repository root directory.
+
+To create misskey image:
+
+`sudo docker build -t misskey ./docker`
+
+To run misskey:
+
+`sudo docker run --rm -i -t -p $PORT:80 -v $(pwd):/root/misskey -v $DBPATH:/data/db misskey`
+
+where `$PORT` is the port used to access Misskey Web from host browser
+and `$DBPATH` is the path of MongoDB database on the host for data persistence.
+
+ex: `sudo docker run --rm -i -t -p 80:80 -v $(pwd):/root/misskey -v /data/db:/data/db misskey`
+
+If you want to run misskey in production mode, add `--env NODE_ENV=production` like this:
+
+`sudo docker run --rm -i -t -p 80:80 -v $(pwd):/root/misskey -v /data/db:/data/db --env NODE_ENV=production misskey`
+
+Note that `$(pwd)` is the working directory.
--- a/docs/index.pug
+++ b/docs/index.pug
@ -1,9 +0,0 @@
-extend ./BASE
-
-block title
-	| About Misskey
-
-block content
-	h1 About Misskey
-
-	p 誰か書いて
--- a/docs/license.pug
+++ b/docs/license.pug
@ -1,8 +0,0 @@
-extend ./BASE
-
-block title
-	| ライセンス
-
-block content
-	h1 ライセンス
-	div!= license
--- a/docs/link-to-twitter.pug
+++ b/docs/link-to-twitter.pug
@ -1,14 +0,0 @@
-extend ./BASE
-
-block title
-	| Twitterと連携する
-
-block content
-	h1 Twitterと連携する
-
-	p 設定 -> Twitter から、お使いのMisskeyアカウントとお使いのTwitterアカウントを関連付けることができます。
-	p アカウントの関連付けを行うと、プロフィールにTwitterアカウントへのリンクが表示されたりなどします。
-	p
-		| MisskeyがあなたのTwitterアカウントでツイートしたり誰かをフォローしたりなどといったことは一切行いませんので、ご安心ください。(Misskeyはそのような権限を取得しないので、行おうと思っても行えません)
-		br
-		| このことに関しては、Twitterのアプリケーション認証フォームで詳細を確認することができます。また、いつでも連携を取り消すことができます。
--- a/docs/privacy.pug
+++ b/docs/privacy.pug
@ -1,10 +0,0 @@
-extend ./BASE
-
-block title
-	| プライバシーポリシー
-
-block content
-	h1 プライバシーポリシー
-
-	p Misskeyはユーザーの了解を得た上でメールアドレスを設定することがありますが、この情報をみだりに公開することはありません。ただし、法的強制力のある請求の場合はこの限りではありません。
-	p プライバシーポリシーは予告なく変更される可能性があります。
--- a/docs/setup.en.md
+++ b/docs/setup.en.md
@ -4,51 +4,14 @@ Misskey Setup and Installation Guide
 We thank you for your interest in setup your Misskey server!
 This guide describes how to install and setup Misskey.

-*1.* Install dependencies
+[Japanse version also available - 日本語版もあります](./setup.ja.md)
+
 ----------------------------------------------------------------

-There is **two ways** to install and setup dependencies:
+If you can use Docker, Please see [Setup with Docker](./docker.en.md).

-### WAY 1) Setup with Docker :whale:
-
-Ensure that the working directory is the repository root directory.
-
-To create misskey image:
-
-`sudo docker build -t misskey ./docker`
-
-To run misskey:
-
-`sudo docker run --rm -i -t -p $PORT:80 -v $(pwd):/root/misskey -v $DBPATH:/data/db misskey`
-
-where `$PORT` is the port used to access Misskey Web from host browser
-and `$DBPATH` is the path of MongoDB database on the host for data persistence.
-
-ex: `sudo docker run --rm -i -t -p 80:80 -v $(pwd):/root/misskey -v /data/db:/data/db misskey`
-
-If you want to run misskey in production mode, add `--env NODE_ENV=production` like this:
-
-`sudo docker run --rm -i -t -p 80:80 -v $(pwd):/root/misskey -v /data/db:/data/db --env NODE_ENV=production misskey`
-
-Note that `$(pwd)` is the working directory.
-
-### WAY 2) Setup manually
-
-Please install and setup following dependencies:
-
-#### Dependencies :package:
-Please install these softwares.
-* *Node.js* and *npm*
-* **[MongoDB](https://www.mongodb.com/)**
-* **[Redis](https://redis.io/)**
-* **[GraphicsMagick](http://www.graphicsmagick.org/)**
-
-##### Optional
-* [Elasticsearch](https://www.elastic.co/) - used to provide searching feature instead of MongoDB
-
-*2.* Domains
+*1.* Domains
 ----------------------------------------------------------------
-
 Misskey requires two domains called the primary domain and the secondary domain.

 * The primary domain is used to provide main service of Misskey.
@ -65,15 +28,26 @@ Note that Misskey uses following subdomains:
 * **dev**.*{primary domain}*
 * **file**.*{secondary domain}*

-*3.* reCAPTCHA tokens
+*2.* reCAPTCHA tokens
 ----------------------------------------------------------------
-
 Misskey requires reCAPTCHA tokens.
 Please visit https://www.google.com/recaptcha/intro/ and generate keys.

+*3.* Install dependencies
+----------------------------------------------------------------
+Please install and setup these softwares:
+
+#### Dependencies :package:
+* *Node.js* and *npm*
+* **[MongoDB](https://www.mongodb.com/)**
+* **[Redis](https://redis.io/)**
+* **[GraphicsMagick](http://www.graphicsmagick.org/)**
+
+##### Optional
+* [Elasticsearch](https://www.elastic.co/) - used to provide searching feature instead of MongoDB
+
 *4.* Install Misskey
 ----------------------------------------------------------------
-
 There is **two ways** to install Misskey:

 ### WAY 1) Using built code (recommended)
@ -105,7 +79,6 @@ If you want to build Misskey manually, you can do it via the

 *5.* That is it.
 ----------------------------------------------------------------
-
 お疲れ様でした。これでMisskeyを動かす準備は整いました。

 ### Launch
--- a/docs/setup.ja.md
+++ b/docs/setup.ja.md
@ -0,0 +1,93 @@
+Misskey構築の手引き
+================================================================
+
+Misskeyサーバーの構築にご関心をお寄せいただきありがとうございます！
+このガイドではMisskeyのインストール・セットアップ方法について解説します。
+
+[英語版もあります - English version also available](./setup.en.md)
+
+----------------------------------------------------------------
+
+Dockerを利用してMisskeyを構築することもできます: [Setup with Docker](./docker.en.md)。
+その場合、3および4番目の手順はスキップできます。
+
+*1.* ドメインの用意
+----------------------------------------------------------------
+Misskeyはプライマリ ドメインとセカンダリ ドメインを必要とします。
+
+* プライマリ ドメインはMisskeyの主要な部分を提供するために使われます。
+* セカンダリ ドメインはXSSといった脆弱性の対策に使われます。
+
+**セカンダリ ドメインがプライマリ ドメインのサブドメインであってはなりません。**
+
+### サブドメイン
+Misskeyは以下のサブドメインを使います:
+
+* **api**.*{primary domain}*
+* **auth**.*{primary domain}*
+* **about**.*{primary domain}*
+* **dev**.*{primary domain}*
+* **file**.*{secondary domain}*
+
+*2.* reCAPTCHAトークンの用意
+----------------------------------------------------------------
+MisskeyはreCAPTCHAトークンを必要とします。
+https://www.google.com/recaptcha/intro/ にアクセスしてトークンを生成してください。
+
+*3.* 依存関係をインストールする
+----------------------------------------------------------------
+これらのソフトウェアをインストール・設定してください:
+
+#### 依存関係 :package:
+* *Node.js* と *npm*
+* **[MongoDB](https://www.mongodb.com/)**
+* **[Redis](https://redis.io/)**
+* **[GraphicsMagick](http://www.graphicsmagick.org/)**
+
+##### オプション
+* [Elasticsearch](https://www.elastic.co/) - 検索機能を向上させるために用います。
+
+*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`
+3. `npm install`
+4. `npm run build`
+
+#### アップデートするには:
+1. `git pull origin master`
+2. `npm install`
+3. `npm run build`
+
+*5.* 以上です！
+----------------------------------------------------------------
+お疲れ様でした。これでMisskeyを動かす準備は整いました。
+
+### 起動
+`sudo npm start`するだけです。GLHF!
+
+### テスト
+(ビルドされている状態で)`npm test`
+
+### デバッグ :bug:
+#### デバッグメッセージを表示するようにする
+Misskeyは[debug](https://github.com/visionmedia/debug)モジュールを利用しており、ネームスペースは`misskey:*`となっています。
--- a/docs/tou.pug
+++ b/docs/tou.pug
@ -1,9 +0,0 @@
-extend ./BASE
-
-block title
-	| 利用規約
-
-block content
-	h1 利用規約
-
-	p 法律上問題のあることはお止めください。