Filebin is a web application that facilitates convenient file sharing over the web. This is the development branch of the next release that in the future will power http://filebin.net.
- Responsive and mobile friendly web interface.
- All functionality available through an HTTP API.
- Upload files using drag and drop, select files from a dialog box or use cURL (examples below)
- Large file support. 10 GB file upload has been tested, but it should work fine with larger files as well.
- Archive (zip) download to make it easy to download multiple files in one go.
- Files expire automatically after a configurable period of time.
- Files and entire tags can be deleted manually.
- Thumbnails are displayed for image files.
- Album view is available in tags with images. Images are sorted based on the Exif DateTime timestamps.
- Triggers are capable of calling external scripts on certain events. One potential use case is to notify virus/malware scanners on file upload.
- No external dependencies once built.
- Cache invalidation support.
To build Filebin, a Golang build environment and some Golang packages are needed. The build procedure will produce a statically linked binary that doesn't require any external dependencies to run. It even comes with its own web server bundled.
It is recommended but not required to run it behind a TLS/SSL proxy such as Hitch and web cache such as Varnish Cache. Example configurations for these are provided.
Install Golang:
$ sudo yum/apt-get/brew install golangCreate the Go workspace and set the GOPATH environment variable:
$ mkdir ${HOME}/go
$ cd ${HOME}/go
$ mkdir src bin pkg
$ export GOPATH="${HOME}/go"
$ export PATH="${PATH}:${GOPATH}/bin"Download and install Filebin:
$ go get -d github.com/espebra/filebin
$ cd ${GOPATH}/src/github.com/espebra/filebin
$ make get-deps
$ make installThe binary is created as ${GOPATH}/bin/filebin, which can be executed immediately. The --version argument prints the build time and the git commit hash used in the build.
$ ${GOPATH}/bin/filebin --version
Git Commit Hash: 40bd401ec350c86a46cdb3dc87f6b70c3c0b796b
UTC Build Time: 2015-11-11 23:01:35Create the directories to use for storing files, logs and temporary files:
$ mkdir ~/filebin ~/filebin/files ~/filebin/logs ~/filebin/tempConfiguration is done using command line arguments when starting filebin. The built in help text will show the various arguments available:
$ ${GOPATH}/bin/filebin --helpSome arguments commonly used to start filebin are:
$ ${GOPATH}/bin/filebin \
--host 0.0.0.0 --port 31337
--baseurl http://api.example.com:31337
--filedir ~/filebin/files \
--tempdir ~/filebin/temp \
--expiration 604800
--cache-invalidation
[...]By default it will listen on 127.0.0.1:31337.
The following are elaborations on some of the command line arguments.
The --baseurl parameter is used when building HATEOAS links in the JSON responses and to generate the correct hyperlinks in the HTML responses. If --baseurl is wrong, the required css and javascript resources will not load properly.
An example when having a TLS/SSL proxy in front on port 443 would be --baseurl https://filebin.example.com.
It is also possible to run filebin from a subdirectory if specifying this accordingly with for example --baseurl https://www.example.com/filebin.
A trailing slash is not needed.
Tags expire after some time of inactivity. By default, tags will expire 3 months after the most recent file was uploaded. It is not possible to download files or upload more files to tags that are expired.
--expiration 86400 will expire tags 24 hours after the last file has been uploaded.
Enabled with the parameter --cache-invalidation. When enabled, HTTP PURGE requests will be sent to baseurl/path for every change to ensure content is invalidated on any frontend web cache.
Triggers enable external scripts to be executed at certain events.
The parameter --trigger-new-tag <command> makes sure <command> <tag> is executed whenever a new tag is being created. The execution is non-blocking. Example:
--trigger-new-tag /usr/local/bin/new-tag will execute /usr/local/bin/new-tag <tagid>.
The parameter --trigger-upload-file <command> makes sure <command> <tag> <filename> is executed whenever a new file is uploaded. The execution is non-blocking. Example:
--trigger-upload-file /usr/local/bin/upload-file will execute /usr/local/bin/upload-file <tagid> <filename>.
The parameter --trigger-delete-tag <command> makes sure <command> <tag> is executed whenever a tag is deleted. The execution is non-blocking. Example:
--trigger-delete-tag /usr/local/bin/delete-tag will execute /usr/local/bin/delete-tag <tagid>.
The parameter --trigger-delete-file <command> makes sure <command> <tag> <filename> is executed whenever a file is deleted. The execution is non-blocking. Example:
--trigger-delete-file /usr/local/bin/delete-file will execute /usr/local/bin/delete-file <tagid> <filename>.
| Value | |
|---|---|
| Method | POST |
| URL | / |
| URL parameters | None |
| Request body | File content in binary form |
| Success response | 201 |
| Error response | 400 |
In all examples, the local file /path/to/some file will be uploaded.
Using the following command, the tag will be automatically generated and the filename will be set to the SHA256 checksum of the content. The checksum of the content will not be verified.
$ curl --data-binary "@/path/to/some file" https://filebin.example.com/Using the following command, tag will be set to customtag and filename will be set to myfile.
$ curl --data-binary "@/path/to/some file" https://filebin.example.com/ \
-H "tag: customtag" -H "filename: myfile"Using the following command, filebin will verify the checksum of the uploaded file and discard the upload if the checksum does not match the specified checksum:
$ curl --data-binary "@/path/to/some file" https://filebin.example.com/ \
-H "tag: customtag" -H "filename: myfile" \
-H "content-sha256: 82b5f1d5d38641752d6cbb4b80f3ccae502973f8b77f1c712bd68d5324e67e33"| Value | |
|---|---|
| Method | GET |
| Request headers | content-type: application/json |
| URL | /:tag |
| URL parameters | None |
| Success response | 200 |
| Error response | 404 |
The following command will print a JSON structure showing which files that available in the tag customtag.
$ curl https://filebin.example.com/customtag| Value | |
|---|---|
| Method | GET |
| Request headers | content-type: application/zip |
| URL | /:tag |
| URL parameters | o=zip |
| Success response | 200 |
| Error response | 404 |
The following commands will download the files in customtag as a zip archive:
$ curl https://filebin.example.com/customtag?o=zip
$ curl -H "content-type: application/zip" https://filebin.example.com/customtag| Value | |
|---|---|
| Method | GET |
| URL | /:tag/:filename |
| URL parameters | None |
| Success response | 200 |
| Error response | 404 |
Downloading a file is as easy as specifying the tag and the filename in the request URI:
$ curl https://filebin.example.com/customtag/myfile| Value | |
|---|---|
| Method | DELETE |
| URL | /:tag/:filename |
| URL parameters | None |
| Success response | 200 |
| Error response | 404 |
| Value | |
|---|---|
| Method | DELETE |
| URL | /:tag |
| URL parameters | None |
| Success response | 200 |
| Error response | 404 |
$ curl -X DELETE https://filebin.example.com/customtag/myfileLogs are written to stdout, and can easily be redirected to for example syslog when using the systemd service script provided.
Filebin does currently not use any other database than the filesystem itself.
There is a pre-commit hook available in the repository that will make sure that commited go source code is properly formatted. Enable it with a symlink:
$ ln -s tools/git/pre-commit .git/hooks/pre-commit- Automatically clean up expired tags.
- Avoid reuse of expired tags.
- Administrator dashboard.
- Trigger cache invalidation on tag expiration.