bitinflow/expose
1
0
Fork 0
mirror of https://github.com/bitinflow/expose.git synced 2026-03-13 21:45:55 +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

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

@@ -4,20 +4,19 @@ order: 1
---
# Installation
Expose can be installed using composer.
The easiest way to install expose is by making it a global composer dependency:
Expose is a PHP package and you can install the client for your local machine as a global composer dependency:
```bash
composer global require beyondcode/expose
```
Now you're ready to go and can [share your first site](/docs/expose/getting-started/sharing-your-first-site).
After that, you are ready to go and can [share your first site](/docs/expose/getting-started/sharing-your-first-site).
### Extending Expose
By default, expose comes as an executable PHAR file. This allows you to use all of the expose features, like sharing your local sites, out of the box - without any additional setup required.
By default, Expose comes as an executable PHAR file. This allows you to use all Expose features out of the box – without any additional setup required.
If you want to modify expose, for example by adding custom request/response modifiers, you will need to clone the GitHub repository instead.
If you want to modify Expose and want to add custom request/response modifiers, you need to clone the GitHub repository instead of the global composer dependency.
You can learn more about how to customize expose in the [extending Expose](/docs/expose/extending-the-server/subdomain-generator) documentation section.
You can learn more about the customization of Expose in the [extending Expose](/docs/expose/extending-the-server/subdomain-generator) documentation section.

4
docs/getting-started/questions-issues.md
View File

@@ -5,6 +5,6 @@ order: 3
# Questions and issues
Find yourself stuck using the package? Found a bug? Do you have general questions or suggestions for improving expose? Feel free to create an issue on [GitHub](https://github.com/beyondcode/expose/issues), we'll try to address it as soon as possible.
Find yourself stuck using the package? Found a bug? Do you have general questions or suggestions for improving Expose? Feel free to create an issue on [GitHub](https://github.com/beyondcode/expose/issues), we'll try to address it as soon as possible.
If you've found a bug regarding security please mail [marcel@beyondco.de](mailto:marcel@beyondco.de) instead of using the issue tracker.
If you've found a bug regarding security please mail [marcel@beyondco.de](mailto:marcel@beyondco.de) instead of using the issue tracker.

20
docs/getting-started/sharing-your-first-site.md
View File

@@ -5,9 +5,9 @@ order: 2
# Share your first site
Once you have installed Expose, you are ready to go and share your local sites.
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 `expose`:
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,19 +15,17 @@ cd ~/Sites/my-awesome-project/
expose
```
This will connect to the provided server at sharedwithexpose.com and give you a tunnel that you can immediately start using.
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 how you can share your local sites, check out the [sharing local sites](/docs/expose/client/sharing) documentation.
To learn more about sharing your local sites, check out the [sharing local sites](/docs/expose/client/sharing) documentation.
## Using the provided server at sharedwithexpose.com
## Using the Expose network at sharedwithexpose.com
A big advantage of Expose over other alternatives such as ngrok, is the ability to host your own server. To make sharing your sites as easy as possible, we provide and host a custom expose server on our own - so getting started with expose is a breeze.
Expose is the only open source tunnel service that is written in PHP. This means that you can host your own server and this on its own makes it a fantastic alternative to ngrok.
This server is available free of charge for everyone, but makes use of Expose's authentication token authorization method.
Before you install your own server, you can try Expose with the free plan of the Expose network and see if your like the features for PHP developers. To access the Expose network, you need an Expose token.
Therefore, in order to share your sites for the first time, you will need an authorization token.
You can obtain such a token by signing in to your [Beyond Code account](https://beyondco.de/login). If you do not yet have an account, you can [sign up and create an account](https://beyondco.de/register) for free.
You can obtain a token by signing in to your [Beyond Code account](https://beyondco.de/login). If you don't have an account, you can [sign up and create an account](https://beyondco.de/register) for free.
## Authenticating with sharedwithexpose.com
@@ -37,4 +35,4 @@ To register and use the given credentials, just run the following command:
expose token [YOUR-AUTH-TOKEN]
```
This will register the token globally in your expose configuration file, and all following expose calls will automatically use the token to authenticate with the server.
This will register the token globally in your expose configuration file and all following Expose calls will automatically use the token to authenticate with the network. In case that you have access to a team on an Expose Pro plan, you can use this command to switch to the team and get access to the reserved subdomains or white label domains.