Skip to content

Commit 64c53c1

Browse files
committed
chore: update readme
1 parent e387272 commit 64c53c1

1 file changed

Lines changed: 15 additions & 9 deletions

File tree

ReadMe.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,32 +1,38 @@
11
# dev-mirror
22

3-
Simple mirror (proxy) server for private APIs testing which will help you
4-
to keep your private credentials out of build artifacts.
3+
Simple mirror (proxy) server for private APIs testing.
4+
It will help you to keep private credentials out of build artifacts.
55

66
## Features
77

88
* Target server authentication
99
* Local server authentication
10-
* Spoofing referer
10+
* Spoofing referrer
1111
* CORS bypass
1212

1313
## Usage
1414

15-
Use environmental variables or `.env`:
16-
```.env
15+
Use environmental variables or `.env` file in working directory:
16+
```dotenv
17+
# Remote HTTP(S) server
1718
SERVER_SCHEME = https
1819
SERVER_HOST = example.com
1920
SERVER_PORT = 443
20-
# HTTP Basic auth
21+
# Remote server HTTP Basic auth
2122
SERVER_USERNAME = user
2223
SERVER_PASSWORD = passw0rd
24+
# Local HTTP server
2325
LOCAL_BIND_IP = 127.0.0.1
2426
LOCAL_PORT = 8080
25-
# HTTP Basic auth
27+
# Local server HTTP Basic auth
2628
LOCAL_USERNAME = user
2729
LOCAL_PASSWORD = passw0rd
2830
```
2931

30-
Keep in mind, that if you have local server authentication without target
31-
server authentication you wont be able to authenticate.
32+
Keep in mind, that if you have local server authentication, you wont be able
33+
to send authentication details to remote server though the mirror.
3234

35+
That means, that configuration where remote server requires authentication and
36+
mirror has no remote credentials, but has local authentication is invalid.
37+
To fix this add remote credentials (recommended), or disable local
38+
authentication.

0 commit comments

Comments
 (0)