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

Discuss it on Product Hunt 🦄

---

✨ Sismics Docs is now called Teedy! You can still find our cloud and support offer on teedy.io ✨

---

Demo

A demo is available at demo.teedy.io

• Guest login is enabled with read access on all documents
• "admin" login with "admin" password
• "demo" login with "password" password

Features

• Responsive user interface
• Optical character recognition
• 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
• 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

Install with Docker

From a Docker host, run this command to download and install Teedy. The server will run on http://[your-docker-host-ip]:8100. The default admin password is "admin". Don't forget to change it before going to production.

docker run --rm --name teedy_latest -d -e DOCS_BASE_URL='http://[your-docker-host-ip]:8100' -p 8100:8080 -v teedy_latest:/data sismics/docs:latest

Note: You will need to change [your-docker-host-ip] with the IP address or FQDN of your docker host e.g.

FQDN: http://docs.mycompany.com
IP: http://192.168.100.10

Manual installation

Requirements

• Java 8 with the Java Cryptography Extension
• Tesseract 3 or 4 for OCR
• ffmpeg for video thumbnails
• mediainfo for video metadata extraction
• A webapp server like Jetty or Tomcat

Download

The latest release is downloadable here: https://github.com/sismics/docs/releases in WAR format. The default admin password is "admin". Don't forget to change it before going to production.

How to build Teedy from the sources

Prerequisites: JDK 8 with JCE, Maven 3, Tesseract 3 or 4

Teedy is organized in several Maven modules:

• docs-core
• docs-web
• docs-web-common

First off, clone the repository: git clone git://github.com/sismics/docs.git or download the sources from GitHub.

Launch the build

From the root directory:

mvn clean -DskipTests install

Run a stand-alone version

From the docs-web directory:

mvn jetty:run

Build a .war to deploy to your servlet container

From the docs-web directory:

mvn -Pprod -DskipTests clean install

You will get your deployable WAR in the docs-web/target directory.

Contributing

All contributions are more than welcomed. Contributions may close an issue, fix a bug (reported or not reported), improve the existing code, add new feature, and so on.

The master branch is the default and base branch for the project. It is used for development and all Pull Requests should go there.

Community

Get updates on Teedy's development and chat with the project maintainers:

• Follow @teedyio on Twitter
• Read and subscribe to The Official Teedy Blog
• Check the Official Website
• Join us on Facebook

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.