https://github.com/ryanleecode/basic-sftp-server
Basic Secure File Transfer Protocol Server
https://github.com/ryanleecode/basic-sftp-server
sftp sftp-server typescript
Last synced: 12 months ago
JSON representation
Basic Secure File Transfer Protocol Server
- Host: GitHub
- URL: https://github.com/ryanleecode/basic-sftp-server
- Owner: ryanleecode
- Created: 2018-09-28T03:57:35.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-10-07T03:22:37.000Z (over 7 years ago)
- Last Synced: 2025-02-24T13:23:30.907Z (over 1 year ago)
- Topics: sftp, sftp-server, typescript
- Language: TypeScript
- Homepage:
- Size: 28.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Node SFTP Server
This is a very basic implementation of an Secure File Transfer Protocol (SFTP) server. You can interact with it using your favourite SFTP application.
Some applications include [WinSCP](https://winscp.net/eng/download.php).
## Setup
Add a `.env` file to your root directory.
Paste these contents
```
USERNAME=
PASSWORD=
```
Put in the respective username and password credentials for the server.
### Generate an RSA-Key file
Use Puttygen or a similar tool to generate a rsa-key file. A sample is file is provided [here](ssh_host_rsa_key_sample).
The file you generate should be named `ssh_host_rsa_key` and placed under your root directory.
### Installing
```
npm install
```
## Running
```
npm run dev
```
Connect to the SFTP server using any SFTP client on port **3001**.