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-21 21:54:46 +02:00
parent 9943132704
commit 8d9500abeb
3 changed files with 8 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/getting-started/installation.md
View File

@@ -6,7 +6,7 @@ order: 1
# Installation # Installation
## PHP Archive (PHAR) ## PHP Archive (PHAR)
We distribute Expose as a PHAR archive that contains everytrhing you need in order to use Expose. Simply download it from [here]() and make it executable: We distribute Expose as a PHAR archive that contains everything you need in order to use Expose. Simply download it from [here]() and make it executable:
``` ```
wget -O expose https://link-to-expose wget -O expose https://link-to-expose
@@ -16,7 +16,7 @@ chmod +x expose
./expose ./expose
``` ```
Most likely, you want to put the `expose.phar` into a directory on your `PATH`, so you can simply call expose from any directory. For example: You most likely want to put the `expose.phar` into a directory on your `PATH`, so you can simply call expose from any directory. For example:
``` ```
sudo mv expose.phar /usr/local/bin/expose sudo mv expose.phar /usr/local/bin/expose

4
docs/release-notes/2-0-0.md
View File

@@ -26,7 +26,7 @@ When sharing a local site explicitly via `expose share my-local-site.test`, Expo
Expose 2.0 finally adds the ability to share your local TCP ports with others. This is super useful when you want to give access to an application that is running on your local machine via an Expose server. Expose 2.0 finally adds the ability to share your local TCP ports with others. This is super useful when you want to give access to an application that is running on your local machine via an Expose server.
For exmaple, you can share your local [HELO](https://usehelo.com) instance with others, making it easy to send out emails from staging/production servers right into a desktop application running on your local computer. For example, you can share your local [HELO](https://usehelo.com) instance with others, making it easy to send out emails from staging/production servers right into a desktop application running on your local computer.
### Reserved Subdomains ### Reserved Subdomains
@@ -39,3 +39,5 @@ Expose 1.0 was limited to one server that it could connect to. In case of our fr
### White-Label Domain support ### White-Label Domain support
The 2.0 update of Expose finally allows you to register a custom white-label domain on the Expose servers, allowing you to use your own custom domain with the Expose service. This means that you no longer have to share `*.sharedwithexpose.com` URLs with your colleagues and clients, but you can now register your own domain and use that instead. All it takes is a simple CNAME DNS entry and you're ready to go! The 2.0 update of Expose finally allows you to register a custom white-label domain on the Expose servers, allowing you to use your own custom domain with the Expose service. This means that you no longer have to share `*.sharedwithexpose.com` URLs with your colleagues and clients, but you can now register your own domain and use that instead. All it takes is a simple CNAME DNS entry and you're ready to go!
White label domains get TLS/SSL certificates on the first connect to a URL automatically. This process takes a few seconds so that first page load can take a moment or even fail – try again after a few seconds and all additional requests will be fast until the certificate expires. Re-using the same (sub-)domain makes sure that your certificate stays available.

4
docs/upgrade-from-v1.md
View File

@@ -19,6 +19,6 @@ This will download and install the latest version of Expose. Your existing authe
## Upgrading to Expose ::pro ## Upgrading to Expose ::pro
Some of the Expose features are no longer available on our free server, such as custom subdomains, or the newly added TCP port sharing. Some Expose features are not available on our free server and require self-hosting or a Pro plan. These features include custom subdomains, or the newly added sharing of TCP ports.
If you want to upgrade your existing authentication token to Expose Pro, please [create a new Expose account](/register) where you will receive a fresh authentication token and can then upgrade to Expose Pro. If you want to upgrade your existing setup to Expose Pro, please [create a new Expose account](/register) and you get a new authentication token that can upgrade to Expose Pro.