Skip to content

Commit

Permalink
update README
Browse files Browse the repository at this point in the history
  • Loading branch information
nojimage committed Oct 9, 2019
1 parent 251149d commit 81f797c
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 10 deletions.
20 changes: 15 additions & 5 deletions README.ja.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,16 @@

## 注意事項

データベースへのマイグレーション処理をブラウザーから直接行うことができるようになるため、サーバーの制約によりCUIが直接利用できない場合にのみ導入してください。
データベースへのマイグレーション処理をブラウザーから直接実行できるため、操作によりデータを削除または破壊する可能性があります。
サーバーの制約によりCUIが直接利用できない場合にのみ導入してください。
また、設置時は認証・認可を適切に設定して、許可のないユーザーが実行できないようにしてください。

## 機能

- アプリケーション/プラグインのマイグレーション適用状況の一覧表示
- マイグレーションの適用/ロールバック
- マイグレーションファイルの表示

## インストール

[composer](http://getcomposer.org) を使用してインストールできます。
Expand Down Expand Up @@ -63,8 +70,11 @@ Configure::write('Elastic/MigrationManager.baseController', \App\Controller\Admi

ブラウザから `https://{your-app-host}/migration-manager/migrations` へアクセスすることで使用できます。

## 機能
### ロールバックを許可する

- アプリケーション/プラグインのマイグレーション適用状況の一覧表示
- マイグレーションの適用/ロールバック
- マイグレーションファイルの表示
デフォルトではロールバック操作は行えないようになっています。
ロールバックを許可する場合は、アプリケーションの `config/bootstrap.php` ファイルへ、次の行を追加します:

```php
Configure::write('Elastic/MigrationManager.canRollback', true);
```
20 changes: 15 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,18 @@ This plugin provides a GUI for database migrations via a web browser.

## IMPORTANT NOTICE

This plugin can be run migration from the web browser directly,
This plugin can be run migration from the web browser directly
so some operation may deleting/breaking data,
You install this only when CUI cannot be used due to server restrictions.
Also, when installing, setup authentication and authorization appropriately,
so that unauthorized users cannot execute it.

## Features

- List of Application / Plugins migration statuses
- Run migrate / rollback a migration
- Show migration file

## Installation

You can install this plugin into your CakePHP application using [composer](http://getcomposer.org).
Expand Down Expand Up @@ -65,8 +72,11 @@ Configure::write('Elastic/MigrationManager.baseController', \App\Controller\Admi

You can be used by accessing `https://{your-app-host}/migration-manager/migrations` from a browser.

## Features
### Allow rollback

- List of Application / Plugins migration statuses
- Run migrate / rollback a migration
- Show migration file
In default, you can't call rollback action.
If you want to rollback, adding the following statement in your project's `config/bootstrap.php` file:

```php
Configure::write('Elastic/MigrationManager.canRollback', true);
```

0 comments on commit 81f797c

Please sign in to comment.