معرفی شرکت ها
expose-localhost-0.5
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشتر
تبلیغات ما
مشتریان به طور فزاینده ای آنلاین هستند. تبلیغات می تواند به آنها کمک کند تا کسب و کار شما را پیدا کنند.
مشاهده بیشترتوضیحات
Expose an app/api running on local host to public internet using AWS EC2
| ویژگی | مقدار |
|---|---|
| سیستم عامل | - |
| نام فایل | expose-localhost-0.5 |
| نام | expose-localhost |
| نسخه کتابخانه | 0.5 |
| نگهدارنده | [] |
| ایمیل نگهدارنده | [] |
| نویسنده | - |
| ایمیل نویسنده | Vignesh Sivanandha Rao <svignesh1793@gmail.com> |
| آدرس صفحه اصلی | - |
| آدرس اینترنتی | https://pypi.org/project/expose-localhost/ |
| مجوز | MIT License Copyright (c) 2021 Vignesh Sivanandha Rao Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
# Expose localhost using EC2
Expose an app/api running on local host to public internet using AWS EC2
### Requirements
- Access to an AWS account and [AWS CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html#getting-started-install-instructions) configured.
- A `service/app/api` running on a specific port that has to be exposed to public internet.
- **[Optional]** A domain `example.com` hosted on `route53`.
### Setup
#### Environment Variables:
Environment variables can be loaded from a `.env` file.
**Mandatory Arg:**
- `PORT`: Port number that has to be exposed (on which a localhost `service/app/api` is running)
**Optional Args:**
- `IMAGE_ID`: ID of any public AMI with an Ubuntu OS. Defaults to a region specific image ID.
- `AWS_ACCESS_KEY`: Access key to access AWS resources. Defaults to `~/.aws/config`
- `AWS_SECRET_KEY`: Secret key to access AWS resources. Defaults to `~/.aws/config`
- `AWS_REGION_NAME`: Region name where the instance should live. Defaults to `US-WEST-2`
*Optionally `.env` files can also be scanned for:*
```python
import expose
expose.load_env(scan=True)
```
<details>
<summary><strong>Setup a custom endpoint</strong></summary>
The public DNS names for EC2 instances are long and messy. To avoid that, an `A` record can be added to the `route53` hosted zone.
:warning: Requires an active hosted zone on `route53`.
- `DOMAIN`: If the domain name is registered using `route53`. *Example: `mywebsite.com`*
- `SUBDOMAIN`: Sub-domain that has to be added for the domain name. *Example: `tunnel.mywebsite.com`*
:bulb: This will be the endpoint to access the localhost.
</details>
#### Certificate:
- Securing the tunnel requires the certificate chain and the key file.
- These two files should be saved as `cert.pem` and `key.pem` in either `~.ssh/*.pem` or within `expose` repository.
- No certs? No problem. [`expose`](https://github.com/thevickypedia/expose/blob/main/expose/helpers/cert.py) will
generate a self-signed certificate and a private key automatically.
<details>
<summary><strong>Generate private SSL certificate</strong></summary>
Unfortunately not many SSL certificate providers give the liberty to download key files. But `expose`, can use private certificates.
:warning: Some web browsers might throw a warning and some might even block a self-signed certificate/private CA.
To manually generate a self-signed cert:
> `openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout ~/.ssh/key.pem -out ~/.ssh/cert.pem`
[OR]
Simply let `expose` create a self-signed SSL certificate and a private key.
- `EMAIL_ADDRESS`: Email address to create the self-signed SSL and private key. Defaults to `USER@expose-localhost.com`
- `ORGANIZATION`: Organization name for the certificate. Defaults to the AWS endpoint.
</details>
### Usage
###### Installation
```shell
python3 -m pip install expose-localhost
```
###### Start tunneling:
```python
import expose
tunnel = expose.Tunnel()
tunnel.start()
```
###### Stop tunneling:
```python
import expose
tunnel = expose.Tunnel()
tunnel.stop()
```
<details>
<summary><strong>Troubleshooting</strong></summary>
> If `E: Could not get lock /var/lib/dpkg/lock-frontend` occurs during startup, simply rerun the script with start command.
> This occurs when `apt` hasn't released the resources yet. Re-running `tunnel.start()` will simply re-configure the instance.
</details>
## Coding Standards
Docstring format: [`Google`](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings) <br>
Styling conventions: [`PEP 8`](https://www.python.org/dev/peps/pep-0008/) <br>
Clean code with pre-commit hooks: [`flake8`](https://flake8.pycqa.org/en/latest/) and
[`isort`](https://pycqa.github.io/isort/)
## [Release Notes](https://github.com/thevickypedia/expose/blob/main/release_notes.rst)
**Requirement**
```shell
python -m pip install changelog-generator
```
**Usage**
```shell
changelog reverse -f release_notes.rst -t 'Release Notes'
```
## Linting
`PreCommit` will ensure linting, and the doc creation are run on every commit.
**Requirement**
```shell
pip install sphinx==5.1.1 pre-commit recommonmark
```
**Usage**
```shell
pre-commit run --all-files
```
### Pypi Package
[](https://packaging.python.org/tutorials/packaging-projects/)
[https://pypi.org/project/expose-localhost/](https://pypi.org/project/expose-localhost/)
### Runbook
[](https://www.sphinx-doc.org/en/master/man/sphinx-autogen.html)
[https://thevickypedia.github.io/expose/](https://thevickypedia.github.io/expose/)
## License & copyright
© Vignesh Sivanandha Rao
Licensed under the [MIT License](https://github.com/thevickypedia/expose/blob/main/LICENSE)
نیازمندی
| مقدار | نام |
|---|---|
| >=1.20.24 | boto3 |
| >=1.23.24 | botocore |
| >=1.26.7 | urllib3 |
| >=0.19.2 | python-dotenv |
| >=2.8.1 | paramiko |
| >=8.0.3 | click |
| >=5.8.0 | psutil |
| >=2.26.0 | requests |
| >=21.0.0 | pyOpenSSL |
| >=0.14.2 | scp |
| - | pre-commit |
زبان مورد نیاز
| مقدار | نام |
|---|---|
| >=3 | Python |
نحوه نصب
نصب پکیج whl expose-localhost-0.5:
pip install expose-localhost-0.5.whl
نصب پکیج tar.gz expose-localhost-0.5:
pip install expose-localhost-0.5.tar.gz