Skip to content

Commit

Permalink
Improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ysdragon committed Dec 17, 2024
1 parent 847b327 commit bebff06
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ A powerful and lightweight Virtual Private Server (VPS) egg for Pterodactyl Pane
- 🖥️ Wide range of operating systems
- 🔌 Multiple port support (TCP/UDP)
- Dynamic port mapping
- 🚀 SSH
- 🚀 Custom SSH server

## 🏗️ Supported Architectures

Expand Down Expand Up @@ -75,10 +75,10 @@ A powerful and lightweight Virtual Private Server (VPS) egg for Pterodactyl Pane

# How to use SSH?

**Install the Custom SSH Server**:
#### Install the Custom SSH Server:
- After installing the desired distro, use the `install-ssh` command to install our custom SSH server.

### Configuration Options
#### Configuration Options

The configuration file is located at `/.ssh_config` and supports the following options:

Expand All @@ -88,6 +88,18 @@ The configuration file is located at `/.ssh_config` and supports the following o
- `SSH_TIMEOUT`: The timeout duration in seconds for SSH connections. Leave it empty or set it to `0` to disable the timeout.
- `SFTP_ENABLE`: Enable or disable SFTP. Set to `true` to enable SFTP.

#### Example `/.ssh_config` Configuration

Here is an example configuration file:

```ini
SSH_PORT=50000
SSH_USER=user
SSH_PASSWORD=123123
SSH_TIMEOUT=0
SFTP_ENABLE=true
```

## Contributing

Contributions are welcome. If you have any suggestions, improvements, or bug fixes, feel free to submit a pull request.
Expand Down

0 comments on commit bebff06

Please sign in to comment.