Skip to content

๐Ÿ”˜ FTP Seer API : A backend server for browsing FTP directory

Notifications You must be signed in to change notification settings

m3yevn/ftp-seer-api

Repository files navigation

FTP Seer - A Backend for browsing FTP directory ๐Ÿ“ฆ

by m3yevn and team

This API server is used to accept host,port,path,username and password to
connect FTP server and send back directory data.

Read this in Simplified Chinese - ็œ‹็ฎ€ไฝ“ไธญๆ–‡็‰ˆๆœฌ README.zh-cn

Run on Repl.it

๐Ÿณ Docker Public Repository

FTP Seer API server is available as docker image also. Run this docker command to get it up and running. Docker CLI must be installed beforehand.

Run on Docker

$ docker pull m3yevn/ftp-seer:latest
$ docker run -d --name ftp-seer -p 5050:5050  m3yevn/ftp-seer:latest

Now, FTP Seer is accessible at 5050 port of your workstation.

๐Ÿ“ฎ Request Query Params

  • 1๏ธโƒฃ Hostname
  • 2๏ธโƒฃ Port
  • 3๏ธโƒฃ Path
  • 4๏ธโƒฃ Username
  • 5๏ธโƒฃ Password

๐Ÿ“ง Sample Request

**"\directory?host=sample&port=21&path=sample&username=sample&password=sample"**
**"\file?host=sample&port=21&path=sample/sample.txt&username=sample&password=sample"**

โšก Try it on demo

  • Visit this demo
  • The demo uses speedtest.tele2.net for testing

โœ‰๏ธ HTTP Methods

Method Route Description
GET "/" Getting API health
GET "/directory" Listing directory of FTP server
GET "/file" Getting content of a file in FTP server

๐Ÿ“š Tech Stack

  • NodeJS
  • Express Framework
  • JS FTP
  • JSON

โค๏ธ Run this code with

$ npm install
$ node server.js

About

๐Ÿ”˜ FTP Seer API : A backend server for browsing FTP directory

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published