Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dockette/expose
🐳 Expose local sites via secure tunnels using Expose app written in PHP.
https://github.com/dockette/expose
dockette expose ngrok on-premise server tunnel tunneling
Last synced: 8 days ago
JSON representation
🐳 Expose local sites via secure tunnels using Expose app written in PHP.
- Host: GitHub
- URL: https://github.com/dockette/expose
- Owner: dockette
- License: mit
- Created: 2021-06-17T15:10:16.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2021-08-09T13:28:47.000Z (over 3 years ago)
- Last Synced: 2024-08-01T13:36:41.324Z (3 months ago)
- Topics: dockette, expose, ngrok, on-premise, server, tunnel, tunneling
- Language: PHP
- Homepage:
- Size: 13.7 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Dockette / Expose
Expose local sites via secure tunnels using Expose app written in PHP.
🕹 f3l1x.io | 💻 f3l1x | 🐦 @xf3l1x
-----
## Usage
### Server
Fastest way:
```
docker run \
-it \
--rm \
-p 80:80 \
-e EXPOSE_HOST=yourdomain.dev \
-e EXPOSE_PORT=80 \
dockette/expose
```
Persistent way:
```
docker run \
-it \
--rm \
-p 80:80 \
-v $(pwd)/data:/data
dockette/expose
```
### Client
```
docker run \
-it \
--rm \
--network=host \
-e EXPOSE_HOST=yourdomain.dev \
-e EXPOSE_PORT=80 \
dockette/expose \
share \
--subdomain=foo \
http://0.0.0.0:5000
```
> Use http://host.docker.internal:5000 on OSX.
## Documentation
You can easily setup Expose via environment variables. This is list of default values.
```
- EXPOSE_HOST=localhost # expose domain
- EXPOSE_PORT=8000 # expose port
- EXPOSE_USERNAME=dockette # dashboard user name
- EXPOSE_PASSWORD=expose # dashboard user password
- EXPOSE_TOKEN= # expose token
- EXPOSE_ADMIN=admin # dashboard subdomain
- EXPOSE_DB=/data/expose.db # expose database (for users)
```
For more details, take a look at Expose's [official documentation](https://expose.beyondco.de/docs/server/starting-the-server).
**How to test it?**
```
# Server
docker run -it --rm -p 8000:8000 -e EXPOSE_HOST=expose.local dockette/expose
```
```
echo "Hello world" >> index.php
# Application
php -S http://0.0.0.0:5000 index.php
```
```
# Tunnel (Unix)
docker run -it --rm --network=host -e EXPOSE_HOST=expose.local dockette/expose share --subdomain=foo http://0.0.0.0:5000
```
> Use http://host.docker.internal:5000 on OSX.
## Development
See [how to contribute](https://contributte.org/contributing.html) to this package.
This package is currently maintaining by these authors.
-----
Consider to [support](https://github.com/sponsors/f3l1x) **f3l1x**. Also thank you for using this package.