diff --git a/COLLAB_MODE.md b/COLLAB_MODE.md
index 1456569..63f3400 100644
--- a/COLLAB_MODE.md
+++ b/COLLAB_MODE.md
@@ -7,7 +7,7 @@
-## Collaboration mode
+## Collaboration Mode
PoiEx allows for real-time synchronization of findings and comments with other users. This mode requires a MongoDB instance shared across all collaborators. See the MongoDB section below for how to deploy a MongoDB instance.
@@ -15,7 +15,7 @@ Once you have a shared MongoDB instance ready, set your name in _Settings > Exte
To create a project, the Project Manager should open the desired codebase in VS Code, then click _Init project_ in the PoiEx tab. If the project is encrypted, the automatically generated secret should be sent via a secure channel to all collaborators.
To open an existing project, a collaborator should:
- Ensure PoiEx is connected to the same MongoDB instance as the project manager
- - Ensure that in the PoiEx extension settings, the same MongoDB database name as the project manager is specified
+ - Ensure that in the PoiEx extension settings, the MongoDB database name specified is the same as the project manager
- Open a VS Code workspace with the same codebase as the project manager (the codebase is never uploaded to MongoDB and needs to be shared separately)
- Click _Open existing project_ in the PoiEx tab
- Select the project based on project name and project UUID
@@ -25,8 +25,8 @@ After this, all findings and notes will be synchronized in real-time across all
### Shared MongoDB Instance
-To enable collaboration features all collaborators should connect to a common MongoDB instance.
-All collaborators should have read and write access to the database configured in the `poiex.collab.database` field of the VSCode settings. To enable collaboration features set `poiex.collab.enabled` to `true` and `poiex.collab.uri` to the MongoDB URI.
+To enable collaboration features, all collaborators should connect to a common MongoDB instance.
+All collaborators should have read and write access to the database configured in the `poiex.collab.database` field of the VSCode settings. To enable collaboration features, set `poiex.collab.enabled` to `true` and `poiex.collab.uri` to the MongoDB URI.
Optionally, update `poiex.collab.database` if using a database name different from the default value. If credentials are required to connect to the database, the extension will prompt the user for credentials.
The extension supports an auto-delete feature, if `poiex.collab.expireAfter` is set to a value higher than `0`, it will configure MongoDB to automatically delete projects that are not accessed for the specified number of seconds. The project expiration value is reset each time one of the collaborators accesses the project. The expiration value does not affect project data that is saved locally.
If a local project is not found on the remote database, the extension will push the local version to the remote database.
@@ -68,11 +68,12 @@ mongosh -u "$ADMIN_USERNAME" -p "$ADMIN_PASSWORD" --authenticationDatabase "admi
mongosh -u "$ADMIN_USERNAME" -p "$ADMIN_PASSWORD" --authenticationDatabase "admin" <<< "var x = rs.conf(); x.members[0].host = \"$FQDN:27017\"; rs.reconfig(x);"
```
-**Security Note**: *The given deployment script is intended for plug&play purposes to test the extension and its collaboration capabilities. For production-safe usages, configure an hardened MongoDB instance machine depending on your needs by following the best practices (see the [documentation](https://www.mongodb.com/docs/manual/administration/security-checklist/))*
+**Security Note**: *The given deployment script is intended for plug&play purposes to test the extension and its collaboration capabilities. For production-safe usages, configure a hardened MongoDB instance machine to fit your needs by following the best practices (see the [documentation](https://www.mongodb.com/docs/manual/administration/security-checklist/))*
After deployment create additional user(s) for the extension collaborators. Each user should have read/write access to one common database. Each collaborator should enter the same MongoDB URI and database name in the extension settings.
+
### Security Model
-Since the tool is intended internal usage, currently the MongoDB users (testers) are required to have read and write permissions on the configured database.
+Since the tool is intended for internal usage, currently the MongoDB users (testers) are required to have read and write permissions on the configured database.
Consequently, everyone in the team can list, add or destroy projects.
-As previously described, per-project symmetric encryption keys are created and they must be shared among peers participating to an activity in order to decrypt and read the stored data. In this way the confidentiality is project-oriented.
+As previously described, per-project symmetric encryption keys are created and they must be shared among peers participating to an activity, in order to decrypt and read the stored data. In this way the confidentiality is project-oriented.