From b9200e37906b894f5b3bef42ad17e5a0b180f519 Mon Sep 17 00:00:00 2001 From: Sebastian Schlein Date: Mon, 14 Jun 2021 16:49:29 +0200 Subject: [PATCH] improve docs in preparation for the Expose 2 launch --- docs/client/sharing.md | 6 ++++-- docs/getting-started/installation.md | 2 +- docs/getting-started/sharing-your-first-site.md | 8 ++++---- docs/introduction.md | 8 ++++---- 4 files changed, 13 insertions(+), 11 deletions(-) diff --git a/docs/client/sharing.md b/docs/client/sharing.md index f0142c4..330b060 100644 --- a/docs/client/sharing.md +++ b/docs/client/sharing.md @@ -29,11 +29,13 @@ For example: ~/Sites/api.my-site/ expose ``` +If you are using the Expose network on the free plan, you get a random subdomain on every connect. You can upgrade to Expose Pro and use custom subdomains as if you'd host your own server. + ## Sharing a local site explicitly -If you want to explicitly share a local URL, without going into a specific folder first, you can do this by using the `expose share` command. +If your local sites are not available at `foldername.test` you can explicitly share a local URL, without going into a specific folder first. You can do this by using the `expose share` command and specify the domain directly. -> By default, this command will generate a unique subdomain for the shared URL. +This is required when sharing sites that have HTTPS locally or Expose can't map local directory names to URLs automatically. ```bash # Will share access to http://192.168.2.100 using a randomly generated subdomain diff --git a/docs/getting-started/installation.md b/docs/getting-started/installation.md index dd5cd21..dcfd29d 100644 --- a/docs/getting-started/installation.md +++ b/docs/getting-started/installation.md @@ -5,7 +5,7 @@ order: 1 # Installation -Expose is a PHP package and you can install the client for your local machine as a global composer dependency: +Expose is a PHP application and you can install the client for your local machine as a global composer dependency: ```bash composer global require beyondcode/expose diff --git a/docs/getting-started/sharing-your-first-site.md b/docs/getting-started/sharing-your-first-site.md index bca19e1..3e28f0d 100644 --- a/docs/getting-started/sharing-your-first-site.md +++ b/docs/getting-started/sharing-your-first-site.md @@ -5,9 +5,7 @@ order: 2 # Share your first site -Once you have installed Expose, you are ready to go and share your first local site. - -The easiest way to share your local sites is by going into the folder that you want to share and run the `expose` command from your command line: +If you are on macOS and use Laravel Valet as your local development environment, the easiest way to share your local sites is by going into the folder that you want to share and run the `expose` command from your command line: ```bash cd ~/Sites/my-awesome-project/ @@ -15,9 +13,11 @@ cd ~/Sites/my-awesome-project/ expose ``` +The `expose` command assumes that your local site is available at `http://my-awesome-project.test`. + This command uses your Expose network token and connects to the Expose network server at sharedwithexpose.com and creates a tunnel. If you don't have an Expose token and don't want to host your own server, you can create a free account and get a token [here](https://beyondco.de/login). -To learn more about sharing your local sites, check out the [sharing local sites](/docs/expose/client/sharing) documentation. +If you run a different operating system or your local application runs in a virtual machine, Docker or uses a custom URL scheme, you can share the site by adding more parameters to the command. To learn more about sharing your local sites, check out the [sharing local sites](/docs/expose/client/sharing) documentation. ## Using the Expose network at sharedwithexpose.com diff --git a/docs/introduction.md b/docs/introduction.md index e3fdddc..8f9017f 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -5,15 +5,15 @@ order: 1 # Introduction -Expose is an open source tunnel application that allows you to share your local sites and applications with others on the internet. +Expose is a tunnel application that allows you to share your local sites and applications with others on the internet. It is open source, written in PHP and the best alternative to ngrok for PHP developers. -You can host your own Expose server and customize the application to your own needs or create a [free Beyond Code Account](https://beyondco.de/login) and use our managed infrastructure. The managed Expose network has a free plan that uses the test infrastrcture in our data center in Germany – and a Pro plan that uses the global Expose network with access points in all over the world. +You can host your own Expose server and customize the application to your own needs or create a [Beyond Code Account](https://beyondco.de/login) and use our managed infrastructure. The managed Expose network has a free plan that runs on the test infrastrcture in our data center in Germany – and a Pro plan that uses the global Expose network with access points all over the world. If you decide to host your own server, you can extend Expose with additional features and middleware classes on the server and client side. This gives your the full flexibility of true customization but comes with some maintenance overhead. -Expose itself comes with a beautiful CLI view and a web-based dashboard that show you incoming HTTP requests on the client. +Expose has a powerful CLI and a web-based dashboard. Both show you incoming HTTP requests on the client. -Expose is the alternative to ngrok for PHP developers. +If you work with PHP and use composer, [install Expose now](/docs/getting-started/installation). ![](/img/expose_terminal.png)