Add basic develop instructions to README (mattermost#14)

* Add basic develop instructions to README * Update README.md Co-Authored-By: Gabe Jackson <[email protected]> * Update README.md Co-Authored-By: Gabe Jackson <[email protected]>
IndushaS · Oct 21, 2019 · 8e4065d · 8e4065d
1 parent 55e8213
commit 8e4065d
Showing 1 changed file with 27 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -7,3 +7,30 @@ This plugin allows for the creation and management of Mattermost kubernetes inst
 1. Install the plugin.
 2. Enter configuration information for your environment and enable the plugin.
 3. From any channel or DM, run `/cloud -h` for information on using the plugin.
+
+## Developing
+
+1. Run a Mattermost server and web app locally, see https://developers.mattermost.com/contribute/server/developer-setup/ and https://developers.mattermost.com/contribute/webapp/developer-setup/
+2. Log in to create the system admin account
+3. Run a cloud provisioning server locally, see https://github.com/mattermost/mattermost-cloud#developing
+4. Create a webhook from your provisioning server to your Mattermost server with:
+  ```
+  cloud webhook create --owner cloud-plugin --url http://localhost:8065/plugins/com.mattermost.cloud/webhook
+  ```
+5. Set the following env variables:
+  ```
+  export MM_SERVICESETTINGS_SITEURL=http://localhost:8065
+  export MM_ADMIN_USERNAME=<your-sysadmin-username>
+  export MM_ADMIN_PASSWORD=<your-sysadmin-password>
+  ```
+6. From the plugin directory, run `make deploy` to deploy the plugin to your local Mattermost server
+7. Log in to the Mattermost server as the system admin, go to Plugins -> Mattermost Private Cloud and set the following settings:
+
+  | Setting | Value |
+  | - | - |
+  | Provisioning Server URL | http://localhost:8075 |
+  | Installation DNS | dev.cloud.mattermost.com |
+  | Mattermost E10 License | `E10 license file contents` |
+  | Mattermost E20 License | `E20 license file contents` |
+8. Enable the plugin
+The plugin is now usable. Make changes to your plugin and run `make deploy` again to run those changes on your local Mattermost server.