bitinflow/expose
1
0
Fork 0
mirror of https://github.com/bitinflow/expose.git synced 2026-03-13 13:35:54 +00:00
Code Issues Packages Projects Releases Wiki Activity

Improve docs

Browse Source
This commit is contained in:
Sebastian Schlein
2021-06-11 16:09:40 +02:00
parent 6b9fee9326
commit c06bcb7119
7 changed files with 37 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/client/basic-authentication.md
View File

@@ -7,7 +7,7 @@ order: 2
Expose allows you to share your local sites with custom basic authentication credentials.
This can be useful, if you have a static subdomain that you share with someone else, for example a client, and you want to provide some additional security to it. Before someone can access your shared site, they need to provide the correct credentials.
This is useful, if you have a static subdomain that you share with someone else, for example a client, and you want to provide some additional security to it. Before someone can access your shared site, they need to provide the correct credentials.
> **Warning**: You can not add basic authentication to a website that already uses basic authentication.
@@ -29,4 +29,4 @@ You can also use the basic authentication parameter in addition to a custom subd
```bash
expose share my-site.test --subdomain=site --auth="admin:secret"
```
```

14
docs/client/dashboard.md
View File

@@ -5,19 +5,19 @@ order: 5
# Dashboard
Once you share a local site, expose will show you all incoming HTTP requests along with their status code and duration in your terminal:
Once you share a local site, Expose shows you all incoming HTTP requests along with their status code and duration in your terminal:
![](/img/expose_terminal.png)
While this is great to get a quick look of the incoming requests, you sometimes need more information than this.
While this is great to get a quick look of the incoming requests, you often need more information than this.
Because of that, expose is also exposing a web based dashboard on port 4040.
Because of that, Expose is also exposing a web based dashboard on port 4040.
Once you start sharing a site, expose will show you a QR code that you can scan with your mobile device, to easily browse your shared sites on your phone or tablet.
Once you start sharing a site, Expose shows you a QR code that you can scan with your mobile device, to easily browse your shared sites on your phone or tablet.
![](/img/expose_qr.png)
Once a request comes in, you can see all incoming HTTP requests as they hit your local site in realtime.
When you click on a specific request, you can see detailed information about the request and response.
When a request comes in, you can see all incoming HTTP requests as they hit your local site in realtime.
You can click on a specific request and see detailed information about the request and response. Expose provides several tools for developers to make webhook testing easier – the most powerful one is that you can replay requests without firing the webhook again. So if your previous process required to create multiple test orders to see how the paylods of your payment provider look like, Expose makes this a breeze by allowing you to replay these requests without creating more orders.
![](/img/expose_dashboard_details.png)
![](/img/expose_dashboard_details.png)

9
docs/client/sharing.md
View File

@@ -7,11 +7,11 @@ order: 1
Expose allows you to share any kind of HTTP/HTTPS traffic for websites that you can reach on your own computer, with anyone on the internet.
There are multiple different ways on how you can initiate the site sharing with Expose.
There are multiple ways to share a site with Expose.
## Sharing the current working directory
To share the current working directory with expose, all you need to do is go into the directory and call `expose`.
To share the current working directory with Expose, all you need to do is go into the directory and call `expose`.
This makes the assumption that you have access to the current working directory name as a domain with the `.test` TLD.
@@ -48,8 +48,7 @@ expose share https://my-local-site.dev
## Share a local site with a given subdomain
You can also share one of your local sites explicitly and specify which exact subdomain you want Expose to use when sharing the site.
This works similar to the paid offerings of Ngrok - but you can use it with your own custom server.
You can also share one of your local sites explicitly and specify the exact subdomain that you want to use when sharing the site. This is very useful if you are testing webhooks and want to use the same webhook configuration and don't update the webhook endpoints on every Expose connect. Custom subdomains require an own Expose server in your infrastructure or Expose Pro.
To specify the subdomain, pass the `--subdomain` option to expose:
@@ -57,4 +56,4 @@ To specify the subdomain, pass the `--subdomain` option to expose:
expose share my-site.test --subdomain=my-site
```
If the chosen subdomain is already taken on the Expose server, you will see an error message and the connection to the Expose server gets closed.
If someone already uses the chosen subdomain on the Expose server, you will see an error message and the Expose server closes the connection.