mirror of
https://github.com/bitinflow/expose.git
synced 2026-03-13 13:35:54 +00:00
wip
This commit is contained in:
4
docs/getting-started/_index.md
Normal file
4
docs/getting-started/_index.md
Normal file
@@ -0,0 +1,4 @@
|
||||
---
|
||||
title: Getting Started
|
||||
order: 2
|
||||
---
|
||||
23
docs/getting-started/installation.md
Normal file
23
docs/getting-started/installation.md
Normal file
@@ -0,0 +1,23 @@
|
||||
---
|
||||
title: Installation
|
||||
order: 1
|
||||
---
|
||||
|
||||
# Installation
|
||||
|
||||
Expose can be installed using composer.
|
||||
The easiest way to install expose is by making it a global composer dependency:
|
||||
|
||||
```bash
|
||||
composer global require beyondcode/expose
|
||||
```
|
||||
|
||||
Now you're ready to go and can [share your first site](/getting-started/share-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.
|
||||
|
||||
If you want to modify expose, for example by adding custom request/response modifiers, you will need to clone the GitHub repository instead.
|
||||
|
||||
You can learn more about how to customize expose in the [extending Expose](/extending) documentation section.
|
||||
10
docs/getting-started/questions-issues.md
Normal file
10
docs/getting-started/questions-issues.md
Normal file
@@ -0,0 +1,10 @@
|
||||
---
|
||||
title: Questions & Issues
|
||||
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.
|
||||
|
||||
If you've found a bug regarding security please mail [marcel@beyondco.de](mailto:marcel@beyondco.de) instead of using the issue tracker.
|
||||
40
docs/getting-started/sharing-your-first-site.md
Normal file
40
docs/getting-started/sharing-your-first-site.md
Normal file
@@ -0,0 +1,40 @@
|
||||
---
|
||||
title: Share your first site
|
||||
order: 2
|
||||
---
|
||||
|
||||
# Share your first site
|
||||
|
||||
Once you have installed Expose, you are ready to go and share your local sites.
|
||||
|
||||
The easiest way to share your local sites is by going into the folder that you want to share and run `expose`:
|
||||
|
||||
```bash
|
||||
cd ~/Sites/my-awesome-project/
|
||||
|
||||
expose
|
||||
```
|
||||
|
||||
This will connect to the provided server at expose.dev and give you a tunnel that you can immediately start using.
|
||||
|
||||
To learn more about how you can share your local sites, check out the [sharing local sites](/docs/expose/client/sharing) documentation.
|
||||
|
||||
## Using the provided server at expose.dev
|
||||
|
||||
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.
|
||||
|
||||
This server is available free of charge for everyone, but makes use of Expose's [authentication token]() authorization method.
|
||||
|
||||
Therefore, in order to share your sites for the first time, you will need an authorization token.
|
||||
|
||||
You can obtain such a token by singing in to your [Beyond Code account](/login). If you do not yet have an account, you can [sign up and create an account](/register) for free.
|
||||
|
||||
## Authenticating with expose.dev
|
||||
|
||||
To register and use the given credentials, just run the following command:
|
||||
|
||||
```bash
|
||||
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.
|
||||
Reference in New Issue
Block a user