mirror of
https://github.com/bitinflow/expose.git
synced 2026-03-13 13:35:54 +00:00
47 lines
1.3 KiB
Markdown
47 lines
1.3 KiB
Markdown
---
|
||
title: Installation
|
||
order: 1
|
||
---
|
||
|
||
# Installation
|
||
|
||
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
|
||
```
|
||
|
||
After that, you are ready to go and can [share your first site](/docs/expose/getting-started/sharing-your-first-site).
|
||
|
||
## As a docker container
|
||
|
||
Expose has a `Dockerfile` in the root of the source that you can build and use without any extra effort.
|
||
|
||
```bash
|
||
docker build -t expose .
|
||
```
|
||
|
||
Usage:
|
||
|
||
```bash
|
||
docker run expose <expose command>
|
||
```
|
||
|
||
Examples:
|
||
|
||
```bash
|
||
docker run expose share http://192.168.2.100 # share a local site
|
||
docker run expose serve my-domain.com # start a server
|
||
```
|
||
|
||
Now you're 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 Expose features out of the box – without any additional setup required.
|
||
|
||
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 the customization of Expose in the [extending Expose](/docs/expose/extending-the-server/subdomain-generator) documentation section.
|