Inital commit

2026-08-19 13:55:59 +09:00
commit d61554d8b9
735 changed files with 86553 additions and 0 deletions
@@ -0,0 +1,22 @@
+How to backup your Misskey
+==========================
+
+Make sure **mongodb-tools** installed.
+
+---
+
+In your shell:
+``` shell
+$ mongodump --archive=db-backup -u <YourUserName> -p <YourPassword>
+```
+
+For details, plese see [mongodump docs](https://docs.mongodb.com/manual/reference/program/mongodump/).
+
+Restore
+-------
+
+``` shell
+$ mongorestore --archive=db-backup
+```
+
+For details, please see [mongorestore docs](https://docs.mongodb.com/manual/reference/program/mongorestore/).
@@ -0,0 +1,35 @@
+Setup with Docker Compose :whale:
+================================================================
+
+The Compose environment builds Misskey with Node.js 22 and starts the app,
+MongoDB 4.4, and Redis 7 as separate services.
+
+From the repository root, run:
+
+``` console
+$ docker compose up --build
+```
+
+Open http://localhost:3000 after the `app` service becomes healthy.
+MongoDB data is stored in the `mongodb-data` named volume.
+
+Run the full test suite against the Compose databases with:
+
+``` console
+$ docker compose run --rm app npm test
+```
+
+To stop the services without deleting the database:
+
+``` console
+$ docker compose down
+```
+
+To also delete the local MongoDB data, explicitly remove the volume:
+
+``` console
+$ docker compose down --volumes
+```
+
+The supplied `docker/default.yml` is intended only for local verification.
+Use your own `.config/default.yml` and secrets for a real deployment.
@@ -0,0 +1,26 @@
+# Misskeyにカンパする方法
+Misskeyのサポートにご興味をお持ちいただきありがとうございます！
+Misskeyにカンパをしていただくと、貴方のお名前と好きなURLなどをMisskeyのリポジトリに刻む権利がもらえます。
+
+Misskeyにカンパして開発・運営をサポートするには、次のいくつかの方法があります:
+
+## ConoHaカードを購入する
+(本家)Misskeyは、ConoHaというVPSサービスを利用しています。ConoHaカードを購入して、
+カードに記載されているクーポンコードを syuilotan@yahoo.co.jp までお送りいただければ、
+そのクーポンをチャージしてサーバーの運営費に充てることができます。
+
+ConoHaカードについてはこちらをご覧ください: https://www.conoha.jp/conohacard/
+
+Amazonでも買えます: https://www.amazon.co.jp/dp/B01N9E3416
+
+## Amazonギフトカード
+これは間接的な方法です。
+
+## 銀行振込
+syuilotan@yahoo.co.jp までお問い合わせください。
+
+## 手渡し
+オフ会を行ったときなどに行使できる方法です。
+
+## その他
+なにかいいアイデアがあればお教えください。
@@ -0,0 +1,13 @@
+# 運営ガイド
+
+## ジョブキューの状態を調べる
+Misskeyのディレクトリで:
+``` shell
+node_modules/kue/bin/kue-dashboard -p 3050
+```
+ポート3050にアクセスするとUIが表示されます
+
+## ユーザーを凍結する
+``` shell
+node cli/suspend (ユーザーID)
+```
@@ -0,0 +1,68 @@
+Misskey Setup and Installation Guide
+================================================================
+
+We thank you for your interest in setting up your Misskey server!
+This guide describes how to install and setup Misskey.
+
+[Japanese version also available - 日本語版もあります](./setup.ja.md)
+
+----------------------------------------------------------------
+
+*1.* reCAPTCHA tokens
+----------------------------------------------------------------
+Misskey requires reCAPTCHA tokens.
+Please visit https://www.google.com/recaptcha/intro/ and generate keys.
+
+*(optional)* Generating VAPID keys
+----------------------------------------------------------------
+If you want to enable ServiceWroker, you need to generate VAPID keys:
+
+``` shell
+npm install web-push -g
+web-push generate-vapid-keys
+```
+
+*2.* Install dependencies
+----------------------------------------------------------------
+Please install and setup these softwares:
+
+#### Dependencies :package:
+* **Node.js 22.x** and its bundled npm
+* **[MongoDB](https://www.mongodb.com/)**
+* **[Redis](https://redis.io/)**
+* **[ImageMagick](http://www.imagemagick.org/script/index.php)** >= 7.0
+
+##### Optional
+* [Elasticsearch](https://www.elastic.co/) - used to provide searching feature instead of MongoDB
+
+*3.* Install Misskey
+----------------------------------------------------------------
+1. `git clone -b master git://github.com/syuilo/misskey.git`
+2. `cd misskey`
+3. `npm ci`
+
+*4.* Prepare configuration
+----------------------------------------------------------------
+1. Copy `example.yml` of `.config` directory
+2. Rename it to `default.yml`
+3. Edit it
+
+---
+
+Or you can generate config file via `npm run config` command.
+
+*5.* Build Misskey
+----------------------------------------------------------------
+1. `npm run build`
+
+*6.* That is it.
+----------------------------------------------------------------
+Well done! Now, you have an environment that run to Misskey.
+
+### Launch
+Run `npm start`. GLHF!
+
+### Way to Update to latest version of your Misskey
+1. `git reset --hard && git pull origin master`
+2. `npm ci`
+3. `npm run build`
@@ -0,0 +1,69 @@
+Misskey構築の手引き
+================================================================
+
+Misskeyサーバーの構築にご関心をお寄せいただきありがとうございます！
+このガイドではMisskeyのインストール・セットアップ方法について解説します。
+
+[英語版もあります - English version also available](./setup.en.md)
+
+----------------------------------------------------------------
+
+*1.* reCAPTCHAトークンの用意
+----------------------------------------------------------------
+MisskeyはreCAPTCHAトークンを必要とします。
+https://www.google.com/recaptcha/intro/ にアクセスしてトークンを生成してください。
+
+*(オプション)* VAPIDキーペアの生成
+----------------------------------------------------------------
+ServiceWorkerを有効にする場合、VAPIDキーペアを生成する必要があります:
+
+``` shell
+npm install web-push -g
+web-push generate-vapid-keys
+```
+
+*2.* 依存関係をインストールする
+----------------------------------------------------------------
+これらのソフトウェアをインストール・設定してください:
+
+#### 依存関係 :package:
+* **Node.js 22.x** と同梱のnpm
+* **[MongoDB](https://www.mongodb.com/)**
+* **[Redis](https://redis.io/)**
+* **[ImageMagick](http://www.imagemagick.org/script/index.php)**
+
+##### オプション
+* [Elasticsearch](https://www.elastic.co/) - 検索機能を向上させるために用います。
+
+*3.* Misskeyのインストール
+----------------------------------------------------------------
+1. `git clone -b master git://github.com/syuilo/misskey.git`
+2. `cd misskey`
+3. `npm ci`
+
+*4.* 設定ファイルを用意する
+----------------------------------------------------------------
+1. `.config`ディレクトリ内の`example.yml`をコピー
+2. `default.yml`にリネーム
+3. 編集する
+
+---
+
+または、`npm run config`コマンドを利用して、ガイドに従って情報を
+入力して設定ファイルを生成することもできます。
+
+*5.* Misskeyのビルド
+----------------------------------------------------------------
+1. `npm run build`
+
+*6.* 以上です！
+----------------------------------------------------------------
+お疲れ様でした。これでMisskeyを動かす準備は整いました。
+
+### 起動
+`npm start`するだけです。GLHF!
+
+### Misskeyを最新バージョンにアップデートする方法:
+1. `git reset --hard && git pull origin master`
+2. `npm ci`
+3. `npm run build`
@@ -0,0 +1,27 @@
+Misskey's Translation - English version
+============
+
+How to add a new language?
+----------------------
+Copy a language file to `/locales` and rename it after the language you wish to add.
+
+If you find an untranslated part on Misskey:
+-------------------------------
+
+1. Look for untranslated parts in the miskey's source code.
+	- For instance, if you find an untranslated part in: `src/client/app/mobile/views/pages/home.vue`.
+
+2. Replace the untranslated portion with a character string of the form `%i18n:@foo%`.
+	- In fact, `foo` should be a word that is appropriate for the situation and is easy to understand in English.
+	- For example, if the untranslated portion is the following "タイムライン" you must write: `%i18n:@timeline%`.
+
+3. Open each language file in /locales, check whether the <strong>file name (path)</strong> found in step 1 exists, if not, create it.
+	- Do not put the beginning of the path `src/client/app/` in the locale file.
+	- For example, in this case we want to modify untranslated parts of `src/client/app/mobile/views/pages/home.vue`, so the key is `mobile/views/pages/home.vue`.
+
+4. Add the translated text property using the `foo` keyword below the path that you found or created in step 2. Make sure to type your text in quotation marks. Text should always be inside of quotes.
+	-   For example, in this case we add timeline: `timeline: "Timeline"` to `locales/en.yml`, and `timeline: "タイムライン"` to `locales/ja.yml`.
+
+5. And done！
+
+For more details, please refer to this [commit](https://github.com/syuilo/misskey/commit/10f6d5980fa7692ccb45fbc5f843458b69b7607c).
@@ -0,0 +1,27 @@
+Traduction de Misskey - Version Française
+============
+
+Comment ajouter une nouvelle langue ?
+----------------------
+Veuillez copier un fichier de langue dans /locales puis renommez-le du nom de la langue que vous voulez ajouter et modifier.
+
+Si vous trouvez un segment non-traduit sur Misskey :
+-------------------------------
+
+1. Veuillez chercher des parties non-traduites dans le code source de Misskey.
+	- Par exemple, supposons que vous trouviez un segment non-traduit dans : `src/client/app/mobile/views/pages/home.vue`.
+
+2. Remplacez la portion non-traduite par une chaîne de caractères de type `%i18n:@foo%`.
+	- En fait, `foo` doit être un mot approprié à la situation et facile à comprendre en français.
+	- Par exemple, si le segment non-traduit est「タイムライン」on peut écrire : `%i18n:@timeline%`.
+
+3. Ouvrez chaque fichier linguistique dans /locales, vérifiez si le <strong>nom du fichier (chemin)</strong> trouvé dans l'étape 1 existe, sinon créez-le.
+	- Ne mettez pas le début du chemin `src/client/app/` dans les fichiers /locales.
+	- Par exemple, dans ce cas de figure, nous voulons modifier le segment non-traduit de : `src/client/app/mobile/views/pages/home.vue`donc il faut juste écrire : `mobile/views/pages/home.vue` dans les fichiers linguistiques.
+
+4. Ajoutez la propriété du texte traduit grâce à la clef `foo`, en-dessous du chemin correspondant à votre modification que vous avez trouvé ou créé dans l'étape 2. À côté, veuillez indiquer entre "guillemets" la valeur de votre traduction.
+	- Par exemple, dans ce cas de figure, nous ajoutons la propriété et la traduction `timeline: "Timeline"` à `locales/fr.yml`, mais aussi la propriété et la version originale `timeline: "タイムライン"` à `locales/ja.yml`.
+
+5. Vous avez réussi à traduire une portion de misskey ！
+
+Pour plus de détails, veuillez vous référer à ce  [commit](https://github.com/syuilo/misskey/commit/10f6d5980fa7692ccb45fbc5f843458b69b7607c).
@@ -0,0 +1,27 @@
+Misskeyの翻訳
+============
+
+新たな言語を追加するには
+----------------------
+/locales 内に既にある何らかの言語ファイルをコピーして、追加したい言語名にリネームして編集してください。
+
+Misskey内の未翻訳箇所を見つけたら
+-------------------------------
+
+1. Misskeyのソースコード内から未翻訳箇所を探してください。
+	- 例えば`src/client/app/mobile/views/pages/home.vue`で未翻訳箇所を見つけたとします。
+
+2. 未翻訳箇所を`%i18n:@foo%`のような形式の文字列に置換してください。
+	- `foo`は実際にはその場に適したわかりやすい(英語の)名前にしてください。
+	- 例えば未翻訳箇所が「タイムライン」というテキストだった場合、`%i18n:@timeline%`のようにします。
+
+3. /locales 内にあるそれぞれの言語ファイルを開き、1.で見つけた<strong>ファイル名(パス)</strong>のキーが存在するか確認し、無ければ作成してください。
+	- パスの`src/client/app/`は省略してください。
+	- 例えば、今回の例では`src/client/app/mobile/views/pages/home.vue`の未翻訳箇所を修正したいので、キーは`mobile/views/pages/home.vue`になります。
+
+4. そのキーの直下に2.で置換した`foo`の部分をキーとし、翻訳後のテキストを値とするプロパティを追加します。
+	- 例えば、今回の例で言うと`locales/ja.yml`に`timeline: "タイムライン"`、`locales/en.yml`に`timeline: "Timeline"`を追加します。
+
+5. 完了です！
+
+詳しくは、[このコミット](https://github.com/syuilo/misskey/commit/10f6d5980fa7692ccb45fbc5f843458b69b7607c)などを参考にしてください。