README_JA.md

Twitter ActivityPub Bridge

TwitterのユーザーやツイートをActivityPub形式に変換するソフトウェア

English | Japanese (日本語)

機能

Fediverse(*)からTwitterユーザーをフォロー

まだTwitterからMastodonなどのFediverseに移行してきていないユーザーをフォローすることができます。
フォローすることで、Twitter側でのつぶやきをToot(Note)としてMastodonなどから閲覧することができます。

(*) Fediverse (ActivityPub対応ソフトウェア): Mastodon, Misskey, Pixelfedなど

注意

このソフトウェアはあくまでFediverseに移行してきていない(or移行出来なさそうな)ユーザーを一時的にフォローするためのものです。
具体的な利用方法としては、ソシャゲやアニメ等の(企業系)公式アカウントをフォローすることを想定しています。
FediverseとTwitterでは文化が全く異なりますし、このソフトウェアでFediverseをTwitterのようなものにする意図はありません。
(わざわざFediverseに来てまでTwitterの一般ユーザーばかりフォローするのであれば、FediverseではなくTwitterを利用すべきです。)

使い方

1. 任意のインスタンスからフォローしたいユーザーを次の形式で検索します: @<UserID>@<Domain>
   たとえば twttr.yukineko.me がホストしているTwitter ActivityPub Bridgeのインスタンスから Twitterの公式アカウント (@twitter) をフォローしたい場合は @[email protected] になります。
2. すると対象のユーザーのプロフィールが表示されるので、フォローボタンを押して承認されればフォロー完了です。

セットアップ

Note
Twitter ActivityPub Bridgeでは、以下のソフトウェアがインストール及び設定されている必要があります。

• Node.js (v18.12.1以降)
• yarn (v1.x.x)
• Redis
• MongoDB

1. リポジトリをクローンする

$ git clone https://github.com/hideki0403/twitter-activitypub-bridge.git
$ cd twitter-activitypub-bridge

2. ライブラリをインストールする

$ yarn install

3. 設定を編集する

ディレクトリのルートにある config.example.yml を config.yml としてコピーし、設定ファイル内にあるコメントに従って編集します。

4. ビルドする

$ yarn build

5. 起動する

ビルドが終わったら以下のコマンドで起動できます。

$ yarn start

任意のインスタンスから @twitter@<domain> で検索し、Twitterの公式アカウントが表示できれば問題なくセットアップ出来ています。