firefish/README.md

Misskey のフォークの Firefish のフォークです。

本家 Firefish のリポジトリはこちら

main ブランチではこのフォークに適用された変更のコミット履歴のみが、history ブランチでは本家 Firefish のコミットを含む完全なコミット履歴が閲覧できます。

このフォークの機能について調べるには main ブランチを、コードの著者について調べるには history ブランチを参照してください。

変更点

主要な変更点

• 非ログインユーザーにもローカルタイムラインとグローバルタイムラインを公開できるように変更
  • コントロールパネルから設定すると https://server.example.com/timeline で公開されます
• 検索フィルターを強化中
  • from:me を検索クエリの末尾につけると自分の投稿のみを検索できるように変更
    • 検索クエリの例: 予定 from:me
    • ホーム・フォロワー限定・ダイレクト・秘密の投稿を含む自分の全ての投稿から検索します
• 全文検索のエンジンを PGroonga に変更
  • PGroonga のインストールが必要になります！詳しくはこの投稿をご覧ください
  • Meilisearch, Elasticsearch, Sonic は使えません
• 「秘密」という公開範囲を追加
  • 宛先無しのダイレクト投稿を言い換えているだけです
  • 既存の投稿を削除せずに後から秘密にすることもできます
• パフォーマンス向上のためアクティブユーザー以外のチャート生成を無効化
  • サードパーティー製クライアントが動かなくなるのを阻止するため API のエンドポイントは残していますが、叩いても 0 が並んだ配列しか返しません。
• モデレーターでない一般ユーザーにもカスタム絵文字の管理権を与えられるように
  • カスタム絵文字の管理が大変なサーバー管理者さんがたくさんいらっしゃったのでこの機能を追加するべきではないか他の開発者に訊いたところロール機能の実装を待つべきだと言われてしまったが、Firefish のロール機能は現状では仕様がまだ固まっておらず実装までに時間が掛かると考えられるため
  • 以下の権限を与えられます
    • 不許可: 絵文字の管理を許可しない
    • 追加: 新しい絵文字の追加のみを許可する
    • 追加と変更: 「追加」に加え、既存のカスタム絵文字の名前・カテゴリ・タグ・ライセンスの編集を許可する
    • 全て許可:「追加と変更」に加え、既存のカスタム絵文字の削除を許可する
• モバイル表示の下部のウィジェットボタンを再読み込みボタンに変更可能に
  • スマートフォンでウィジェットは使わないけど再読み込みはたくさんする人はいそう
• モバイル表示の下部のチャットボタンをアカウント切り替えボタンに変更可能に
  • これ無しで PWA で複数アカウントを使おうとすると腱鞘炎になる
• ローカルタイムラインの位置をグローバルタイムラインの直前に移動
  • ローカルタイムラインよりもソーシャルタイムラインのほうが使いやすいと考えたため

細かい変更点

• 署名アルゴリズムとして ECDSA や Ed25519 なども受け入れる（github.com/mei23/misskey-v12 から取り込み）
• Pleroma のチャットに対応（Catodon から取り込み）
• 翻訳機能にて、投稿言語が指定されていない場合にのみ言語の自動検出を用いるように変更
• アップデート時に更新内容を確認できる機能を追加
• 依存ライブラリを最新版にアップデート
  • ちゃんと動くか本家に push する前に実験したいという意図もあります
• 中国語の猫モードでは 0.1 の確率で投稿の末尾に「喵」を追加するように
• 設定のバックアップファイルに misskeyVersion の値が含まれていなくても警告しないように変更
• マージされていない本家版へのプルリクエストを独断でマージ
  • RTL Layout Support (!10452)
  • Add language picker to post form (!10616)
  • chore: up swc (!10649)
• emojis の API エンドポイント（Misskey v13- 互換）を追加（firefish-mkdir から取り込み）
• Docker のベースイメージに Node v21 を使用
• HTML のコードに入るコメントアートを削除
  • 全ページにこんなの入れなくても……
• デフォルトではバイブレーションを無効に
• ログインしていなければ投稿検索ができないように
  • 攻撃対策のため
  • もしこのせいでサードパーティークライアントに不具合が出る場合には変更するかもしれません
