Update test setup docs and few typo fixes (#1150)
## Description Found a few misses in the docs regarding test env setup. ## Type of change <!--- Please check the type of change your PR introduces: ---> - [ ] 🌻 Feature - [ ] 🐛 Bugfix - [x] 🗺️ Documentation - [ ] 🤖 Test - [ ] 💻 CI/Deployment - [ ] 🐹 Trivial/Minor ## Issue(s) <!-- Can reference multiple issues. Use one of the following "magic words" - "closes, fixes" to auto-close the Github issue. --> * #<issue> ## Test Plan <!-- How will this be tested prior to merging.--> - [x] 💪 Manual - [ ] ⚡ Unit test - [ ] 💚 E2E
This commit is contained in:
parent
1c5f3d631d
commit
a6f4f65dba
@ -29,13 +29,13 @@ The following steps outline a simplified procedure for creating an Azure Ad appl
|
|||||||
|
|
||||||
1. **Configure required permissions**
|
1. **Configure required permissions**
|
||||||
|
|
||||||
Select **App Permission** from the app management panel.
|
Select **API Permissions** from the app management panel.
|
||||||
|
|
||||||
<img src="/img/m365app_permissions.png" className="guideImages"/>
|
<img src="/img/m365app_permissions.png" className="guideImages"/>
|
||||||
|
|
||||||
The required permissions are as follows:
|
Select the following permissions from **Microsoft API → Microsoft Graph → Application Permissions**:
|
||||||
|
|
||||||
<!-- vale Microsoft.Spacing = NO -->
|
<!-- vale Microsoft.Spacing = NO -->
|
||||||
| API / Permissions Name | Type | Description
|
| API / Permissions Name | Type | Description
|
||||||
|:--|:--|:--|
|
|:--|:--|:--|
|
||||||
| Calendars.ReadWrite | Application | Read and write calendars in all mailboxes |
|
| Calendars.ReadWrite | Application | Read and write calendars in all mailboxes |
|
||||||
@ -43,7 +43,7 @@ The following steps outline a simplified procedure for creating an Azure Ad appl
|
|||||||
| Files.ReadWrite.All | Application | Read and write files in all site collections |
|
| Files.ReadWrite.All | Application | Read and write files in all site collections |
|
||||||
| Mail.ReadWrite | Application | Read and write mail in all mailboxes |
|
| Mail.ReadWrite | Application | Read and write mail in all mailboxes |
|
||||||
| User.Read.All | Application | Read all users' full profiles |
|
| User.Read.All | Application | Read all users' full profiles |
|
||||||
<!-- vale Microsoft.Spacing = YES -->
|
<!-- vale Microsoft.Spacing = YES -->
|
||||||
|
|
||||||
1. **Grant admin consent**
|
1. **Grant admin consent**
|
||||||
|
|
||||||
@ -60,8 +60,8 @@ To extract the tenant and client ID, select Overview from the app management pan
|
|||||||
environment variables.
|
environment variables.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
export AZURE_TENANT_ID=<Directory (tenent) ID for configured app>
|
export TENANT_ID=<Directory (tenent) ID for configured app>
|
||||||
export AZURE_CLIENT_ID=<Application (client) ID for configured app>
|
export CLIENT_ID=<Application (client) ID for configured app>
|
||||||
```
|
```
|
||||||
|
|
||||||
<img src="/img/m365app_ids.png" className="guideImages"/>
|
<img src="/img/m365app_ids.png" className="guideImages"/>
|
||||||
@ -75,7 +75,7 @@ Click **New Client Secret** and follow the instructions to create a secret. Afte
|
|||||||
value right away because it won't be available later and export it as an environment variable.
|
value right away because it won't be available later and export it as an environment variable.
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
export AZURE_CLIENT_SECRET=<client secret value>
|
export CLIENT_SECRET=<client secret value>
|
||||||
```
|
```
|
||||||
|
|
||||||
<img src="/img/m365app_secret.png" className="guideImages"/>
|
<img src="/img/m365app_secret.png" className="guideImages"/>
|
||||||
|
|||||||
@ -2,10 +2,10 @@
|
|||||||
|
|
||||||
## Prerequisites
|
## Prerequisites
|
||||||
|
|
||||||
- Set `CORSO_PASSWORD` environment variable
|
- Set `CORSO_PASSPHRASE` environment variable
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
export CORSO_PASSWORD=<some password>
|
export CORSO_PASSPHRASE=<some password>
|
||||||
```
|
```
|
||||||
|
|
||||||
- Set AWS credential (needed for tests that use S3) environment variables
|
- Set AWS credential (needed for tests that use S3) environment variables
|
||||||
@ -30,6 +30,8 @@
|
|||||||
|
|
||||||
- Set M365 Credentials environment variables
|
- Set M365 Credentials environment variables
|
||||||
|
|
||||||
|
> You can find more information on how to get these values in [configuration docs](/configuration/m365_access).
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
export TENANT_ID=<tenant>
|
export TENANT_ID=<tenant>
|
||||||
export CLIENT_ID=<id>
|
export CLIENT_ID=<id>
|
||||||
|
|||||||
@ -36,9 +36,9 @@ To create the environment variables file, you can run the following.
|
|||||||
# create an env vars file
|
# create an env vars file
|
||||||
$ cat <<EOF ~/.corso/corso.env
|
$ cat <<EOF ~/.corso/corso.env
|
||||||
CORSO_PASSPHRASE
|
CORSO_PASSPHRASE
|
||||||
AZURE_TENANT_ID
|
TENANT_ID
|
||||||
AZURE_CLIENT_ID
|
CLIENT_ID
|
||||||
AZURE_CLIENT_SECRET
|
CLIENT_SECRET
|
||||||
AWS_ACCESS_KEY_ID
|
AWS_ACCESS_KEY_ID
|
||||||
AWS_SECRET_ACCESS_KEY
|
AWS_SECRET_ACCESS_KEY
|
||||||
AWS_SESSION_TOKEN
|
AWS_SESSION_TOKEN
|
||||||
|
|||||||
@ -17,7 +17,7 @@ function HomepageHeader() {
|
|||||||
<Link
|
<Link
|
||||||
className="button button--secondary button--lg"
|
className="button button--secondary button--lg"
|
||||||
to="tutorial">
|
to="tutorial">
|
||||||
Docusaurus Tutorial - 5min ⏱️
|
Corso Tutorial - 5min ⏱️
|
||||||
</Link>
|
</Link>
|
||||||
</div>
|
</div>
|
||||||
</div>
|
</div>
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user