Teedy is an open source, lightweight document management system for individuals and businesses.

Features

• Responsive user interface
• Optical character recognition
• LDAP authentication
• Support image, PDF, ODT, DOCX, PPTX files
• Video file support
• Flexible search engine with suggestions and highlighting
• Full text search in all supported files
• All Dublin Core metadata
• Custom user-defined metadata
• Workflow system
• 256-bit AES encryption of stored files
• File versioning
• Tag system with nesting
• Import document from email (EML format)
• Automatic inbox scanning and importing
• User/group permission system
• 2-factor authentication
• Hierarchical groups
• Audit log
• Comments
• Storage quota per user
• Document sharing by URL
• RESTful Web API
• Webhooks to trigger external service
• Fully featured Android client
• Bulk files importer (single or scan mode)
• Tested to one million documents

Native Installation

Requirements

Before building Teedy from source, you will need to install several prerequisites, including Java 11+, Maven 3+, NPM, Grunt, Tesseract 4, ffmpeg, and mediainfo. We give instructions for installing these prerequisites on several platforms below.

Linux (Ubuntu 22.04)

sudo apt install \
  default-jdk \
  ffmpeg \
  grunt \
  maven \
  npm \
  tesseract-ocr \
  tesseract-ocr-ara \
  tesseract-ocr-ces \
  tesseract-ocr-chi-sim \
  tesseract-ocr-chi-tra \
  tesseract-ocr-dan \
  tesseract-ocr-deu \
  tesseract-ocr-fin \
  tesseract-ocr-fra \
  tesseract-ocr-heb \
  tesseract-ocr-hin \
  tesseract-ocr-hun \
  tesseract-ocr-ita \
  tesseract-ocr-jpn \
  tesseract-ocr-kor \
  tesseract-ocr-lav \
  tesseract-ocr-nld \
  tesseract-ocr-nor \
  tesseract-ocr-pol \
  tesseract-ocr-por \
  tesseract-ocr-rus \
  tesseract-ocr-spa \
  tesseract-ocr-swe \
  tesseract-ocr-tha \
  tesseract-ocr-tur \
  tesseract-ocr-ukr \
  tesseract-ocr-vie

Mac

brew install \
  ffmpeg \
  grunt-cli \
  maven \
  mediainfo \
  npm \
  openjdk \
  tesseract \
  tesseract-lang

Windows

It is highly recommended that you proceed to install Windows Subsystem Linux (WSL), following the link: Install Linux on Windows with WSL . This will allow you to run a Linux distro (Ubuntu's the default) within the Windows environment, and you can then proceed to follow the Linux (Ubuntu 22.04) instructions to install the dependencies.

Note: This would mean that you should proceed to execute the following instructions within the Linux environment as well.

Installation Steps

Clone the repository to your local machine (git clone https://github.com/CMU-313/Teedy) and then use Maven to build Teedy from source by running the following command from the root directory:

mvn clean -DskipTests install

After successfully building Teedy from source, you can launch a Teedy instance by running the following commands from the root directory:

cd docs-web
mvn jetty:run

The default admin password is "admin". Don't forget to change it before going to production.

License

Teedy is released under the terms of the GPL license. See COPYING for more information or see http://opensource.org/licenses/GPL-2.0.