• 投稿と投稿の間を空けて表示する設定をデフォルトでは無効に
• Enter キーのみでチャットを送信する設定をデフォルトでは無効に
• 管理者アカウントも引っ越しできるように
• デフォルトのアイコンの太さを細めに変更
• スタイルを選択する画面のサンプルのアイコンを星に変更
• リアクションの履歴を公開する設定をデフォルトで有効に
  • 私がみんなのリアクションを見たいと思っているため
  • もちろん設定から無効にできます
• 標準のフォントを Atkinson Hyperlegible にする変更を取り消し
  • フォントを変更したい場合はこのカスタム CSS を使ってください
• 簡体中文の翻訳が存在しない項目では繁体中文の翻訳を用いるように（本家では逆）
  • サポミクさんが独自機能に使われているラベルの繁体中文訳を提供してくださったため
• オンラインステータスが非公開のアカウントにはステータスを表す丸印を表示しないように
  • 灰色の丸が表示されていてもそんなに嬉しくないため
• デフォルトで検索エンジンからのクロールを拒否するように変更
• 検索の MFM で使用する検索エンジンを設定から変更可能に
  • 以下の選択肢から選べます
    • DuckDuckGo (duckduckgo.com)
    • SearXNG (searx.be)
    • Google Search (google.com)
    • Moon Search (search.naskya.net)
    • サーバーの投稿検索
• サーバー設定の初期値を変更
  • 新規登録を無効化
    • 新規登録を受け付けたくないのに無効化する前にアカウントを登録されてしまうことを防ぐため
  • プライベートモード（連合しないモード）を有効化
    • サーバーの準備が整っていないうちにリモートサーバーに認識されてしまうことを防ぐため
  • サーバーメトリクスの表示を有効化
    • 有効化しているサーバーが多いため
  • ランダムなアイコンの生成を無効化
    • ランダムなアイコンはそんなにかわいくないため
• 身バレ防止の設定を追加
  • 「おかえりなさい、◯◯さん」が出ないようにできるように
  • 自分のアイコンを非表示にできるように
  • 自分の名前とIDを非表示にできるように
    • 名前とIDの部分が空白になるので慣れるまで時間が掛かります
• ユーザーページのデフォルトのタブを「投稿と返信」に変更
• タイムラインにリプライを表示する設定をデフォルトで有効に
• 未読通知のタブをリアクションの通知を表示するタブに変更
  • 未読のタブ、使ってる人いる？
• MFM チートシートのボタンを投稿画面から左下のヘルプメニューに移動
  • これがあるために投稿画面下部のボタンが 2 段になってしまうことがあるため
• 「フォローされています」の表示を目立たせられるように
  • デフォルトの表示は目立たないため
• 最大 15 件の投稿を固定できるように
  • 5 件は少ないと思ったため
• 投稿ボタンを巨大にできるように
  • mstdn.maud.io / mstdn.poyo.me の機能 を真似しました
• アンテナにフォロー中のユーザーのホーム投稿も表示する
  • フォロー中のユーザーの投稿は見たいから
• 猫のアカウントはアイコンを常に丸く表示する
  • そのほうがかわいいため
• NSFW メディアを隠す設定をブラウザごとの設定からブラウザごとかつアカウントごとの設定に変更
  • 「このアカウントでは NSFW の画像を常に表示したい」みたいな需要が私にあったため
• インスタンスティッカーをデフォルトで常に表示する
  • そのほうが楽しいと思ったから
• 藍ちゃんウィジェットの復活
• インスタンスティッカーのツールチップにソフトウェアのバージョン番号も表示する
  • 気になるから
• いいねボタン（リアクションピッカーの左にある、⭐とか👍のリアクションをワンクリックで押せるやつ）で空のリアクション（Mastodon がふぁぼで送ってくるものと同じ）ではなく本当にその絵文字リアクション（⭐とか👍とか）を送るようにする
  • 最新の Misskey ではデフォルトリアクションが❤️になったため空のリアクションを送ると❤️として表示されてしまうが、❤️は ℒℴ𝓋ℯ... という気持ちを伝えるためのリアクションであってただの「いいね」とは異なるため、このボタンで❤️は送りたくないから
• 通知の表示を簡潔にする
  • 「がリアクションしました」とかリプライの上にある白い線とかが邪魔に思えたため
  • 一部の表示の色も Misskey の通知の色が個人的に好みだったので戻した
• 支援者リストをファイルから読み込む
  • 外部のサーバーが落ちるとユーザーページが開けなくなることを防ぐため
• 閲覧注意の注釈と画像の代替テキストもアンテナで調べる対象にする
  • 「そぎぎ」でアンテナを作れる
• インデックス拒否に noindex に加えて nofollow,noarchive,nocache,noimageindex も指定
• インスタンスティッカーに表示するサーバーのアイコンとして favicon を優先する
  • favicon のほうがよくカスタマイズされているため
• 誤爆しやすい位置にあるフォローボタンを隠す設定を追加
  • フォローを誤爆すると悲しいため
• デフォルトの robots.txt の設定を変更し、クローラーを拒否するように
  • joinfirefish と FediDB のクローラーは許可しています
• 投稿プレビューをデフォルトでオンにする設定を追加
• バージョン番号に最新のコミットの日付とコミットハッシュの頭文字が含まれるように
  • 正確なバージョンが分かるとバグ修正に役立つため

検証中の変更点

うまく動いていそうだったら本家に push されます

• Docker/Podman の環境で custom ディレクトリの内容が反映されない不具合を修正
• 画面を下に引いてタイムラインなどを更新する機能を追加（Misskey から取り込み）
  • 本家にもマージリクエストを出しました (!10644)

このフォークから本家 Firefish に輸出された変更点

このフォークは本家に push する前のテスト環境としても使われるため、有用な機能はよく輸出されます（そしてニッチな機能だけが残る）

• iOS で効果音と音楽の再生が干渉する問題を修正（Misskey から取り込み）
• サーバーの管理者が左下のヘルプメニューに利用規約以外のページも固定できるように
• 依存ライブラリのバージョンをアップデート
  • AiScript のバージョンも上がりました！
• 絵文字ピッカーに表示されるカスタム絵文字の検索結果の件数を最大 100 件に変更（Misskey の変更を取り込み）
• 投稿中に表示されるインスタンスティッカーをクリックするとサーバー情報を開くように
• UI 用の言語とは別に、投稿翻訳に使用する言語を設定可能に
  • UI 用の言語は翻訳先の言語の第二候補として使われます（投稿の言語と投稿翻訳先に設定した言語が同じだった場合には UI 用の言語に翻訳されます）
• 投稿言語を自動検出して外国語の投稿に翻訳ボタンを表示する設定を追加
• 繁体中文への投稿翻訳を繁体字で表示する
  • DeepL 翻訳や LibreTranslate は簡体中文への翻訳しか提供していない……。
• 「Firefish について」のページに Misskey の主要な貢献者を表示
  • このソフトウェアは Misskey のフォークであるため
• 閲覧注意の投稿への返信で注釈の先頭に "re:" をつける設定を追加
  • 返信で閲覧注意は維持したいけどそのままの注釈を用いるのには違和感を覚えることがよくあるため
• 猫耳の角を少し丸くする（Misskey から取り込み）
  • そのほうがかわいいため
• インスタンスティッカーのツールチップに出るソフトウェア名で FoundKey, PeerTube, GNU social, WriteFreely などを正しく表示する

使用方法

インストール

以下の方法でインストールできます。

• systemd 版（手動インストールのみ）
• Debian package 版
• Docker 版

更新が最も早く反映されるのは systemd 版の手動インストールです。Docker イメージや Debian/Ubuntu 向けの deb ファイルの更新も定期的に行うようにしますが、Vervis にはそのようなことを自動で行う仕組みが無いのでちょっとつらいです。

自動でインストールする

Ubuntu 向けのインストールスクリプト があります。

手動でインストールする

基本的に本家版のインストールと同じ手順で行えますが、PGroonga のインストールが必要である点が異なります。

Docker 版

