Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/capmousse/archiver
An utility to eradicate paper
https://github.com/capmousse/archiver
Last synced: about 1 month ago
JSON representation
An utility to eradicate paper
- Host: GitHub
- URL: https://github.com/capmousse/archiver
- Owner: CapMousse
- License: other
- Created: 2016-01-20T10:44:44.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-02-26T12:37:55.000Z (almost 9 years ago)
- Last Synced: 2024-10-05T15:40:46.648Z (4 months ago)
- Language: JavaScript
- Homepage:
- Size: 26.4 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Archiver
*Archiver* is a tool to eradicate paper with minimal setup. It can store and search on your documents like bills, taxes, fines, loan ... or any PDF.
## Warning
**This project is not responsible for any data/paper loss.**
**This project was made only to be used on *local* network, like on a NAS, and doesn't integrate any security (for the moment)**
## Requirements
- Nodejs >= 4
- Mongodb
- Tesseract (tesseract-ocr on apt)
- ImageMagick
## Installation
Clone the current repository and install all requirements. Then run :
```
npm install
```
## Configuration
Copy the `config.example.js` as `config.js`, then in the `config.js` file :
- Set `port` to the port you want to use for the web interface
- Set `rootUrl` for the absolute url from root. Usefull when behind an alias. Default to `/`
- Set `scanDir` to the directory where you will send new file to scan
- Set `archiveDir` to the directory where you want *Archiver* to store all your files
All dir can be absolutes
## Launch
- `npm run watch` to launch the document scanner
- `npm start` to launch the web interface
If you want to automaticaly launch thoses at start, you can use `crontab` (`sudo crontab -e`):
```
@reboot /dir/to/archiver npm run watch
@reboot /dir/to/archiver npm start
```
## How it work
Drop any PDF file in you `scanDir` directory and wait some time for the watcher to index and move the file in the `archiveDir`. It can take some time, depending of the file size.
Go to `http://server-address:8000` to see all your files.
You can search in all files content and name with the search form in the header. But you also can use filters to improve search results :
- `content:anything in the content`
- `name:anything in the title`
- `tags:list,of,tags`
- `content:all at name:the same tags:time`
You can also define tags to be added automatically on file add or manually scan all files. Tag filters can be literal string or RegExp.
**Warning:** manually scan all files for tags can take time !
## Read Only
If you want to access Archiver on your personnal server from internet, you can add the `X-Read-Only` header to the proxy request to enable read only mode.
This will prevent you (or other people) to delete files, tags...
On nginx, add `proxy_set_header X-Read-Only true;` to your configuration.
**Note:** if you put Archiver on the web, don't forget to protect it with a [basic auth](https://en.wikipedia.org/wiki/Basic_access_authentication)
* * *
This project is inspired from [paperless](https://github.com/danielquinn/paperless) from [@danielquinn](https://github.com/danielquinn)