Skip to content

Commit 391b0e3

Browse files
authored
Fix notes in README.md
1 parent b2fdc83 commit 391b0e3

File tree

1 file changed

+43
-44
lines changed

1 file changed

+43
-44
lines changed

README.md

+43-44
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,7 @@ After you have create an account and obtained a license, navigate to https://www
8686
Click "Get License Key", copy the license key and when prompted in the gen.py script enter it.
8787

8888
> [!IMPORTANT]
89+
>
8990
> The license key will only be shown once!
9091
9192
### Auth0
@@ -95,9 +96,9 @@ Click "Get License Key", copy the license key and when prompted in the gen.py sc
9596
2. Navigate to Dashboard > Applications > APIs and create an API.
9697
![Alt text](.images/step2.png)
9798

98-
> [!NOTE]
99-
>
100-
> Replace example.com with your own domain name.
99+
> [!NOTE]
100+
>
101+
> Replace example.com with your own domain name.
101102
102103

103104

@@ -108,19 +109,19 @@ Click "Get License Key", copy the license key and when prompted in the gen.py sc
108109

109110
- Set "Application Login URI" to `https://app.example.com/account/login?returnUrl=`
110111

111-
> [!NOTE]
112-
>
113-
> Replace example.com with your own domain name.
112+
> [!NOTE]
113+
>
114+
> Replace example.com with your own domain name.
114115
- Set "Allowed Callback URLs to `https://app.example.com/callback`
115-
116-
> [!NOTE]
117-
>
118-
> Replace example.com with your own domain name.
116+
117+
> [!NOTE]
118+
>
119+
> Replace example.com with your own domain name.
119120
- Set "Allowed Logout URLS to `https://app.example.com/`
120121

121-
> [!NOTE]
122-
>
123-
> Replace example.com with your own domain name.
122+
> [!NOTE]
123+
>
124+
> Replace example.com with your own domain name.
124125
- Enable "Refresh Token Rotation"
125126
- Enable "Inactivity Expiration".
126127
![Alt text](.images/step3-1.png)
@@ -142,9 +143,9 @@ Click "Get License Key", copy the license key and when prompted in the gen.py sc
142143
organization-administrator
143144
```
144145

145-
> [!WARNING]
146-
>
147-
> Role names are case senstive
146+
> [!WARNING]
147+
>
148+
> Role names are case senstive
148149
149150
![Alt text](.images/step5.png)
150151

@@ -206,22 +207,22 @@ Click "Get License Key", copy the license key and when prompted in the gen.py sc
206207

207208
2. Unzip the file with `unzip syncfusionessentialhtmlconverter.zip "BlinkBinaries/*" -d "./BlinkBinaries"`
208209

209-
> [!IMPORTANT]
210-
> The BlinkBinaries folder must be in the same directory as the docker-compose.yml file
210+
> [!IMPORTANT]
211+
> The BlinkBinaries folder must be in the same directory as the docker-compose.yml file
211212
212213
3. Generate a self signed certificate `dotnet dev-certs https -ep lighthousenotes.pfx -p CHANGME`.
213214

214-
> [!NOTE]
215-
>
216-
> Replace CHANGEME with the password you specified in the script for the "Certificate Password" prompt
215+
> [!NOTE]
216+
>
217+
> Replace CHANGEME with the password you specified in the script for the "Certificate Password" prompt
217218
218219
4. Start SWAG with `docker compose up -d swag`.
219220

220221
5. Once you see `successfully received certificate`and `Server ready` in the swag container logs, move to step 6.
221222

222-
> [!TIP]
223-
>
224-
> Use `docker logs swag` to view the container logs
223+
> [!TIP]
224+
>
225+
> Use `docker logs swag` to view the container logs
225226
226227
6. Copy the Nginx site configs with `mv site-confs/* swag/nginx/site-confs/`.
227228

@@ -231,9 +232,9 @@ Click "Get License Key", copy the license key and when prompted in the gen.py sc
231232

232233
9. Navigate to the S3 console by opening the following in a browser https://s3.example.com:9001
233234

234-
> [!NOTE]
235-
>
236-
> Replace example.com with your own domain name.
235+
> [!NOTE]
236+
>
237+
> Replace example.com with your own domain name.
237238
238239
10. Login with `minio` as the user and the password you specified in the script at the "Minio root password" prompt.
239240

@@ -251,26 +252,26 @@ Click "Get License Key", copy the license key and when prompted in the gen.py sc
251252

252253
- Enable "Expire Delete Marker"
253254

254-
> [!IMPORTANT]
255-
>
256-
> Change "After" to the time period you wish to store edits to tabs for. E.g if you want to store edits to a tab for the past 30 days, set it to 30.
255+
> [!IMPORTANT]
256+
>
257+
> Change "After" to the time period you wish to store edits to tabs for. E.g if you want to store edits to a tab for the past 30 days, set it to 30.
257258
258259
14. Navigate to the "Access Keys" section in the side menu, and create an access key.
259260

260-
> [!IMPORTANT]
261-
> Store the access key and secret key somewhere temporarily as they are only shown once
261+
> [!IMPORTANT]
262+
> Store the access key and secret key somewhere temporarily as they are only shown once
262263
263264
15. Open the application in a private web browser, by visiting [app.example.com](https://app.example.com).
264265

265-
> [!NOTE]
266-
>
267-
> Use a private web browser untill you have set the organization settings, this is because it wil cache the incorrect settings on first load.
266+
> [!NOTE]
267+
>
268+
> Use a private web browser untill you have set the organization settings, this is because it wil cache the incorrect settings on first load.
268269
269-
---
270+
---
270271

271-
> [!NOTE]
272-
>
273-
> Replace example.com with your own domain name.
272+
> [!NOTE]
273+
>
274+
> Replace example.com with your own domain name.
274275
275276
16. Login with the user you created in the [Auth0](#auth0)
276277

@@ -282,10 +283,8 @@ Click "Get License Key", copy the license key and when prompted in the gen.py sc
282283

283284
20. Click the profile icon in top right and click "Profile" on this page click "Submit".
284285

285-
> [!NOTE]
286-
>
287-
> This is to save your user information to Meilisearch so your user is searchable.
286+
> [!NOTE]
287+
>
288+
> This is to save your user information to Meilisearch so your user is searchable.
288289
289290
21. Close the private browser window and then use the app as normal.
290-
291-
22.

0 commit comments

Comments
 (0)