Skip to content
This repository was archived by the owner on Feb 25, 2021. It is now read-only.

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
DaneEveritt committed Oct 27, 2018
1 parent 8273911 commit c2a1ae9
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 2 deletions.
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2018 Pterodactyl
Copyright (c) 2018 Dane Everitt <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
38 changes: 37 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,37 @@
# sftp-server
# Pterodactyl SFTP Server
This package serves as a SFTP server to run alongside the [Pterodactyl Daemon](https://github.com/pterodactyl/daemon).
It is not designed to run stand-alone on your system.

## Why?
Previously we made use of Nodejs to handle running our SFTP server for the Daemon. While this worked, and has allowed us
to provide more advanced permissions and keep things off the host OS, it has also lead to many issues. Most notably has
been extremely poor performance when trying to work with directories containing hundreds or thousands of files. In addition,
this poor performance has also caused bottlenecking in the application when it comes to managing servers.

Our goal with the introduction of this standalone server is to provide a lean, performant, fully-featured SFTP server
that will hold up the the demands placed upon it.

## License
Like all of our software, this server is provided under the MIT license.

```
Copyright (c) 2018 Dane Everitt <[email protected]>
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.
```
Binary file removed sftp-server
Binary file not shown.

0 comments on commit c2a1ae9

Please sign in to comment.