Skip to content

Commit b79232e

Browse files
authored
more info about config file
1 parent 55a9a7e commit b79232e

File tree

1 file changed

+8
-15
lines changed

1 file changed

+8
-15
lines changed

tools/office-cmdlet-updater/README.md

Lines changed: 8 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,24 @@
11
# Office PowerShell Cmdlet Updater
22

3-
## Usage:
3+
## Usage
44
1. Clone repo at: https://github.com/microsoftdocs/office-docs-powershell
5-
2. Configure your email address in `tools/.local/default.json` to receive emailed logs. (OPTIONAL)
5+
2. Update configuration file `tools/.local/default.json`. Here is a brief explanation of all parameters
6+
* (REQUIRED) - `credentials\login` and `credentials\pass` should be updated with an account with Office 365 subscription and should have appropriate services in that subscription
7+
* (OPTIONAL) - `sendgrid\apiKey` and `sendgrid\emailSettings` should be updated with account details from an active sendgrid subscription
8+
* (OPTIONAL) - `github` section should be updated with account details from an active github account
69
3. Confirm you have NodeJS installed.
710
Open PowerShell or GitBash and type `npm --version`.
811
If not, install from [https://nodejs.org/en/download/](https://nodejs.org/en/download/).
9-
4. Open GitBash or PowerShell (using x64 version is a must here) and run `cd <EnterThePathHere>/office-docs-powershell/tools/office-cmdlet-updater`
12+
4. Open GitBash or PowerShell and run `cd <EnterThePathHere>/office-docs-powershell/tools/office-cmdlet-updater`
1013
5. Install the required modules, type `npm install` and press Enter.
11-
6. Install required PowerShell modules and connectors:
14+
6. Install required PowerShell modules and connectors that will not be installed by the tool:
1215
- Skype for Business Online:
1316
- https://www.microsoft.com/en-us/download/details.aspx?id=39366
1417
- execute into console `winrm quickconfig`
15-
- Microsoft Teams:
16-
- https://www.powershellgallery.com/packages/MicrosoftTeams
17-
- alternatively, it could be installed by the tool, check Notes section below
1818
- SharePoint Online:
1919
- https://www.microsoft.com/en-us/download/details.aspx?id=35588
2020
- Exchange Online:
2121
- cmdlets could be imported using [this guide](https://docs.microsoft.com/en-us/powershell/exchange/exchange-online/connect-to-exchange-online-powershell/connect-to-exchange-online-powershell)
22-
- Whiteboard:
23-
- https://www.powershellgallery.com/packages/WhiteboardAdmin
24-
- alternatively, it could be installed by the tool, check Notes section below
2522
7. Run the app, type `node index` and press Enter in order to get info for all modules
26-
8. Run the app for a certain module, type `node index -m <TypeModuleNameHere>`, with one of the following options - teams, skype, sharepoint, whiteboard, exchange. For example, you should run `node index -m teams` to run the tool for Microsoft Teams
23+
8. Run the app for a certain module, type `node index -m <TypeModuleNameHere>`, with one of the following options - teams, skype, sharepoint, whiteboard, exchange, staffhub. For example, you should run `node index -m teams` to run the tool for Microsoft Teams
2724
9. Run `node index -help` to get help information for all available commands
28-
29-
## Notes
30-
1. Some modules could be installed from the PowerShell Gallery (PSGallery). This gallery contains user submitted code. If you would rather not install modules from the PSGallery then you can install the modules manually prior to running the tool. If you need to add PSGallery as a trusted source, you can do so with the following command: `Set-PSRepository -Name "PSGallery" -InstallationPolicy Trusted`
31-
2. Run the tool from PowerShell x64 as an Administrator user

0 commit comments

Comments
 (0)