Skip to content

microCMSのコンテンツとメディアをバックアップするためのツールです。

Notifications You must be signed in to change notification settings

Sinhalite/microcms-backup-tool

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

25 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

microcms-backup-tool

Screenshot

概要

microCMS で管理しているコンテンツとメディア(画像・ファイル)を取得し、保存するツールです。

注意事項

  • 非公式ツールです。利用にあたっては、自己責任にてお願いいたします。
  • メディアの取得にあたっては、ベータ版の機能であるマネジメント API (https://document.microcms.io/management-api/get-media) を利用しています。
  • 利用する API キーには、あらかじめGETメディアの取得の権限付与が必要です。詳しくは API キーのドキュメント (https://document.microcms.io/content-api/x-microcms-api-key) を確認してください。
  • API キーの秘匿等の考慮はされていないため、取り扱いにはご注意ください。

利用方法

  1. ルートディレクトリにて、go run .を実行します。
  2. > モードを選択してください(auto / manual)と表示されるので、autoもしくはmanualを入力します。

auto モードを利用する場合

あらかじめルートディレクトリに、config.jsonを作成し、必要情報を設定してください。

{
  "target": "all",
  "serviceId": "xxxxxxxxxx",
  "apiKey": "xxxxxxxxxxxxxxxxxxxxxxxx",
  "endpoints": ["hoge", "fuga"],
  "requestUnit": 100
}

設定されたサービスに対してバックアップを実施します。

targetは、以下の 3 項目より選択してください。

  • all : コンテンツとメディア
  • contents : コンテンツのみ
  • media : メディアのみ

manual モードを利用する場合

対話モードにて、必要な項目を聞かれるので、それぞれ必要な値を入力します。

  1. backupフォルダの中に、ファイルが保存されます。

その他

  • go run . -mode=autoとして実行すると、対話式メッセージを出さずに自動で処理を行うことができます。

About

microCMSのコンテンツとメディアをバックアップするためのツールです。

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages