EveryDocs – simple self-hosted document management system

EveryDocs is a simple document management system aimed primarily at private and small-scale use.

The project separates the server-side EveryDocs Core from its web interface, with the core handling document storage, metadata, search, authentication and the REST API. Documents are centred around PDF files and can be supplied with descriptive metadata, assigned to folders and associated with people or processing states. Content extraction makes the PDFs searchable, while optional encrypted storage provides an alternative when protecting files at rest takes priority over content indexing.

This is free and open source software.

Key Features

• Uploads PDF documents together with a title, description and the date associated with the document.
• Organises documents into folders and nested subfolders.
• Associates documents with people and configurable processing states to provide additional organisational context.
• Extracts text from PDF files so their contents can participate in full-text searches.
• Searches document titles, descriptions and extracted text rather than relying solely on filenames.
• Supports encrypted PDF storage on disk for users who enable document encryption.
• Disables content extraction for encrypted documents so plaintext extracted content is not retained alongside protected files.
• Provides account creation and JSON Web Token based authentication.
• Exposes REST API operations covering documents, folders, people and processing states.
• Works with the separate EveryDocs Web project to provide a mobile-friendly browser interface.
• Uses a database-backed architecture with configurable database adapter, database name, credentials, host and port settings.
• Can be deployed with Docker Compose alongside its database and web interface.
• The document storage directory is configurable independently of the database.
• Administration can therefore use conventional database backup tools together with filesystem backups of the document store.
• Provides Rails route information for administrators and developers integrating software with the server.
• The web and server components are separated, allowing the core API to be used independently by alternative clients.
• Self-hosting keeps the document collection and its associated metadata under the administrator’s control.

Website: github.com/jonashellmann/everydocs-core
Support:
Developer: Jonas Hellmann
License: GNU General Public License v3.0

EveryDocs Core is written in Ruby. Learn Ruby with our recommended free books and free tutorials.

Related Software

Read our verdict in the software roundup.

Explore our carefully curated directory of recommended free and open source software, covering every major software category. The directory forms part of our extensive collection of articles for Linux enthusiasts. It includes hundreds of detailed reviews, together with free and open source alternatives to proprietary software from companies such as Google, Microsoft, Apple, Adobe, IBM, Cisco, Oracle, and Autodesk. LinuxLinks also covers interesting projects worth exploring, Linux-compatible hardware, free programming books and tutorials, and much more. Know a useful free and open source Linux application that we haven’t covered? Tell us about it using our submission form.