fstp ·

File System Transfer Protocol - File System CRUD server (over HTTP)

This "NPX ready" executable will serve any file system location as a web api supporting CRUD operations.

• GET - Get file or directory (directory can be retrieved in html as well as json form to be shown on the browser, based on Accept header)
• POST - Create a directory (recursive)
• PUT - Create a file or update
• PATCH - Rename (/ Move) a path (using a "to" query string)
• DELETE - Delete a file or directory ("recursive" (rm -rf) is optional)

Usage

There are 2 options:

• Installing globally, using npm i -g fstp. Then you can use fstp in any directory to start the server there.
• Running using npx fstp (This will run the application without actually installing it).

--help

fstp [path]
    
    Run the server
    
    Options:
          --version   Show version number                                  [boolean]
      -p, --port      Port to listen on                     [number] [default: 8210]
      -h, --host      Host to listen on              [string] [default: "127.0.0.1"]
      -r, --readonly  Read only file system (allow only GET operations)
                                                          [boolean] [default: false]
      -v, --verbose   Verbose logging                     [boolean] [default: false]
      -f, --prefix    Path prefix (e.g. /some-route)          [string] [default: ""]
      -c, --cors      Whether to allow CORS                [boolean] [default: true]
      -a, --auth      Authentication scheme. For basic, provide --user with
                      username:password string. For bearer, either provide --token
                      or one will be generated randomly on startup.
                            [choices: "none", "bearer", "basic"] [default: "bearer"]
      -d, --hidden    Allow hidden files                  [boolean] [default: false]
      -t, --token     Specify a token for bearer authentication (if not specified, a
                      random token will be generated)                       [string]
      -u, --user      Specify a username and password for basic authentication (i.e.
                      alice:Passw0rd)                                       [string]
          --help      Show help                                            [boolean]

Security

There are 3 types of authentication schemes: (set with -a/--auth)

• none - No authentication needed
• basic - Basic authentication (username and password). Specified with -u/--user as <username>:<password> string. Authorization header should have the format of Basic <BASE64_ENCODED_USER_PASS>.
• bearer [default] - A token. Specified with -t/--token or generated randomly on startup. Authorization header should have the format of Bearer <TOKEN>.

Using none or basic also allows to use a browser.

Examples

Read file

1curl localhost:8210/some-dir/some-file.txt
2curl localhost:8210/some-dir/some-file.txt?tail
3curl localhost:8210/some-dir/some-file.txt?tail=20

Response is the file's content

• Content-Type will contain the MIME-Type as and if detected by mime.
• Last-Modified will hold the date of last modification time on file system.

Query parameters -tail - If specified, only the last N lines will be returned (default is 10) (Only 'text/' and 'application/' mime-types are supported).

Read directory

1curl localhost:8210/some-dir
2curl localhost:8210/some-dir -H "Accept: application/json"

• JSON response is an object containing a result which is FstpFileDescriptor[]:

1interface FstpFileDescriptor {
2  /** file / dir name */
3  name: string;
4  /** Whether is a directory */
5  dir: boolean,
6  /** Size of file in bytes */
7  size: Number,
8  /** Date in ISO format */
9  mtime:  string;
10  /** Mime type */
11  mime: string;
12}

Create a directory

1curl -X POST localhost:8210/some-dir/new-dir
2curl -X POST localhost:8210/some-dir/non-existing-dir/nested-dir

• In both cases the dir will be created (recursive by default)

Create or update a file

1# Specify content in data
2curl -X PUT localhost:8210/some-dir/new-file.txt -d "This is the content"
3# Get data from file
4curl -X PUT localhost:8210/some-dir/new-file.txt --data-binary @local-file.txt
5# Get data from stdin
6cat local-file.txt | curl -X PUT localhost:8210/some-dir/new-file.txt --data-binary @-

• If file exists it will be overwritten
• Directories will not be created in the process, if not exists it will fail.

Rename (/ Move) a path

1curl -X PATCH "localhost:8210/some-dir/some-file.txt?to=/some-dir/new-name.txt"

Delete a file or directory

1curl -X DELETE localhost:8210/some-dir/some-file.txt
2curl -X DELETE localhost:8210/some-dir/some-nested-dir
3curl -X DELETE "localhost:8210/some-dir?recursive"

License

fstp is MIT Licensed