|
1 | 1 | # Pterodactyl SFTP Server
|
2 |
| -This package serves as a SFTP server to run alongside the [Pterodactyl Daemon](https://github.com/pterodactyl/daemon). |
3 |
| -It is not designed to run stand-alone on your system. |
4 |
| - |
5 |
| -## Why? |
6 |
| -Previously we made use of Node.js to handle running our SFTP server for the Daemon. While this worked, and has allowed us |
7 |
| -to provide more advanced permissions and keep things off the host OS, it has also lead to many issues. Most notably has |
8 |
| -been extremely poor performance when trying to work with directories containing hundreds or thousands of files. In addition, |
9 |
| -this poor performance has also caused bottlenecking in the application when it comes to managing servers. |
10 |
| - |
11 |
| -Our goal with the introduction of this standalone server is to provide a lean, performant, fully-featured SFTP server |
12 |
| -that will hold up the the demands placed upon it. |
13 |
| - |
14 |
| -## Running |
15 |
| -To run this program in a standalone mode (rather than booted by the Daemon), use the arguments below. |
16 |
| - |
17 |
| -``` |
18 |
| -./sftp-server [--config-path] [--port] [--bind-addr] [--readonly] [--disable-disk-check] [--debug] |
19 |
| -``` |
20 |
| - |
21 |
| -### Flags |
22 |
| -``` |
23 |
| -flag default help |
24 |
| ---config-path ./config/core.json This flag defines the location of the Daemon configuration file which |
25 |
| - is read to help determine some internal settings. |
26 |
| -
|
27 |
| ---port 2022 The port for the SFTP server. |
28 |
| -
|
29 |
| ---bind-addr 0.0.0.0 The bind address for the SFTP server. |
30 |
| -
|
31 |
| ---readonly false If provided, the server will run in a read-only state that denies anyone, |
32 |
| - regardless of permission, from writing or modifying files. |
33 |
| -
|
34 |
| ---disable-disk-check false If passed, disk space usage will be disabled. |
35 |
| -
|
36 |
| ---debug false If passed, the server will run in debug mode which can be useful for printing |
37 |
| - stacktraces and additional connection and error information. |
38 |
| -``` |
| 2 | +This package serves as a SFTP server to run alongside the [Pterodactyl Daemon](https://github.com/pterodactyl/wings). |
| 3 | +Previous versions of this software included a standalone mode, however this repository now |
| 4 | +serves to provide API level access to the Wings Daemon for SFTP access. |
39 | 5 |
|
40 | 6 | ## License
|
41 |
| -Like all of our software, this server is provided under the MIT license. |
42 |
| - |
43 | 7 | ```
|
44 |
| -Copyright (c) 2018 Dane Everitt <[email protected]> |
| 8 | +Copyright (c) 2019 Dane Everitt <[email protected]> |
45 | 9 |
|
46 | 10 | Permission is hereby granted, free of charge, to any person obtaining a copy
|
47 | 11 | of this software and associated documentation files (the "Software"), to deal
|
|
0 commit comments