このリポジトリをクローンして docker-compose.example.yml を docker-compose.yml にコピーし、本家版と同様にサーバーを構築すればよいですが、そのまま起動するとデータベースのマイグレーションに失敗します。最初にデータベースのコンテナのみを起動させて以下のコマンドで PGroonga を有効にしてください（firefish と firefish_db はそれぞれ .config/docker.env や .config/default.yml に書いた PostgreSQL のユーザー名とデータベース名にしてください）。

# DNS・ファイヤーウォール・リバースプロキシなどを各自で設定する

git clone https://code.naskya.net/naskya/firefish
cd firefish
cp docker-compose.example.yml docker-compose.yml
cp .config/example.yml .config/default.yml

# docker-compose.yml, .config/default.yml, .config/docker.env を編集する

docker-compose up db --detach
docker-compose exec db psql --command='CREATE EXTENSION pgroonga;' --user=firefish --dbname=firefish_db

./update.sh --install

systemd 版

このリポジトリをクローンして、本家版と同様にサーバーを構築します。ビルド等の作業 (pnpm install, pnpm run build, pnpm run migrate) は添付のアップデートスクリプトによって一括で行えます。

# DNS・ファイヤーウォール・リバースプロキシ・PostgreSQL・Redis などを各自でインストールして設定する

git clone https://code.naskya.net/naskya/firefish
cd firefish
cp .config/example.yml .config/default.yml

# .config/default.yml を編集する

sudo -u postgres psql --command "CREATE EXTENSION pgroonga;" --dbname firefish_db

./update.sh --install

インストール方法に関する私の記事も参考になるかもしれません。

アップデート

Docker 版（手動インストール・自動インストール）

重要なお知らせがある場合にはアップデートスクリプトを通じてお伝えするので、必ず update.sh を用いてアップデートしてください。

1. サーバーのバックアップを取る

2. update.sh を実行し、表示される指示に従う

   ./update.sh
   

3. サーバーを起動して動作を確認する

   docker-compose up --detach
   

systemd 版（手動インストール）

重要なお知らせがある場合にはアップデートスクリプトを通じてお伝えするので、必ず update.sh を用いてアップデートしてください。

1. サーバーのバックアップを取る

2. サーバーを停止する

   sudo systemctl stop yourserver.example.com
   

3. update.sh を実行し、表示される指示に従う

   ./update.sh
   

4. サーバーを起動して動作を確認する

   sudo systemctl start yourserver.example.com
   

Debian package 版（自動インストール）

apt を利用してアップデートします。

1. サーバーのバックアップを取る

2. パッケージをアップデートして動作を確認する

   sudo apt update
   sudo apt upgrade
   

正常にアップデートできなかった場合

私が対処する必要がある問題が発生している可能性もあるため、一人で解決しようとせずに ./update.sh の実行ログを私まで送ってください。

本家 Firefish からの乗り換え

systemd 版

1. サーバーのバックアップを取る

2. サーバーを停止する

   sudo systemctl stop yourserver.example.com
   

3. Firefish がインストールされているディレクトリ (e.g., /home/calckey/calckey) の親ディレクトリ (e.g., /home/calckey) に移動する

   cd /home/calckey
   

4. Firefish がインストールされているディレクトリ (e.g., ./calckey) の名前を変える

   mv calckey calckey.old
   

5. 元々 Firefish がインストールされていたディレクトリ (e.g., ./calckey) と同じ名前でこのリポジトリをクローンする

   git clone https://code.naskya.net/naskya/firefish calckey
   

6. 必要なファイルを元のディレクトリからコピーする

   rm -rf calckey/files calckey/custom calckey/.config
   cp -r calckey.old/files calckey
   cp -r calckey.old/custom calckey
   cp -r calckey.old/.config calckey
   

7. 全文検索エンジン（Meilisearch, Sonic, Elasticsearch のいずれか）を使用している場合には、.config/default.yml からその設定を削除またはコメントアウトする

   先頭に # をつけると設定をコメントアウトできます。

   #sonic:
   #  host: localhost
   #  port: 1491
   #  auth: SecretPassword
   #  collection: notes
   #  bucket: default
   

   全文検索エンジンは停止またはアンインストールしてしまってよいです。本家の Firefish に戻るつもりがあるなら停止を、そうでなければアンインストールをおすすめします。

   停止コマンドの例

   sudo systemctl disable --now sonic
   

