diff --git a/README.md b/README.md index 1482dde..2fce486 100644 --- a/README.md +++ b/README.md @@ -16,6 +16,19 @@ ``` 3. Restart your Parse server. +## Usage + +*VPX* will monitor every modification made on user Parse entities and log them in the class `VpxEntityOperationLog`: + +| Field | Type | Description +| :------------ | :------- | :------------------------------------------------------------ +| `createdAt` | `Date` | Date of the event +| `operation` | `String` | Operation executed, can be: `created`, `updated` or `deleted` +| `targetClass` | `String` | Class name of the entity modified +| `targetId` | `String` | Parse ID of the entity modified + +Note: by default, *VPX* will monitor *create*, *update* and *delete* operations. If a new class is added, *VPX* configuration must be reloaded with job `vpx-reload` or by restarting the Parse server in aim to monitor the added classes. + ## Configuration *VPX* can be configuration through configuration parameters available with Parse. @@ -33,17 +46,17 @@ These parameters can be created with Parse Dashboard in `Config > Create a param * `vpx-reload`: Reloads *VPX* configuration, can be called when new Parse classes have been added to monitor them. * `vpx-exec-ccc`: Executes the custom cloud code. -## Test locally +## Test it locally You can use the `docker-compose` provided to run locally *VPX*, Parse Server and Parse Dashboard: -1. Clone or download this repository: `git clone ...` -2. Run docker-compose: `docker-compose up` +1. Clone or download this repository: `git clone https://github.com/virtua-sa/virtua-parse-extended.git` +2. Run docker-compose: `cd virtua-parse-extended`, then `docker-compose up` 3. Browse to: http://dashboard.vpx.docker/ * Login and password can be found in the `docker-compose.yml` file, under section `parse-dashboard > environment > PARSE_DASHBOARD_USER_*` Note: you'll need [`dnsdock`](https://github.com/aacebedo/dnsdock) in aim to use this setup. -## Licence terms +## License terms *VPX - Virtua Parse eXtended* is published under the terms of [GNU Affero General Public License v3](https://www.gnu.org/licenses/agpl-3.0.html), see the [LICENSE](LICENSE) file. \ No newline at end of file