diff options
| author | syuilo <syuilotan@yahoo.co.jp> | 2017-05-19 00:52:50 +0900 |
|---|---|---|
| committer | syuilo <syuilotan@yahoo.co.jp> | 2017-05-19 00:52:50 +0900 |
| commit | 6e57ef281da36c3a3dc5049e57f58e32003ada0e (patch) | |
| tree | 4384df411757720165f8a7c6388ab853f6cfeaf6 | |
| parent | Update setup.md (diff) | |
| download | sharkey-6e57ef281da36c3a3dc5049e57f58e32003ada0e.tar.gz sharkey-6e57ef281da36c3a3dc5049e57f58e32003ada0e.tar.bz2 sharkey-6e57ef281da36c3a3dc5049e57f58e32003ada0e.zip | |
やった
| -rw-r--r-- | README.md | 2 | ||||
| -rw-r--r-- | docs/BASE.pug | 43 | ||||
| -rw-r--r-- | docs/docker.en.md | 23 | ||||
| -rw-r--r-- | docs/license.pug | 8 | ||||
| -rw-r--r-- | docs/setup.en.md (renamed from docs/setup.md) | 63 | ||||
| -rw-r--r-- | docs/setup.ja.md | 93 | ||||
| -rw-r--r-- | src/docs/api/entities/post.pug (renamed from docs/api/entities/post.pug) | 0 | ||||
| -rw-r--r-- | src/docs/api/entities/user.pug (renamed from docs/api/entities/user.pug) | 0 | ||||
| -rw-r--r-- | src/docs/api/getting-started.pug (renamed from docs/api/getting-started.pug) | 0 | ||||
| -rw-r--r-- | src/docs/api/library.pug (renamed from docs/api/library.pug) | 0 | ||||
| -rw-r--r-- | src/docs/index.pug (renamed from docs/index.pug) | 0 | ||||
| -rw-r--r-- | src/docs/link-to-twitter.pug (renamed from docs/link-to-twitter.pug) | 0 | ||||
| -rw-r--r-- | src/docs/privacy.pug (renamed from docs/privacy.pug) | 0 | ||||
| -rw-r--r-- | src/docs/tou.pug (renamed from docs/tou.pug) | 0 |
14 files changed, 135 insertions, 97 deletions
@@ -25,7 +25,7 @@ and more! You can touch with your own eyes at https://misskey.xyz/. Setup and Installation ---------------------------------------------------------------- -Please see [Setup and installation guide](./docs/setup.md). +Please see [Setup and installation guide](./docs/setup.en.md). Contribution ---------------------------------------------------------------- diff --git a/docs/BASE.pug b/docs/BASE.pug deleted file mode 100644 index 633488202f..0000000000 --- a/docs/BASE.pug +++ /dev/null @@ -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 diff --git a/docs/docker.en.md b/docs/docker.en.md new file mode 100644 index 0000000000..fc5f348bfb --- /dev/null +++ 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. diff --git a/docs/license.pug b/docs/license.pug deleted file mode 100644 index 323b9b9528..0000000000 --- a/docs/license.pug +++ /dev/null @@ -1,8 +0,0 @@ -extend ./BASE - -block title - | ライセンス - -block content - h1 ライセンス - div!= license diff --git a/docs/setup.md b/docs/setup.en.md index 3a5edfca97..4f8b3b2019 100644 --- a/docs/setup.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 ----------------------------------------------------------------- - -There is **two ways** to install and setup dependencies: - -### 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` +[Japanse version also available - 日本語版もあります](./setup.ja.md) -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 +If you can use Docker, Please see [Setup with Docker](./docker.en.md). -*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. -*4.* Install Misskey +*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 diff --git a/docs/setup.ja.md b/docs/setup.ja.md new file mode 100644 index 0000000000..e260ae0fcb --- /dev/null +++ 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:*`となっています。 diff --git a/docs/api/entities/post.pug b/src/docs/api/entities/post.pug index e505d3fcb6..e505d3fcb6 100644 --- a/docs/api/entities/post.pug +++ b/src/docs/api/entities/post.pug diff --git a/docs/api/entities/user.pug b/src/docs/api/entities/user.pug index a37886bb19..a37886bb19 100644 --- a/docs/api/entities/user.pug +++ b/src/docs/api/entities/user.pug diff --git a/docs/api/getting-started.pug b/src/docs/api/getting-started.pug index 2aa2822e42..2aa2822e42 100644 --- a/docs/api/getting-started.pug +++ b/src/docs/api/getting-started.pug diff --git a/docs/api/library.pug b/src/docs/api/library.pug index 4b2943b2a9..4b2943b2a9 100644 --- a/docs/api/library.pug +++ b/src/docs/api/library.pug diff --git a/docs/index.pug b/src/docs/index.pug index bae22d9c7f..bae22d9c7f 100644 --- a/docs/index.pug +++ b/src/docs/index.pug diff --git a/docs/link-to-twitter.pug b/src/docs/link-to-twitter.pug index 6e98df52c3..6e98df52c3 100644 --- a/docs/link-to-twitter.pug +++ b/src/docs/link-to-twitter.pug diff --git a/docs/privacy.pug b/src/docs/privacy.pug index 75885c2b0f..75885c2b0f 100644 --- a/docs/privacy.pug +++ b/src/docs/privacy.pug diff --git a/docs/tou.pug b/src/docs/tou.pug index cb3ab84a48..cb3ab84a48 100644 --- a/docs/tou.pug +++ b/src/docs/tou.pug |