8. PostgreSQL のバージョンを確認する

   psql --version
   

9. PGroonga をインストールする

   コマンドの例（詳しくはこの投稿を参考にしてください）

   sudo apt install -y software-properties-common
   sudo add-apt-repository -y universe
   sudo add-apt-repository -y ppa:groonga/ppa
   sudo apt install -y wget lsb-release
   wget https://packages.groonga.org/ubuntu/groonga-apt-source-latest-$(lsb_release --codename --short).deb
   sudo apt install -y -V ./groonga-apt-source-latest-$(lsb_release --codename --short).deb
   echo "deb http://apt.postgresql.org/pub/repos/apt/ $(lsb_release --codename --short)-pgdg main" | sudo tee /etc/apt/sources.list.d/pgdg.list
   wget --quiet -O - https://www.postgresql.org/media/keys/ACCC4CF8.asc | sudo apt-key add -
   sudo apt update
   sudo apt install -y -V postgresql-14-pgdg-pgroonga
   

10. .config/default.yml に書かれているデータベースの名前を確認する（以下の例では mk1）

    db:
      host: localhost
      port: 5432
      db: mk1  # <---
    

11. 以下のコマンドを実行して PGroonga の拡張機能を有効にする（mk1 の部分は自分のデータベース名に変えて実行）

    sudo -iu postgres psql --command="CREATE EXTENSION pgroonga;" --dbname=mk1
    

12. 新しい Firefish のディレクトリに入ってビルドする

    cd calckey
    ./update.sh --install
    

13. サーバーを起動して動作を確認する

    sudo systemctl start yourserver.example.com
    

14. 元々 Firefish がインストールされていたディレクトリを削除する

    cd ..
    rm -rf calckey.old
    

Docker 版

1. サーバーのバックアップを取る

2. サーバーを停止する

   docker-compose down
   

3. Firefish がインストールされているディレクトリ (e.g., /home/calckey/calckey) の親ディレクトリ (e.g., /home/calckey) に移動する

   cd /home/calckey
   

4. Firefish がインストールされているディレクトリ (e.g., ./calckey) の名前を変える

   mv calckey calckey.old
   

5. 元々 Firefish がインストールされていたディレクトリ (e.g., ./calckey) と同じ名前でこのリポジトリをクローンする

   git clone https://code.naskya.net/naskya/firefish calckey
   

6. 必要なファイルを元のディレクトリからコピーする

   rm -rf calckey/files calckey/custom calckey/.config
   cp -r calckey.old/files calckey
   cp -r calckey.old/custom calckey
   cp -r calckey.old/.config calckey
   

7. 以下のコマンドを実行して PGroonga を有効にする（firefish と firefish_db はそれぞれ .config/docker.env や .config/default.yml に書いた PostgreSQL のユーザー名とデータベース名にしてください）

   docker-compose up db --detach
   docker-compose exec db psql --command='CREATE EXTENSION pgroonga;' --user=firefish --dbname=firefish_db
   

8. サーバーを起動して動作を確認する

   docker-compose up --detach
   

9. 元々 Firefish がインストールされていたディレクトリを削除する

   cd ..
   rm -rf calckey.old
   

このフォークから本家 Firefish へ戻る

systemd 版

1. サーバーのバックアップを取る

2. サーバーを停止する

   sudo systemctl stop yourserver.example.com
   

3. Firefish がインストールされているディレクトリ (e.g., /home/calckey/calckey) へ移動する

   cd /home/calckey/calckey
   

4. 最新版にアップデートする

   ./update.sh
   

5. .config/default.yml に書かれているデータベースの名前を確認する（以下の例では mk1）

   db:
     host: localhost
     port: 5432
     db: mk1  # <---
   

