Updated Home (markdown)

dharm pimsen 2024-04-19 15:22:32 +07:00
parent bce873ffae
commit 5f52552e7a

29
Home.md

@ -6,6 +6,9 @@ This project is part from [damp11113-library](https://github.com/damp11113/damp1
This Server use port **2222** for default port
> [!WARNING]
> For use in product please **generate new private key**! If you still use this demo private key maybe your product getting **hacked**! up to 90%. Please don't use this demo private key for real product.
# Install
Install from pypi
```bash
@ -15,8 +18,6 @@ Install from github
```bash
pip install git+https://github.com/damp11113/PyserSSH.git
```
## Optional Packages
- [damp11113-library](https://github.com/damp11113/damp11113-library)
# Quick Example
```py
@ -42,11 +43,25 @@ If you input `hello` the response is `world`
# Demo
https://github.com/damp11113/PyserSSH/assets/64675096/49bef3e2-3b15-4b64-b88e-3ca84a955de7
See [server.py](https://github.com/damp11113/PyserSSH/blob/main/demo/server.py)
For run this demo you can use this command
```
$ python -m PyserSSH
```
then
```
Do you want to run demo? (y/n): y
```
But if no [damp11113-library](https://github.com/damp11113/damp11113-library)
```
No 'damp11113-library'
This demo is require 'damp11113-library' for run
```
you need to install [damp11113-library](https://github.com/damp11113/damp11113-library) for run this demo by choose `y` or `yes` in lowercase or uppercase
```
Do you want to install 'damp11113-library'? (y/n): y
```
For exit demo you can use `ctrl+c` or use `shutdown now` in PyserSSH shell **(not in real terminal)**
I intend to leaked private key because that key i generated new. I recommend to generate new key if you want to use on your host because that key is for demo only.
why i talk about this? because when i push private key into this repo in next 5 min++ i getting new email from GitGuardian. in that email say "
GitGuardian has detected the following RSA Private Key exposed within your GitHub account" i dont knows what is GitGuardian and i not install this app into my account.
GitGuardian has detected the following RSA Private Key exposed within your GitHub account" i dont knows what is GitGuardian and i not install this app into my account.