オリジナルのドキュメント
最終同期リビジョン: 869cb77b
ドキュメントはAGPLv3でライセンスされています。
Git は コンピューターのファイルの変更を追跡し、複数の人々でのファイルの共同作業をおこなえるバージョン管理システムです。
¶ Getting Started
Probably the most popular way to store documentation, the Git module can effortlessly synchronize with any remote Git repository.
For convenience, instructions for the most popular Git providers are listed below. However, this module should work for virtually any standard Git provider.
このモジュールを有効化するには Git 2.7.4 以降がシステムにインストールされている必要があります。
dockerイメージはこの依存を含んでいます。
Git リポジトリは Wiki.js 専用に用意する必要があります。現時点ではサブフォルダーやサブモジュールには対応していません。
¶ プロバイダ
¶ Azure DevOps
Coming soon!
¶ BitBucket
Coming soon!
¶ GitHub
GitHub は最も有名なソースコントロールプロバイダです。
¶ 新しい鍵を作成する
- ターミナルを開く。
- コマンドを入力:
ssh-keygen -t rsa -b 4096 - 生成されたファイルの保存先を尋ねられるので、 Wiki.js がアクセス可能なパスを入力し (例:
/etc/wiki/github.pem)、 Enter を押します。 - パスフレーズは空のまま Enter を2回押します。パスワードで保護された鍵は使用できません。
Windows では、 Git Bash や Ubuntu for Windows のような Windows Subsystem for Linux (WSL) でコマンドを実行してください。 puttygen ユーティリティで生成した鍵も利用できます。
(訳注: 現在のWindows10にはOpenSSHが付属しているのでそちらも利用できます)
¶ GitHub に鍵を追加する
- Create a new GitHub repository.
- Click on the Settings tab.
- Click on the Deploy Keys in the left navigation menu.
- Click the Add deploy key button.
- Enter a name of your choice for this key (e.g. wiki) and paste the contents of the public key generated earlier. (file ending in
.pub) - Make sure the Allow write access is checked.
- Click the Add key button.
¶ Configure Wiki.js
- In the Administration Area, click on Storage in the left navigation menu.
- Make sure the Git storage target is checked.
- Click on the Git tab.
- Enter the following settings:
- Authentication Type:
ssh - Repository URI: On your GitHub repository page, in the Code tab, click on the Clone or download green button and copy the URI shown below Clone with SSH.
- Branch:
master - SSH Private Key Path: The path to your private key generated earlier.
- Username: Empty
- Password: Empty
- Default Author Email: Should match your GitHub account email.
- Default Author Name: Should match your GitHub account name.
- Local Repository Path: Choose where the repo will be cloned locally or leave the default
./data/repovalue. - Verify SSL Certificate: On
- Authentication Type:
- Set the Sync Direction to Bi-directional.
- Set the Sync Schedule to 5 minutes.
- Click the Apply Changes button at the top of the page.
- Wait for the Status panel to update. A new entry for Git should appear in green. If the bar is red, it means you have an error in your configuration. Go back to the Git tab, fix the error and try again.
¶ GitLab
Coming soon!
¶ 一般的なシナリオ
¶ コンテンツのインポート
When enabling the Git storage module the first time with a remote repository that already have content, you might need to initiate a manual import. By default, only changes between the latest local commit and the latest remote commit will be imported.
Heads up! Make sure the Git module is already configured and working before proceeding any further!
To force all content currently present in the local repository to be imported, load the Git module settings tab in the Administration Area (under Storage), scroll to the very bottom of the page and click Run button on the Import Everything action card.
¶ Missing Content in Remote Repository
コンテンツが Git ストレージモジュールを有効化する前に作成されている場合や一時的にモジュールを無効化していた場合、コンテンツがリモートのGitリポジトリから欠落します。
注意 Gitモジュールが既に構成されていて動作していることを確認してから先に進んでください。
この問題を修正するには、管理画面の Git モジュールの設定タブ (ストレージ下)、ページの一番下までスクロールし、Add Untracked Changes アクションカードの 実行 ボタンをクリックします。これによって現在DBにある全てのコンテンツはローカルリポジトリ内のファイルに出力され、git追跡に追加され、1つのコミットが作成されます。
これはリモートリポジトリとの同期は行いません。次の同期を待つか、Force Sync アクションを使用して強制的に同期してください。
¶ よくある質問
¶ どうしてコンテンツを保存したときに同期されないのですか？
パフォーマンスの理由のため、新しいコミットは一定間隔(デフォルトでは5分ごと)で同期されます。スケジュールは Git ストレージモジュール設定で変更できます。
¶ 手動で強制的に同期するには？
Git モジュールの設定タブを管理画面(ストレージ下)でひらき、ページの一番下までスクロールし、Force Syncアクションカードの実行ボタンをクリックします。