6. 次のコマンドでデータベースをいじる前に、そのコマンドが正常に動作するか確認する（mk1 の部分は自分のデータベース名に変更する）

   printf 'BEGIN;\n%s\nROLLBACK;' "$(cat neko/revert.sql)" | sudo -iu postgres psql --set='ON_ERROR_STOP=1' --dbname=mk1
   

   最後の行が ROLLBACK で終わっていれば問題ありません。そうでない場合には以下のコマンドの実行結果を私に送ってください。

   printf 'BEGIN;\n%s\nROLLBACK;' "$(cat neko/revert.sql)" | sudo -iu postgres psql --echo-all --set='ON_ERROR_STOP=1' --dbname=mk1
   

7. このフォークで加えられたデータベースへの変更を実際に取り消す（mk1 の部分は自分のデータベース名に変更する）

   sudo -iu postgres psql --file=neko/revert.sql --dbname=mk1
   

8. PGroonga をアンインストールする

   コマンドの例

   sudo apt purge --remove postgresql-14-pgdg-pgroonga
   sudo add-apt-repository --remove ppa:groonga/ppa
   sudo apt-key del ACCC4CF8
   sudo apt update
   

9. Firefish がインストールされているディレクトリの親ディレクトリ (e.g., /home/calckey) に行く

   cd ..
   

10. Firefish がインストールされているディレクトリ (e.g., ./calckey) の名前を変える

    mv calckey calckey.old
    

11. Firefish がインストールされているディレクトリと同じ名前で本家版の Firefish を clone する

    git clone https://git.joinfirefish.org/firefish/firefish.git calckey
    

12. 必要なファイルをコピーする

    rm -rf calckey/files calckey/custom calckey/.config
    cp -r calckey.old/files calckey
    cp -r calckey.old/custom calckey
    cp -r calckey.old/.config calckey
    

13. 新しい Firefish のディレクトリ (e.g., ./calckey) に入り、develop ブランチに行く（実際には既に develop にいるはず）

    cd calckey
    git checkout develop
    

14. Firefish をビルドする

    corepack prepare pnpm@latest --activate
    pnpm i
    NODE_ENV=production pnpm run build
    pnpm run migrate
    

15. サーバーを起動して動作を確認する

    sudo systemctl start yourserver.example.com
    

16. 元々 Firefish がインストールされていたディレクトリを削除する

    cd ..
    rm -rf calckey.old
    

注意

この手順を踏むとあなたの Firefish サーバーは develop 版になります。他のバージョンを動かしたい場合も、次のアップデートがリリースされるまでは develop 版を動かしてください。

例えば beta 版を動かしたい場合、次に beta 版がリリースされたらそちらに移れます。

git checkout beta
git pull --ff
corepack prepare pnpm@latest --activate
pnpm i
NODE_ENV=production pnpm run build
pnpm run migrate

補足

私にコマンドの実行ログを送る

実行したいコマンドの後ろに |& tee /tmp/fflog をつけてコマンドを実行します。例えば実行したいコマンドが ./update.sh ならば

./update.sh |& tee /tmp/fflog

とし、実行したいコマンドが

printf 'BEGIN;\n%s\nROLLBACK;' "$(cat neko/revert.sql)" | sudo -iu postgres psql --echo-all --set='ON_ERROR_STOP=1' --dbname=mk1

ならば

printf 'BEGIN;\n%s\nROLLBACK;' "$(cat neko/revert.sql)" | sudo -iu postgres psql --echo-all --set='ON_ERROR_STOP=1' --dbname=mk1 |& tee /tmp/fflog

とします。

するとコマンドの実行ログが /tmp/fflog に保存されるので、保存されたテキスト全体をサーバーの OS などの環境の情報とともに私に送ってください。

ログのうちの参考になりそうだと思った一部だけを抜粋して送ることは絶対にしないでください。必要な情報が欠落していてもう一度全体を送り直してもらうことになったり、私が対処方法の判断を誤ったりする可能性が高まったりします。

テキストが一つの投稿に収まる長さの場合はコードブロックの記法（``` で囲む）を用いて投稿してもらってよいです。ログが一投稿に収まらない長さの場合は Pastebin などのサービスを使って共有してください。投稿にログファイルを直接添付して送ることはしないでください。

ログを私に送ったら /tmp/fflog は削除してよいです。

rm /tmp/fflog