Skip to content

dsilva2401/files-bucket-server

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

18 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Files Bucket Server

Install

npm install files-bucket-server --save

Bucket Usage

var FileBucketServer = require('files-bucket-server');
var fBServer = new FileBucketServer('./path/to/files', { logsEnabled: true });

// Only allow local requests
fBServer.onlyAllowLocalRequests();

// Start server
fBServer.start().then(function (serverData) {
    console.log('Server is up at port: '+serverData.port);
});

Bucket API Usage

##== Ensure file is available ==##
# Request
GET => /api/ensure-file-is-available?
    url=http://example.com/url/to/my/file &
    timeout=300 # Timeout in seconds (optional)
# Response
{ available: false } # If not available
{ available: true, url: 'http://myhost/files/myfile' } # If available


##== List files ==##
# Request
GET => /api/files
# Response
[{..]]


##== Delete file ==##
# Request
DELETE => /api/files/:filename
# Response
{ removed: true } # Removed
{ removed: false } # Error Removing

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •