{"id":15772566,"url":"https://github.com/capmousse/archiver","last_synced_at":"2025-03-31T12:15:53.794Z","repository":{"id":141733977,"uuid":"50023655","full_name":"CapMousse/Archiver","owner":"CapMousse","description":"An utility to eradicate paper","archived":false,"fork":false,"pushed_at":"2016-02-26T12:37:55.000Z","size":27,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-05T15:40:46.648Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/CapMousse.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2016-01-20T10:44:44.000Z","updated_at":"2016-02-10T08:39:04.000Z","dependencies_parsed_at":null,"dependency_job_id":"430b4600-db9d-4d87-aede-290277aedb1b","html_url":"https://github.com/CapMousse/Archiver","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CapMousse%2FArchiver","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CapMousse%2FArchiver/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CapMousse%2FArchiver/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CapMousse%2FArchiver/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CapMousse","download_url":"https://codeload.github.com/CapMousse/Archiver/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246465250,"owners_count":20781919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-04T15:40:40.617Z","updated_at":"2025-03-31T12:15:53.775Z","avatar_url":"https://github.com/CapMousse.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Archiver\n\n*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.\n\n![Archiver](http://img.shwaark.com/uploads/big/14564901958863.png)\n\n## Warning\n\n**This project is not responsible for any data/paper loss.**\n**This project was made only to be used on *local* network, like on a NAS, and doesn't integrate any security (for the moment)**\n\n\n## Requirements\n- Nodejs \u003e= 4\n- Mongodb\n- Tesseract (tesseract-ocr on apt)\n- ImageMagick\n\n## Installation\nClone the current repository and install all requirements. Then run :\n\n```\nnpm install\n```\n\n## Configuration\n\nCopy the `config.example.js` as `config.js`, then in the `config.js` file :\n- Set `port` to the port you want to use for the web interface\n- Set `rootUrl` for the absolute url from root. Usefull when behind an alias. Default to `/`\n- Set `scanDir` to the directory where you will send new file to scan\n- Set `archiveDir` to the directory where you want *Archiver* to store all your files\n\nAll dir can be absolutes\n\n## Launch\n\n- `npm run watch` to launch the document scanner\n- `npm start` to launch the web interface\n\nIf you want to automaticaly launch thoses at start, you can use `crontab` (`sudo crontab -e`):\n```\n@reboot /dir/to/archiver npm run watch\n@reboot /dir/to/archiver npm start\n```\n\n## How it work\n\nDrop 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.\n\nGo to `http://server-address:8000` to see all your files.\n\nYou 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 :\n- `content:anything in the content`\n- `name:anything in the title`\n- `tags:list,of,tags`\n- `content:all at name:the same tags:time`\n\nYou can also define tags to be added automatically on file add or manually scan all files. Tag filters can be literal string or RegExp.\n**Warning:** manually scan all files for tags can take time !\n\n## Read Only\n\nIf 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.\nThis will prevent you (or other people) to delete files, tags...\n\nOn nginx, add `proxy_set_header X-Read-Only true;` to your configuration.\n\n**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)\n\n* * *\n\nThis project is inspired from [paperless](https://github.com/danielquinn/paperless) from [@danielquinn](https://github.com/danielquinn)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcapmousse%2Farchiver","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcapmousse%2Farchiver","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcapmousse%2Farchiver/lists"}