diegocouto/authenticity

A lightweight application to guarantee files authenticity.

Authenticity

A lightweight application to guarantee files authenticity.

It acts like a central repository of files, which can be uploaded only from valid sources through its API and are available publicly when the correct file key is used.

Follow me on Twitter.

Getting Started

Before installing, it's recommended that you be sure that you have at least Node.js v0.12.

Install

1. Clone this repo into your local environment.
2. Run npm install from the app directory.
3. To execute the tests, run make test.
4. node bin/www

Configurations

Default options (config/default.json):

{
  "File": {
    "multer": {
      "dest": "uploads/",
      "limits": {
        "fileSize": 10485760
      }
    },
    
    "types": ["application/pdf", "image/jpeg", "image/png", "image/tiff"]
  }
}

API Usage

Creating a new file

POST: /api/v1/files

Parameters	Type	Required
token_key	string	true
file_key	string	true
file	file	true
description	text	false

Requesting file info

GET: /api/v1/files/:file_key

{
    "id": 1,
    "description": null,
    "key": "file_key",
    "path": "path/to/the/file.pdf",
    "md5Digest": "0acda6a8d205ba80edfc8e8d92044aba",
    "sha1Digest": "e292f0b08df083e13c444f43c5d4efa0a3ad1712",
    "createdAt": "2015-09-16T20:24:01.366Z",
    "updatedAt": "2015-09-16T20:24:01.366Z"
}

License

Authenticity is MIT licensed. Enjoy!

authenticity's Issues

README Images.