|
2 | 2 |
|
3 | 3 | ## Usage: |
4 | 4 | 1. Clone repo at: https://github.com/microsoftdocs/office-docs-powershell |
5 | | -2. Configure your email address in tools/.local/config/default.json to receive emailed logs. (OPTIONAL) |
| 5 | +2. Configure your email address in tools/.local/default.json to receive emailed logs. (OPTIONAL) |
6 | 6 | 3. Confirm you have NodeJS installed. |
7 | 7 | Open PowerShell or GitBash and type `npm --version`. |
8 | 8 | If not, install from [https://nodejs.org/en/download/](https://nodejs.org/en/download/). |
|
14 | 14 | - execute into console `winrm quickconfig` |
15 | 15 | - Microsoft Teams: |
16 | 16 | - https://www.powershellgallery.com/packages/MicrosoftTeams |
| 17 | + - alternatively, it could be installed by the tool, check Notes section below |
17 | 18 | - SharePoint Online: |
18 | 19 | - https://www.microsoft.com/en-us/download/details.aspx?id=35588 |
19 | | - - Exchange Online 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) |
| 20 | + - Exchange Online: |
| 21 | + - 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) |
20 | 22 | - Whiteboard: |
21 | 23 | - https://www.powershellgallery.com/packages/WhiteboardAdmin |
22 | | - - StaffHub: |
23 | | - - https://www.powershellgallery.com/packages/MicrosoftStaffHub |
24 | | - - Office Online Server cmdlets are not distributed separately |
25 | | - - SharePoint Migration Tool (SPMT): |
26 | | - - https://docs.microsoft.com/en-us/powershell/module/spmt |
27 | | -7. Run the app, type `npm start` and press Enter. |
| 24 | + - alternatively, it could be installed by the tool, check Notes section below |
| 25 | +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 |
| 27 | +9. Run `node index -help` to get help information for all available commands |
28 | 28 |
|
29 | 29 | ## Notes |
30 | | -1. The modules are installed from the PowerShell Gallery (PSGallery). |
31 | | - This gallery contains user submitted code. |
32 | | - If you would rather not install modules from the PSGallery then you can install the modules manually prior to running the tool. |
33 | | - If you need to add PSGallery as a trusted source, you can do so with the following command: |
34 | | - `Set-PSRepository -Name "PSGallery" -InstallationPolicy Trusted` |
| 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 |
35 | 32 |
|
36 | 33 | ## Sample Run |
0 commit comments