Skip to content

Commit d67897f

Browse files
committed
Fixed some internal and external links in the docs.
Signed-off-by: Exadra37 <exadra37@gmail.com>
1 parent 2dce15a commit d67897f

File tree

6 files changed

+15
-15
lines changed

6 files changed

+15
-15
lines changed

EXAMPLES.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[Approov](https://approov.io) is an API security solution used to verify that requests received by your backend services originate from trusted versions of your mobile apps, and here you can find the Hello servers examples that are the base for the Approov [quickstarts](/docs) for the Laravel PHP Framework.
44

5-
For more information about how Approov works and why you should use it you can read the [README](/README.md) at the root of this repo.
5+
For more information about how Approov works and why you should use it you can read the [Approov Overview](/OVERVIEW.md) at the root of this repo.
66

77
If you are looking for the Approov quickstarts to integrate Approov in your Laravel API server then you can find them [here](/docs).
88

@@ -32,7 +32,7 @@ cp src/approov-protected-server/token-check/hello/.env.example src/approov-prote
3232
cp src/approov-protected-server/token-binding-check/hello/.env.example src/approov-protected-server/token-binding-check/hello/.env
3333
```
3434

35-
Edit each file and add the [dummy secret](/README.md#the-dummy-secret) to it in order to be able to test the Approov integration with the provided [Postman collection](https://github.com/approov/postman-collections/blob/master/quickstarts/hello-world/hello-world.postman_curl_requests_examples.md).
35+
Edit each file and add the [dummy secret](/TESTING.md#the-dummy-secret) to it in order to be able to test the Approov integration with the provided [Postman collection](https://github.com/approov/postman-collections/blob/master/quickstarts/hello-world/hello-world.postman_curl_requests_examples.md).
3636

3737

3838
### Build the Docker Stack

docs/APPROOV_TOKEN_BINDING_QUICKSTART.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ This quickstart is for developers familiar with PHP Laravel framework who are lo
1414

1515
## Why?
1616

17-
To lock down your API server to your mobile app. Please read the brief summary in the [README](/README.md#why) at the root of this repo or visit our [website](https://approov.io/product.html) for more details.
17+
To lock down your API server to your mobile app. Please read the brief summary in the [Approov Overview](/OVERVIEW.md#why) at the root of this repo or visit our [website](https://approov.io/product) for more details.
1818

1919
[TOC](#toc---table-of-contents)
2020

2121

2222
## How it works?
2323

24-
For more background, see the overview in the [README](/README.md#how-it-works) at the root of this repository.
24+
For more background, see the [Approov Overview](/OVERVIEW.md#how-it-works) at the root of this repository.
2525

2626
The main functionality for the Approov token check is in the [Approov Middleware](/src/approov-protected-server/token-binding-check/hello/app/Http/Middleware/Approov.php) class. Take a look at the `verifyApproovToken()` and `verifyApproovTokenBinding()` functions to see the simple code for the checks.
2727

docs/APPROOV_TOKEN_QUICKSTART.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -14,14 +14,14 @@ This quickstart is for developers familiar with the PHP Laravel framework who ar
1414

1515
## Why?
1616

17-
To lock down your API server to your mobile app. Please read the brief summary in the [README](/README.md#why) at the root of this repo or visit our [website](https://approov.io/product.html) for more details.
17+
To lock down your API server to your mobile app. Please read the brief summary in the [Approov Overview](/OVERVIEW.md#why) at the root of this repo or visit our [website](https://approov.io/product) for more details.
1818

1919
[TOC](#toc---table-of-contents)
2020

2121

2222
## How it works?
2323

24-
For more background, see the overview in the [README](/README.md#how-it-works) at the root of this repo.
24+
For more background, see the [Approov Overview](/OVERVIEW.md#how-it-works) at the root of this repo.
2525

2626
The main functionality for the Approov token check is in the [Approov Middleware](/src/approov-protected-server/token-check/hello/app/Http/Middleware/Approov.php) class. Take a look at the `verifyApproovToken()` function to see the simple code for the check.
2727

src/approov-protected-server/token-binding-check/hello/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This Approov integration example is from where the code example for the [Approov
1212

1313
## Why?
1414

15-
To lock down your API server to your mobile app. Please read the brief summary in the [README](/README.md#why) at the root of this repo or visit our [website](https://approov.io/product.html) for more details.
15+
To lock down your API server to your mobile app. Please read the brief summary in the [Approov Overview](/OVERVIEW.md#why) at the root of this repo or visit our [website](https://approov.io/product) for more details.
1616

1717
[TOC](#toc---table-of-contents)
1818

@@ -22,7 +22,7 @@ To lock down your API server to your mobile app. Please read the brief summary i
2222
The PHP Laravel API server is very simple and is defined in the project [src/approov-protected-server/token-binding-check/hello](/src/approov-protected-server/token-binding-check/hello). Take a look at the [Approov Middleware](/src/approov-protected-server/token-binding-check/hello/app/Http/Middleware/Approov.php) class, and search for the `verifyApproovToken()` and `verifyApproovTokenBinding()` functions to see the simple code for the checks.
2323

2424

25-
For more background on Approov, see the overview in the [README](/README.md#how-it-works) at the root of this repo.
25+
For more background on Approov, see the [Approov Overview](/OVERVIEW.md#how-it-works) at the root of this repo.
2626

2727
[TOC](#toc---table-of-contents)
2828

@@ -42,7 +42,7 @@ First, you need to create the `.env` file. From the `src/approov-protected-serve
4242
cp .env.example .env
4343
```
4444

45-
Second, you need to set the dummy secret in the `src/approov-protected-server/token-binding-check/hello/.env` file as explained [here](/README.md#the-dummy-secret).
45+
Second, you need to set the dummy secret in the `src/approov-protected-server/token-binding-check/hello/.env` file as explained [here](/TESTING.md#the-dummy-secret).
4646

4747
Next, you need to install the dependencies. From the `src/approov-protected-server/token-binding-check/hello` folder execute:
4848

@@ -81,7 +81,7 @@ Content-Type: application/json
8181

8282
The reason you got a `401` is because no Approoov token isn't provided in the headers of the request.
8383

84-
Finally, you can test that the Approov integration example works as expected with this [Postman collection](/README.md#testing-with-postman) or with some cURL requests [examples](/README.md#testing-with-curl).
84+
Finally, you can test that the Approov integration example works as expected with this [Postman collection](/TESTING.md#testing-with-postman) or with some cURL requests [examples](/TESTING.md#testing-with-curl).
8585

8686

8787
[TOC](#toc---table-of-contents)

src/approov-protected-server/token-check/hello/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ This Approov integration example is from where the code example for the [Approov
1212

1313
## Why?
1414

15-
To lock down your API server to your mobile app. Please read the brief summary in the [README](/README.md#why) at the root of this repo or visit our [website](https://approov.io/product.html) for more details.
15+
To lock down your API server to your mobile app. Please read the brief summary in the [Approov Overview](/OVERVIEW.md#why) at the root of this repo or visit our [website](https://approov.io/product) for more details.
1616

1717
[TOC](#toc---table-of-contents)
1818

@@ -21,7 +21,7 @@ To lock down your API server to your mobile app. Please read the brief summary i
2121

2222
The PHP Laravel API server is very simple and is defined in the project [src/approov-protected-server/token-check/hello](/src/approov-protected-server/token-check/hello). Take a look at the [Approov Middleware](/src/approov-protected-server/token-check/hello/app/Http/Middleware/Approov.php) class, and search for the `verifyApproovToken()` function to see the simple code for the check.
2323

24-
For more background on Approov, see the overview in the [README](/README.md#how-it-works) at the root of this repo.
24+
For more background on Approov, see the [Approov Overview](/OVERVIEW.md#how-it-works) at the root of this repo.
2525

2626
[TOC](#toc---table-of-contents)
2727

@@ -41,7 +41,7 @@ First, you need to create the `.env` file. From the `src/approov-protected-serve
4141
cp .env.example .env
4242
```
4343

44-
Second, you need to set the dummy secret in the `src/approov-protected-server/token-check/hello/.env` file as explained [here](/README.md#the-dummy-secret).
44+
Second, you need to set the dummy secret in the `src/approov-protected-server/token-check/hello/.env` file as explained [here](/TESTING.md#the-dummy-secret).
4545

4646
Next, you need to install the dependencies. From the `src/approov-protected-server/token-check/hello` folder execute:
4747

@@ -80,7 +80,7 @@ Content-Type: application/json
8080

8181
The reason you got a `401` is because no Approoov token isn't provided in the headers of the request.
8282

83-
Finally, you can test that the Approov integration example works as expected with this [Postman collection](/README.md#testing-with-postman) or with some cURL requests [examples](/README.md#testing-with-curl).
83+
Finally, you can test that the Approov integration example works as expected with this [Postman collection](/TESTING.md#testing-with-postman) or with some cURL requests [examples](/TESTING.md#testing-with-curl).
8484

8585
[TOC](#toc---table-of-contents)
8686

src/unprotected-server/hello/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ The unprotected example is the base reference to build the [Approov protected se
1313

1414
## Why?
1515

16-
To be the starting building block for the [Approov protected servers](/src/approov-protected-server/), that will show you how to lock down your API server to your mobile app. Please read the brief summary in the [README](/README.md#why) at the root of this repo or visit our [website](https://approov.io/product.html) for more details.
16+
To be the starting building block for the [Approov protected servers](/src/approov-protected-server/), that will show you how to lock down your API server to your mobile app. Please read the brief summary in the [Approov Overview](/OVERVIEW.md#why) at the root of this repo or visit our [website](https://approov.io/product) for more details.
1717

1818
[TOC](#toc---table-of-contents)
1919

0 commit comments

Comments
 (0)