(fix) re-format markdonwn for docs translation

#87
This commit is contained in:
kakkokari-gtyih 2023-12-27 14:27:22 +09:00
parent ab4fea3e7e
commit aa4da8b80e
32 changed files with 164 additions and 0 deletions

View File

@ -14,7 +14,9 @@ Misskeyはオープンソースの分散型マイクロブログプラットフ
当初は分散型ではありませんでしたが、2018年にActivityPubを実装し分散型になったことで、より多くの方に認知され利用されるサービスになり、現在に至ります。
:::tip
Misskeyという名前は、syuiloが当時聴いていたMay'nというアーティストの楽曲、Brain Diverの歌詞に由来します。
:::
誰でも開発に参加することができ、現在でも活発に開発が続いています。
@ -32,7 +34,9 @@ Misskeyのすべてのソースコードは[AGPL](https://github.com/misskey-dev
再び引き合いに出しますが、TwitterやFacebookなどの利益を得ているほとんどのサービスはオープンソースではありません。
:::tip
技術的に言うと、MisskeyのソースコードはGitで管理されていて、リポジトリは[GitHub上でホスティングされています。](https://github.com/misskey-dev)
:::
## 開発に参加する、プロジェクトを支援する

View File

@ -9,9 +9,11 @@ Misskeyを利用するには、どこかのサーバーにアカウントを作
[サーバー一覧](/servers/)から、好きなサーバーを選ぶことができます。
:::tip
どのサーバーを選んでも、他のサーバーのユーザーとやり取りすることができます。
:::g-details{summary='詳細'}
Misskeyには連合機能が備わっています。
連合機能によって、別のサーバーのユーザーであっても、同じサーバーのユーザーと同じようにフォローやリアクション、Renoteなどができるようになっています。
@ -27,5 +29,7 @@ Misskeyが搭載している連合機能はActivityPubというオープンな
自分にあったテーマのサーバーを探すのもおすすめです。
:::tip
サーバーの一覧は[こちら](/servers/)からご覧いただけます。
:::

View File

@ -3,6 +3,7 @@
登録するサーバーが決まったら、さっそくアカウントを作成しましょう。
:::tip
ここでは、Misskey.ioを例にとって紹介していますが、他のサーバーでも登録方法はおおむね同じです。
ただし、入力事項はサーバーによって異なることがあります。詳しくは、サーバー管理者にお問い合わせください。

View File

@ -7,7 +7,9 @@
Misskeyへの投稿は、「ート」と呼ばれます。Twitterなどの一般的なSNSに比べたくさんの機能がありますので、初めての投稿を行う前に必ず確認して、上手に投稿しましょう
:::tip
詳細は、「[ノート](/docs/for-users/features/note/)」をご覧ください。
:::
## タイムライン
@ -15,7 +17,9 @@ Misskeyへの投稿は、「ート」と呼ばれます。Twitterなどの一
Misskeyは、複数のタイムラインを持っています。名前だけでは少々わかりにくいかと思いますので、それぞれがどのような働きをするのかを知っておきましょう。
:::tip
詳細は、「[タイムライン](/docs/for-users/features/timeline/)」をご覧ください。
:::
## その他

View File

@ -3,7 +3,9 @@ Misskeyではサーバーによる広告をタイムラインなどに表示で
広告の右上に表示されるアイコンをクリックすることで、当該の広告の表示頻度を下げることができます。
:::tip
広告の総数が少ない場合は、表示頻度を下げた後も連続で表示される可能性があります。
:::
## 広告の設定(管理者)

View File

@ -2,7 +2,9 @@
ドライブは、Misskey上でファイルを管理できる機能です。
:::tip
技術的に言うと、Misskeyのシステム上、すべてのファイルが一元管理されており、それをユーザーにも公開したインターフェイスがドライブと捉えることができます。
:::
Misskey Webのドライブページから任意のファイルをアップロードできるほか、アバターに設定した画像や、ートに添付したファイルなどもすべてドライブにアップロードされます。
@ -12,7 +14,9 @@ Misskey Webのドライブページから任意のファイルをアップロー
ドライブ内にフォルダを作り、複数のファイルをまとめて整理することもできます。
:::warning
現時点で、ドライブからファイルを削除すると、そのファイルが添付された **すべてのコンテンツ(ノート、ページなど)** も同時に消えます。
:::
## センシティブ (NSFW)

View File

@ -6,7 +6,9 @@ description: 'MFMは、Misskeyの様々な場所で使用できる専用のマ
MFMは、Markup language For Misskeyの略で、Misskeyの様々な場所で使用できる専用のマークアップ言語です。
:::tip
一部の構文はMarkdownやHTMLと互換性があります。
:::
## MFMが使用可能な場所の例
@ -19,7 +21,9 @@ MFMは、Markup language For Misskeyの略で、Misskeyの様々な場所で使
### メンション
アットマーク + ユーザー名で、特定のユーザーを示すことができます。
:::tip
メンションについての詳細は[こちら](./mention.md)を参照してください。
:::
```
@ -37,7 +41,9 @@ MFMは、Markup language For Misskeyの略で、Misskeyの様々な場所で使
### ハッシュタグ
ナンバーサイン + タグで、ハッシュタグを示すことができます。
:::tip
ハッシュタグについての詳細は[こちら](./hashtag.md)を参照してください。
:::
```
@ -61,7 +67,9 @@ https://example.com
```
:::tip
リンクテキストの前に`?`をつけると、リンクプレビューを非表示にすることができます。
```
?[example link](https://example.com)
```
@ -72,8 +80,11 @@ https://example.com
### カスタム絵文字
コロンでカスタム絵文字名を囲むと、カスタム絵文字を表示させることができます。
:::tip
カスタム絵文字についての詳細は[こちら](./custom-emoji.md)を参照してください。
:::
```

View File

@ -4,11 +4,15 @@
ミュートされていることは相手は分かりませんが、ブロックされていることは相手に分かります。どちらを選ぶかはご自身の判断で行ってください。
:::tip
ミュートとブロックは併用できます。
:::
:::warning
利用規約に違反するような、迷惑なユーザーがいる場合は運営者に報告することも検討してください。
:::
Misskey Webでは、設定>ミュートとブロック から、自分がミュートまたはブロックしているユーザー一覧を確認することができます。
@ -24,7 +28,9 @@ Misskey Webでは、設定>ミュートとブロック から、自分がミュ
Misskey Webでユーザーをミュートするには、対象のユーザーのユーザーページのメニューを開き、「ミュート」ボタンを押します。
:::tip
ミュートを行ったことは相手に通知されず、ミュートされていることを知ることもできません。
:::
## ブロック
@ -45,9 +51,13 @@ Misskey Webでユーザーをミュートするには、対象のユーザーの
Misskey Webでユーザーをブロックするには、対象のユーザーのユーザーページのメニューを開き、「ブロック」ボタンを押します。
:::warning
ブロックを行ったこと自体は相手に通知されませんが、フォローを行ったりなどの上記のアクションが行えなくなるので間接的にブロックされていることは分かります。
:::
:::warning
相手から自分のコンテンツが見えなくなりますが、相手がアカウントを切り替えたりログアウト状態になれば見ることができます。あくまで簡易的、補助的なものとしてお考えください。
:::

View File

@ -2,7 +2,9 @@
ートは、Misskeyに投稿される、文章、ファイル、アンケートなどを含むコンテンツで、Misskeyの中心的概念です。また、そのートを作成する行為自体もートと呼ばれます。
:::tip
ノートという名称は、英語で「短い記録」を意味する Note が由来になっています。
:::
ノートが作成されると、[タイムライン](./timeline)に追加され、自分の[フォロワー](./follow)やサーバーのユーザーが見れるようになります。
@ -17,11 +19,15 @@ Misskey Webでートを作成するには、画面上にある鉛筆マーク
他にも、CWや公開範囲といった設定も行えます(詳細は後述)。
:::tip
Misskey Webでは、コンピューターのクリップボードに画像データがある状態で、フォーム内のテキストボックスにペーストするとその画像を添付することができます。
:::
:::tip
Misskey Webでは、テキストボックス内で<kbd class="key">Ctrl + Enter</kbd>を押すことでも投稿できます。
:::
## Renote
@ -30,7 +36,9 @@ Misskey Webでは、テキストボックス内で<kbd class="key">Ctrl + Enter<
同じートに対して無制限にRenoteを行うことができますが、あまり連続して使用すると迷惑になる場合もあるので、注意しましょう。
:::warning
公開範囲がフォロワーやダイレクトのートはRenoteできません。
:::
Misskey WebでRenoteを削除するには、Renoteの時刻表示の隣にある「...」を押し、「Renote解除」を選択します。
@ -48,7 +56,9 @@ Misskey Webで公開範囲を設定するには、フォームの「ート」
全ての人に対してノートが公開されるほか、サーバーの全てのタイムライン(ホームタイムライン、ローカルタイムライン、ソーシャルタイムライン、グローバルタイムライン)にノートが流れます。
:::warning
アカウントが[サイレンス](./silence)状態の時は、この公開範囲は使用できません。
:::
### ホーム
@ -75,7 +85,9 @@ Misskey Webで公開範囲を設定するには、フォームの「ート」
Misskey Webでピン留めを行うには、ートのメニューを開き、「ピン留め」を選択します。
:::tip
複数のノートを同時にピン留めすることも可能です。
:::
## ウォッチ

View File

@ -34,5 +34,7 @@
設定により、オンラインステータスを非公開にすることができます。
:::warning
ユーザーのサジェストなど、一部の機能においてはオンラインステータスを元に処理される場合があるため、ステータスを非公開にすると他のユーザーから見つけにくくなることがあります。
:::

View File

@ -3,7 +3,9 @@
Misskey上でートとは別にページを作成できます。v13では静的ページに特化しています。
:::warning
v13よりページによる動的ページ作成の代わりにMisskey Playが使用できます。
:::
## ページ設定

View File

@ -10,7 +10,9 @@
追加しすぎてしまった入力欄は、入力欄の横の☓ボタンを押すことで削除することができます。
:::warning
いずれかの入力欄が空白だった場合、そのアンケートが添付されたノートは投稿できません。
:::
## 複数回答を可能にする
@ -35,7 +37,9 @@
未投票のアンケートの結果を見たあと、もう一度隠すときは「投票する」をクリックします。
:::tip
未投票アンケートには、結果を表示した状態でも投票できます。
:::
投票をすると、自分の投票した選択肢に✔がつきます。

View File

@ -6,7 +6,9 @@ URLにクエリパラメータとして共有内容をはじめとするいく
## クエリパラメータ
:::tip
すべてのパラメータは**オプション**であり、必須ではありません。
:::
| 名前 | 説明 |
@ -42,7 +44,9 @@ URLにクエリパラメータとして共有内容をはじめとするいく
| `visibleAccts` | 対象ユーザー[acct](../resources/glossary/#acct)(カンマ区切り) |
:::warning
`visibility`に`specified`を指定した場合は、`visibleUserIds`または`visibleAccts`の指定も必要です。
:::
### 添付ファイル

View File

@ -1,6 +1,8 @@
# スレッドミュート
:::tip
バージョン 12.95.0 以降の機能です。
:::
スレッドミュートは、指定したノートのスレッドをミュートします。スレッドとは、起点のノートから繋がった全てのリプライのことです。
@ -10,5 +12,7 @@
Misskey Webでスレッドをミュートするには、対象のスレッドに属する任意のートもしくは起点のートのメニューを開き、「スレッドをミュート」を選択します。
:::warning
スレッド内のどのノートからミュート操作を行ったかに関わらず、そのスレッド全体がミュートされます。
:::

View File

@ -1,10 +1,14 @@
# Webhook
:::tip
バージョン 12.109.0 以降の機能です。
:::
:::warning
実験的な機能であるため、動作が不安定だったり今後仕様が変更される可能性があります。
:::
MisskeyにはWebhookが用意されています。Webhookを利用すると、Misskey上の様々なイベントをリアルタイムに受け取ることが可能です。

View File

@ -4,7 +4,9 @@ description: '問題が発生したときは、まずこちらをご確認くだ
# トラブルシューティング
:::tip
[よくある質問](./faq.md)も合わせてお役立てください。
:::
問題が発生したときは、まずこちらをご確認ください。
@ -52,7 +54,9 @@ description: '問題が発生したときは、まずこちらをご確認くだ
クライアントの設定の「キャッシュをクリア」すると直ります。
:::warning
「クライアントの」キャッシュクリアです。「ブラウザの」キャッシュクリアは行わないでください。
:::
## 通知やアンテナ等の点滅が消えない

View File

@ -12,19 +12,26 @@ Misskeyはビジネスではなく、利用は無料であるため、収益は
- [Amazonの欲しいものリスト](https://www.amazon.jp/hz/wishlist/ls/4JG4P6XKX9KD?ref_=wl_share)
:::tip
高額の寄付(例えば5万円以上)をされる場合は、PayPal等ですと手数料が高額になってしまいますので、Kyashをご検討いただくか、ご連絡いただければ銀行口座をお伝えいたします。
:::
:::tip
額に応じて以下の返礼を用意しています。
- 1,000円以上: お使いのmisskey.ioアカウントにmiバッジ付与
- 3,000円以上: ↑ + Misskeyのクレジットへのお名前の記載
- 10,000円以上: ↑ + Misskeyのクレジットへのお名前+任意のアイコンの掲載
:::
:::warning
**バッジ付与やクレジットへの記載は自動で行われないため、ご希望の方は寄付されたことが分かる情報を添えて@syuilo@misskey.ioまでお申し付けください。**
(メンション気づかない場合があるので返信がなければ複数回メンションお願いします。また、misskey.io以外のサーバーからはメンション届かない場合があります)
:::
また、サーバーの運営者も、基本的には収益を得ていません。サーバーの運営にはコストがかかるので、運営者の支援をすることもご検討ください。

View File

@ -5,7 +5,9 @@ Misskey Hubは、Misskeyに関するナレッジなどのドキュメント、
Misskey Hubも[オープンソースで公開されています。](https://github.com/misskey-dev/misskey-hub)
:::tip
Misskey HubはNuxtを使ってビルドされた静的サイトです。
:::
## Misskey Hubに貢献する

View File

@ -5,6 +5,7 @@
お知らせ機能を使用すると、ユーザーにサーバー全体のお知らせを掲示することができるほか、ユーザー個別にサーバーからのメッセージを送ることができます。
:::warning
アクティブなお知らせの数が多いと、特に新規ユーザーの確認作業が増え、UXが低下する可能性があります。その場合、以下のオプションを検討できます。
- 「既存ユーザーのみ」オプションを有効にしてお知らせを作成する

View File

@ -20,8 +20,10 @@
- **コンディショナル** ... 条件を設定し、それに合致するユーザーが自動で含まれるようになります。(コンディショナル ロール)
:::warning
コンディショナル ロールは、マニュアル ロールと比較して以下の制限があります。
- 手動でのアサイン/アサイン解除は行えません。
- 指定したコンディショナル ロールに含まれるユーザー一覧を取得することはできません。
:::
@ -50,6 +52,7 @@
**優先度が同じ場合、デフォルトで最も大きい、または最も権限が広い値が選択されます。**
:::tip
例えば、ユーザーにロールAとロールBがアサインされていて、ロールAのドライブ容量ポリシーが 500MB、ロールBのドライブ容量ポリシーが 300MB に定義されている場合、
- 優先度が同じ、もしくはロールAのドライブ容量ポリシーの優先度の方が高い場合 500MB の値が採用されます。
@ -59,6 +62,7 @@
- 優先度が同じ、もしくはロールDのパブリック投稿可否ポリシーの優先度の方が高い場合「はい」の値が採用されます。
- ロールCのパブリック投稿可否ポリシーの優先度の方が高い場合「いいえ」の値が採用されます。
:::
### ベースロールの値を使用
@ -82,11 +86,15 @@
アサインする際にアサインされる期間を設定することが可能です。
:::tip
ロールのアサイン/アサイン解除が反映されるまで時間がかかることがあります。
:::
:::warning
コンディショナル ロールには手動でのアサインはできません。
:::
## ユーザーのポリシーの確認

View File

@ -6,12 +6,16 @@ description: 'Misskeyサーバーの作成方法についての案内です。'
Misskeyサーバーの構築に関心をお寄せいただきありがとうございます。サーバーの作成方法はいくつかあるので、下記から選んでガイドをお読みください。
:::danger
一度使用を始めたサーバーのドメイン・ホスト名では、データベースを作り直さないでください!
:::
:::warning
自分のサーバーに対して Cloudflare を使用する場合、 Auto Minify 設定は使用しないようにしてください。
Misskeyのソースコードは既にMinifyされているため意味がないばかりでなく、Cloudflare が最新の JavaScript を解釈せず、中のソースコードを破壊するため、Misskey が正常に動作しません。
詳しくは [misskey-dev/misskey #9791](https://github.com/misskey-dev/misskey/issues/9791) をご覧ください。

View File

@ -18,7 +18,9 @@ Misskeyを簡単にインストールするためのシェルスクリプトが
3. Cloudflareアカウント推奨
:::danger
一度使用を始めたサーバーのドメイン・ホスト名では、データベースを作り直さないでください!
:::
Let's Encryptの認証を試行できる回数が少ないので、サーバーのネットワークやDNSの設定を十分確認してからインストールを開始してください。

View File

@ -8,7 +8,9 @@ Docker Composeを使ったMisskey構築
このガイドはDocker Composeを使ったMisskeyセットアップ方法を説明します。
:::danger
一度使用を始めたサーバーのドメイン・ホスト名では、データベースを作り直さないでください!
:::
:::tip{label='前提条件'}
@ -59,7 +61,9 @@ GLHF✨
Misskeyのアップデート方法
----------------------------------------------------------------
:::warning
アップデートの際は必ず[リリースノート](https://github.com/misskey-dev/misskey/blob/master/CHANGELOG.md)を確認し、変更点や追加で必要になる作業の有無(ほとんどの場合ありません)を予め把握するようにしてください。
:::
```sh

View File

@ -2,7 +2,9 @@
このガイドでは、Kubernetes と HelmChartを使用したMisskeyセットアップ方法について説明します。
:::danger
一度使用を始めたサーバーのドメイン・ホスト名では、データベースを作り直さないでください!
:::
## TrueCharts と TrueNAS Scale

View File

@ -8,7 +8,9 @@ Misskeyを手動で構築する
このガイドではMisskeyのインストール・セットアップ方法について解説します。
:::danger
一度使用を始めたサーバーのドメイン・ホスト名は、決して変更しないでください!
:::
:::tip{label='前提条件'}
@ -105,7 +107,9 @@ WantedBy=multi-user.target
```
:::warning
CentOSで1024以下のポートを使用してMisskeyを使用する場合は`ExecStart=/usr/bin/sudo /usr/bin/npm start`に変更する必要があります。
:::
systemdを再読み込みしmisskeyサービスを有効化
@ -122,14 +126,18 @@ sudo systemctl start misskey
```
:::tip
`systemctl status misskey`と入力すると、サービスの状態を調べることができます。
:::
::::
## Misskeyのアップデート方法
:::warning
アップデートの際は必ず[リリースノート](https://github.com/misskey-dev/misskey/blob/master/CHANGELOG.md)を確認し、変更点や追加で必要になる作業の有無(ほとんどの場合ありません)を予め把握するようにしてください。
:::
masterをpullし直し、インストール、ビルド、データベースのマイグレーションを行います:
@ -152,7 +160,9 @@ sudo systemctl restart misskey
```
:::tip
ビルドや起動時にエラーが発生した場合は、以下のコマンドをお試しください:
- `pnpm run clean`または`pnpm run clean-all`
- `pnpm rebuild`
:::

View File

@ -11,11 +11,15 @@
[**シェルスクリプトの詳細と使用方法はこちらから!**](./bash/)
:::tip
シェルスクリプトでの開発環境へのインストールは想定されていません。
:::
:::tip
ドメインの購入とCloudflareのセットアップ、サーバーの確保についてはご自身でご準備ください。
:::
不具合があれば[ @aqz@p1.a9z.dev へのメンション](https://p1.a9z.dev/@aqz)にてお知らせいただければと思います。
@ -27,7 +31,9 @@
[docker-compose](./docker/)なら、手作業でももうちょっと簡単に実行できるはずです。
:::danger
一度使用を始めたサーバーのドメイン・ホスト名では、データベースを作り直さないでください!
:::
## はじめに
@ -52,7 +58,9 @@ OSの違い、Misskey本体や依存するソフトウェアのバージョン
* ここではドメインをexample.tldとして解説を進めるので、自分が買ったドメインに適宜置き換えて読むこと。開発環境の場合はlocalhostと読み替えます設定ファイルの項で別途説明
:::danger
一度使用を始めたサーバーのドメイン・ホスト名は、決して変更しないでください!
:::
## nanoの使い方
@ -78,7 +86,9 @@ sudo adduser --disabled-password --disabled-login misskey
```
:::tip
開発環境の場合はユーザーを分ける必要はありません
:::
## 基本的なソフトウェアのインストールと設定
@ -177,7 +187,9 @@ activeならOK。
nginxは、主としてリバースプロキシに用いられるWebサーバーソフトである。Misskeyには必須ではないが、キャッシュ等をするとパフォーマンスが向上したり、httpからhttpsへの転送などをするために、インストールしておこう。
:::tip
開発環境の場合はnginxのセットアップは不要です
:::
nginx.orgのドキュメント http://nginx.org/en/linux_packages.html#Ubuntu に従ってインストールする。
@ -238,7 +250,9 @@ sudo apt install -y git build-essential
サーバーをインターネットに公開する準備をする。
:::tip
開発環境の場合はファイヤーウォールやCloudFlare、Certbotの設定は不要です
:::
### ファイヤーウォール
@ -272,7 +286,9 @@ sudo systemctl enable ufw
```
:::tip
ufwは、netfilter(iptables)を人間が操作しやすいようにするアプリだ。インストールスクリプトは、OCI環境ではnetfilterを直接操作する。
:::
### CloudFlare
@ -376,7 +392,9 @@ nano .config/default.yml
設定できる値と記述方法は[.config/example.yml](https://github.com/syuilo/misskey/blob/develop/.config/example.yml)に書かれている。
:::tip
開発環境の場合、urlは`url: http://localhost:3000`と指定します。
:::
```yml
@ -469,7 +487,9 @@ NODE_ENV=production pnpm run build
```
:::tip
開発環境の場合、`NODE_ENV=production`は不要です。以降のコマンドでも同様に削除してください。
:::
### サーバーでビルドできない場合
@ -515,7 +535,9 @@ CloudFlareのDNS設定が正しいIPアドレスになっているかもう一
## Misskeyのデーモンを作成
:::tip
開発環境の場合、デーモンの作成は不要です。
:::
いったんCtrl+Cでプロセスをキルし、Misskeyをデーモンで起動する設定をしよう。

View File

@ -13,5 +13,7 @@ CDNで以下の設定を行なってください。
- `/api/*`以外のリクエストをすべてキャッシュする
:::tip
Misskeyをアップデートした際にキャッシュのクリアは不要です。
:::

View File

@ -7,7 +7,9 @@ LTLやSTLは、そのサーバー全員の投稿が見れるため、新規の
もしデメリットの方が上回っていると感じたら、それらのタイムラインを無効化することも検討してください。
:::warning
無効化を行うと、ユーザーが困惑し、短期的に見て利用者が減る可能性があります。そのため、無効化の際は影響を慎重に検討し、事前に説明してフォローを整える期間を一定程度設けることを推奨します。
:::
なお、管理者/モデレーターは、これらのタイムラインの無効化状態は適用されず、引き続き利用することが可能です。

View File

@ -7,7 +7,9 @@ MisskeyはAPIを公開しています。APIを使ってMisskeyクライアント
ストリーミングAPIもあるので、リアルタイム性のあるアプリケーションを作ることも可能です。
:::tip
Misskey公式SDKやサードパーティライブラリを使うことによって、このドキュメントで説明するいくつかの手順を簡略化できるなど、より便利にAPIを利用することができます。\
:::
<MkIndex />

View File

@ -5,7 +5,9 @@ description: 'アプリケーションが要求する権限の一覧'
# 権限の一覧
:::tip
このページは[misskey-js](https://github.com/misskey-dev/misskey/tree/develop/packages/misskey-js)から自動生成しているため、ドキュメントや翻訳が不完全な場合があります。
:::
<ApiPermissions></ApiPermissions>

View File

@ -5,7 +5,9 @@ description: 'ストリーミングAPIを使うと、リアルタイムで様々
# ストリーミングAPI
:::tip
最初に[Misskey API](../index.md)のドキュメントを読むことをお勧めします。
:::
ストリーミングAPIを使うと、リアルタイムで様々な情報(例えばタイムラインに新しい投稿が流れてきた、リアクションされた、フォローされた、など)を受け取ったり、様々な操作を行ったりすることができます。
@ -25,7 +27,9 @@ wss://{host}/streaming?i={token}
- `{token}`の部分は、ユーザーのアクセストークンに置き換えます。
:::tip
アクセストークンは省略することもできますが、その場合非ログインでの利用ということになり、受信できる情報や可能な操作は限られます。
:::
ストリームに接続すると、後述投稿の購読を行ったりすることができますが、まだこの段階では、例えばタイムラインへの新しい投稿を受信したりすることはできません。
@ -38,7 +42,9 @@ MisskeyのストリーミングAPIにはチャンネルという概念があり
ストリーム上でチャンネルに接続することで、様々な情報を受け取ったり情報を送信したりすることができるようになります。
:::tip
ひとつのストリーム接続上で、同時に複数のチャンネルに接続することができます。
:::
以下では、チャンネルの使用方法を説明します。どのようなチャンネルがあるかは、[チャンネル一覧](./channel/index.md)を参照してください。
@ -65,7 +71,9 @@ MisskeyのストリーミングAPIにはチャンネルという概念があり
- `params`はチャンネルに接続する際のパラメータです。チャンネルによって接続時に必要とされるパラメータは異なります。パラメータ不要のチャンネルに接続する際は、このプロパティは省略可能です。
:::tip
IDはチャンネルごとではなく「チャンネルの接続ごと」です。なぜなら、同じチャンネルに異なるパラメータで複数接続するケースもあるからです。
:::
### チャンネルからのメッセージを受け取る

View File

@ -7,7 +7,9 @@ APIを使い始めるには、APIを利用するアカウントに紐づいた**
アクセストークンは、ユーザーに紐づいた認証情報で、APIを利用するユーザーを識別するとともに、アクセストークンごとにどういった操作の権限を持っているかが管理されます。
:::tip
ユーザーとそのユーザーに紐づいたアクセストークンは一対多の関係であり、あるユーザーに対して複数のアクセストークンが発行され得ます。
:::
あなた自分自身のアクセストークンは簡単に取得できるほか、あなたのアプリケーションを使用することになる不特定のユーザーのアクセストークンを取得することもできます。
@ -19,7 +21,9 @@ APIを使い始めるには、APIを利用するアカウントに紐づいた**
Misskey Webの「設定 > API」で、自分のアクセストークンを発行できます。
:::danger
アクセストークンは他人に知られないようにしてください。
:::
### アプリケーション利用者にアクセストークンの発行をリクエストする
@ -36,7 +40,9 @@ Misskey Webの「設定 > API」で、自分のアクセストークンを発行
UUIDを生成する。以後これを**セッションID**と呼びます。
:::danger
このセッションIDは毎回生成し、使いまわさないようにしてください。
:::
#### Step 2
@ -60,9 +66,11 @@ https://{host}/miauth/{session}
| `permission` | アプリケーションが要求する権限。<br>要求する権限を`,`で区切って列挙します。権限の一覧は[こちら](./permission.md)で確認できます。 |
:::tip{label='例'}
```
https://misskey.io/miauth/c1f6d42b-468b-4fd2-8274-e58abdedef6f?name=MyApp&callback=https%3A%2F%2Fmyapp.example.com%2Fcallback&permission=write:notes,write:following,read:drive
```
:::
#### Step 3
@ -108,7 +116,9 @@ https://{host}/api/miauth/{session}/check
APIの詳細は、APIリファレンスを参照してください。
:::warning
MisskeyはRESTを採用していません。
:::
また、MisskeyはHTTP APIだけでなく、ストリーミングAPIも提供しています。ストリーミングAPIの詳細は[こちらのドキュメント](./streaming/index.md)を参照してください。