update docs (#157)

* update compose_example.yml

* update README

* update docs

* update docs

* update docs

---------

Co-authored-by: Esurio <[email protected]>

README.ja.md

@@ -0,0 +1,61 @@
+<div align="center">
+<a href="https://misskey-hub.net">
+	<img src="./assets/title_float_cherrypick.svg" alt="CherryPick logo" style="border-radius:50%" width="300"/>
+</a>
+
+**🌎 **CherryPick** is an open source, federated social media platform that's free forever! 🚀**
+
+[Learn more](https://misskey-hub.net/)
+
+---
+[EN](./README.md) JP
+
+---
+
+<a href="https://misskey-hub.net/servers/">
+		<img src="https://custom-icon-badges.herokuapp.com/badge/find_an-instance-acea31?logoColor=acea31&style=for-the-badge&logo=misskey&labelColor=363B40" alt="find an instance"/></a>
+
+<a href="https://misskey-hub.net/docs/for-admin/install/guides/">
+		<img src="https://custom-icon-badges.herokuapp.com/badge/create_an-instance-FBD53C?logoColor=FBD53C&style=for-the-badge&logo=server&labelColor=363B40" alt="create an instance"/></a>
+
+<a href="./CONTRIBUTING.md">
+		<img src="https://custom-icon-badges.herokuapp.com/badge/become_a-contributor-A371F7?logoColor=A371F7&style=for-the-badge&logo=git-merge&labelColor=363B40" alt="become a contributor"/></a>
+
+<a href="https://discord.gg/V8qghB28Aj">
+		<img src="https://custom-icon-badges.herokuapp.com/badge/join_the-community-5865F2?logoColor=5865F2&style=for-the-badge&logo=discord&labelColor=363B40" alt="join the community"/></a>
+
+<a href="https://www.patreon.com/noridev">
+		<img src="https://custom-icon-badges.herokuapp.com/badge/become_a-patron-F96854?logoColor=F96854&style=for-the-badge&logo=patreon&labelColor=363B40" alt="become a patron"/></a>
+
+</div>
+
+---
+## About
+このリポジトリは、[CherryPick](https://github.com/kokonect-link/cherrypick.git)のフォークソフトウェアです。  
+Firefish、Sharkey、Foundkeyなどの影響を受けた改造をしています。  
+フォーク元との差異については[こちら](./docs/WhatsDifference.md)をご覧ください。  
+インストール方法などの詳細は[docs](./docs/docs.md)をご覧ください。
+
+---
+
+## Thanks
+
+<a href="https://sentry.io/"><img src="https://github.com/kokonect-link/cherrypick/assets/4439005/98576556-222f-467a-94be-e98dbda1d852" height="30" alt="Sentry" /></a>
+
+Thanks to [Sentry](https://sentry.io/) for providing the error tracking platform that helps us catch unexpected errors.
+
+<a href="https://www.chromatic.com/"><img src="https://user-images.githubusercontent.com/321738/84662277-e3db4f80-af1b-11ea-88f5-91d67a5e59f6.png" height="30" alt="Chromatic" /></a>
+
+Thanks to [Chromatic](https://www.chromatic.com/) for providing the visual testing platform that helps us review UI changes and catch visual regressions.
+
+<a href="https://about.codecov.io/for/open-source/"><img src="https://about.codecov.io/wp-content/themes/codecov/assets/brand/sentry-cobranding/logos/codecov-by-sentry-logo.svg" height="30" alt="Codecov" /></a>
+
+Thanks to [Codecov](https://about.codecov.io/for/open-source/) for providing the code coverage platform that helps us improve our test coverage.
+
+<a href="https://crowdin.com/"><img src="https://user-images.githubusercontent.com/20679825/230709597-1299a011-171a-4294-a91e-355a9b37c672.svg" height="30" alt="Crowdin" /></a>
+
+Thanks to [Crowdin](https://crowdin.com/) for providing the localization platform that helps us translate CherryPick into many languages.
+
+<a href="https://hub.docker.com/"><img src="https://user-images.githubusercontent.com/20679825/230148221-f8e73a32-a49b-47c3-9029-9a15c3824f92.png" height="30" alt="Docker" /></a>
+
+Thanks to [Docker](https://hub.docker.com/) for providing the container platform that helps us run CherryPick in production.

README.md

@@ -7,6 +7,9 @@
 
 [Learn more](https://misskey-hub.net/)
 
+---
+EN [JP](./README.ja.md)
+
 ---
 
 <a href="https://misskey-hub.net/servers/">
@@ -26,6 +29,15 @@
 
 </div>
 
+---
+## About
+This repository is a fork of [CherryPick](htttps://github.com/kokonect-link/cherrypick.git).  
+Added some modding inspired by Firefish, Sharkey, Foundkey and more.  
+For the difference from original, see [What's Difference](./docs/WhatsDifference.md).  
+For more information, please read [docs](./docs/docs.md).
+
+---
+
 ## Thanks
 
 <a href="https://sentry.io/"><img src="https://github.com/kokonect-link/cherrypick/assets/4439005/98576556-222f-467a-94be-e98dbda1d852" height="30" alt="Sentry" /></a>

compose_example.yml

@@ -79,42 +79,6 @@ services:
 #      interval: 5s
 #      retries: 20
 
-# opensearchとopensearch-dashboardsのdockerfileは実装時の最新版の辞書なので適宜書き換えてください
-#  opensearch:
-#    build: ./opensearch
-#    environment:
-#      - "server.ssl.enabled:false"
-#      - "discovery.type=single-node"
-#      - "OPENSEARCH_INITIAL_ADMIN_PASSWORD=opensearch-adminpassword" #強めのパスワードじゃないと怒られる
-#      - "plugins.security.disabled=true"
-#    ulimits:
-#      memlock:
-#        soft: -1 # Set memlock to unlimited (no soft or hard limit)
-#        hard: -1
-#      nofile:
-#        soft: 65536 # Maximum number of open files for the opensearch user - set to at least 65536
-#        hard: 65536
-#    volumes:
-#      - ./os-data:/usr/share/opensearch/data
-#    networks:
-#      - internal_network
-#      - external_network
-
-#OpenSearchのダッシュボードを見る場合に必要
-#  opensearch-dashboards:
-#    build: ./opensearch-dashboards
-#    ports:
-#      - 5601:5601
-#    links:
-#      - opensearch
-#    expose:
-#      - '5601'
-#    environment:
-#      OPENSEARCH_HOSTS: 'http://opensearch:9200'
-#    networks:
-#      - internal_network
-#      - external_network
-
 #  meilisearch:
 #    restart: always
 #    image: getmeili/meilisearch:v1.3.4
@@ -128,6 +92,15 @@ services:
 #    volumes:
 #      - ./meili_data:/meili_data
 
+#  tunnel:
+#    image: cloudflare/cloudflared:latest
+#    command:
+#      - tunnel
+#      - --no-autoupdate
+#      - run
+#    environment:
+#      - TUNNEL_TOKEN=YOUR_TOKEN_HERE
+
 networks:
   internal_network:
     internal: true

docs/WhatsDifference.md

@@ -0,0 +1,3 @@
+# Difference from kokonect/CherryPick
+EN: WIP
+JP: [Here](./jp/Difference.md)

docs/docs.md

@@ -0,0 +1 @@
+WIP

docs/jp/Difference.md

@@ -0,0 +1,64 @@
+# フォーク元との差異
+- [フォーク元との差異](#フォーク元との差異)
+	- [追加された機能](#追加された機能)
+		- [フロントエンド](#フロントエンド)
+		- [バックエンド](#バックエンド)
+		- [管理者向け](#管理者向け)
+		- [その他](#その他)
+	- [削除された機能](#削除された機能)
+	- [変更された機能](#変更された機能)
+		- [フロントエンド](#フロントエンド-1)
+		- [バックエンド](#バックエンド-1)
+
+最新の変更については、[CHANGELOG_engawa](../../CHANGELOG_engawa.md)をご覧ください。
+
+---
+
+## 追加された機能
+### フロントエンド
+- サイコロウィジェット
+- 検索ウィジェット
+- より多くのテーマ(Migrated from Catppuccin)
+- メディアタイムライン
+- 投稿フォームでファイルにAltテキストが存在する場合にインジケータを表示する機能
+- ユーザー、ノート、ギャラリー、ページをQRコードで共有する機能
+- Botの投稿をタイムラインから除外するオプション
+- ファイルにALTテキストがない場合に警告を出すオプション
+
+### バックエンド
+- kmyblueのisIndexableプロパティの連合に対応
+- 自分しか見られない公開範囲「プライベート」の追加
+
+### 管理者向け
+- `url/about`にステータスページ(Betterstack、uptimerobotなど)を追加できるように
+- ユーザーがセンシティブかどうか指定できるように
+- カスタムスプラッシュスクリーンテキスト
+
+### その他
+- ノートの自動削除
+
+## 削除された機能
+- リバーシ
+- ノート検索におけるMeilisearchの対応
+
+## 変更された機能
+### フロントエンド
+- 一部の日本語ロケールの修正
+- オフラインスクリーンのデザイン
+- ダークモードを切り替えるショートカットキーをCtrl+d(Windows・Linux)/^+d(Mac)に
+- 画像をクロップする際モバイル端末からだと表示が壊れている問題を修正
+- より大きい画像を隠すボタン
+- Misskey UI/デッキUIのナビゲーションバーのスタイル
+- 画像がAPNGの場合GIFではなくAPNGと表示するように
+- 画像にALTテキストが存在する場合ファイル名とALTテキストを同時に表示するように
+
+### バックエンド
+- ノートの最大文字数が5120文字に
+- アイコンデコレーションの最大数が128個に
+- 管理者アカウントも他サーバーに移行できるように
+- パスワードのハッシュ関数をbcryptからArgon2idに
+- ギャラリーに載せられる画像を128個に
+- SQLエスケープが不完全な問題を修正
+- URLスキーマのチェックが不完全な問題を修正
+- ブロックをした際に同時にミュートするように
+- ワードミュートの制限から文字数から個数に

docs/jp/docs.md

@@ -0,0 +1,4 @@
+# CherryPick縁側フォークドキュメント
+このドキュメントはCherryPick縁側フォークのドキュメントです。
+
+WIP

docs/jp/installation/docker.md

@@ -0,0 +1,62 @@
+# Docker Composeを使用したインストール
+Docker Composeを使用したインストール方法について説明します。  
+OSはUbuntuを想定しています。適宜読み替えてください。  
+
+- [Docker Composeを使用したインストール](#docker-composeを使用したインストール)
+	- [Docker Composeのインストール](#docker-composeのインストール)
+	- [リポジトリの取得](#リポジトリの取得)
+	- [設定](#設定)
+		- [設定ファイルのコピー](#設定ファイルのコピー)
+		- [設定ファイルの編集](#設定ファイルの編集)
+	- [起動](#起動)
+		- [ビルド](#ビルド)
+		- [起動](#起動-1)
+	- [Cloudflare Tunnelを使用する場合](#cloudflare-tunnelを使用する場合)
+
+---
+## Docker Composeのインストール
+1. [Docker公式](https://docs.docker.com/engine/install/)のドキュメントに従ってインストールしてください。
+
+## リポジトリの取得
+kokonect(オリジナル)の場合
+```bash
+git clone -b master https://github.com/kokonect-link/cherrypick.git && \
+cd cherrypick
+```
+縁側フォーク(このリポジトリ)の場合
+```bash
+git clone -b develop https://github.com/1673beta/cherrypick.git && \
+cd cherrypick
+```
+
+## 設定
+### 設定ファイルのコピー
+下記コマンドを実行して設定ファイルをコピーします。
+```bash
+cp .config/docker_example.yml .config/default.yml && \
+cp .config/docker_example.env .config/docker.env && \
+cp ./compose_example.yml ./compose.yml
+```
+> [!Note]
+> CherryPick v4.9.0以前ではcompose_example.ymlはdocker-compose_example.ymlという名前です。
+
+### 設定ファイルの編集
+`default.yml`と`docker.env`を編集します。
+この時、両ファイルのPostgreSQLのユーザー名、パスワード、DB名は同一にしてください。
+
+## 起動
+編集が終わったら、下記コマンドを実行します。  
+ビルドには通常時間がかかります。
+### ビルド
+```bash
+sudo docker compose build
+sudo docker compose run --rm web pnpm run init
+```
+### 起動
+```bash
+sudo docker compose up -d
+```
+お疲れ様でした。よきFediverseライフを。
+
+## Cloudflare Tunnelを使用する場合
+`compose.yml`のtunnelと書かれた部分のコメントアウトを外し、あなたのCloudflaredのトークンをenvironment/TUNNEL_TOKENに貼り付けることで起動します。