2018-01-04 15:23:55 +01:00
< h3 align = "center" >
2019-02-12 13:57:54 +01:00
< img src = "https://teedy.io/img/github-title.png" alt = "Teedy" width = 500 / >
2018-01-04 15:23:55 +01:00
< / h3 >
2013-08-18 16:21:54 +02:00
2018-01-04 15:23:55 +01:00
[](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
[](http://travis-ci.org/sismics/docs)
2013-08-18 16:21:54 +02:00
2019-02-12 13:57:54 +01:00
Teedy is an open source, lightweight document management system for individuals and businesses.
2013-08-18 16:21:54 +02:00
2018-01-04 15:23:55 +01:00
< hr / >
< h2 align = "center" >
2019-10-13 01:23:03 +02:00
✨ < a href = "https://github.com/users/jendib/sponsorship" > Sponsor this project if you use and appreciate it!< / a > ✨
2018-01-04 15:23:55 +01:00
< / h2 >
< hr / >
2013-08-18 16:21:54 +02:00
2019-02-12 13:57:54 +01:00
2018-02-02 17:28:23 +01:00
2017-11-21 23:56:32 +01:00
Demo
----
2019-02-12 13:57:54 +01:00
A demo is available at [demo.teedy.io ](https://demo.teedy.io )
2017-11-21 23:56:32 +01:00
- Guest login is enabled with read access on all documents
- "admin" login with "admin" password
- "demo" login with "password" password
2013-08-18 16:21:54 +02:00
Features
--------
- Responsive user interface
2013-09-23 13:36:58 +02:00
- Optical character recognition
2018-03-20 22:46:56 +01:00
- Support image, PDF, ODT, DOCX, PPTX files
2019-01-31 15:44:58 +01:00
- Video file support
2018-10-21 01:24:59 +02:00
- Flexible search engine with suggestions and highlighting
2016-03-22 14:21:10 +01:00
- Full text search in all supported files
2016-02-14 23:14:39 +01:00
- All [Dublin Core ](http://dublincore.org/ ) metadata
2019-05-21 15:55:41 +02:00
- Custom user-defined metadata 
2018-02-22 11:35:34 +01:00
- Workflow system 
2016-03-22 14:21:10 +01:00
- 256-bit AES encryption of stored files
2019-01-31 15:44:58 +01:00
- File versioning 
2016-03-22 14:21:10 +01:00
- Tag system with nesting
2019-01-31 15:44:58 +01:00
- Import document from email (EML format)
- Automatic inbox scanning and importing
2016-03-22 14:21:10 +01:00
- User/group permission system
2018-01-08 11:51:15 +01:00
- 2-factor authentication
2016-03-19 19:41:28 +01:00
- Hierarchical groups
2015-08-28 01:18:18 +02:00
- Audit log
2015-11-23 00:01:39 +01:00
- Comments
2015-11-30 00:12:29 +01:00
- Storage quota per user
2015-05-09 16:21:59 +02:00
- Document sharing by URL
2013-08-18 16:21:54 +02:00
- RESTful Web API
2019-01-31 15:44:58 +01:00
- Webhooks to trigger external service
2015-08-28 01:18:18 +02:00
- Fully featured Android client
2019-01-31 15:44:58 +01:00
- [Bulk files importer ](https://github.com/sismics/docs/tree/master/docs-importer ) (single or scan mode)
2018-04-01 21:00:26 +02:00
- Tested to one million documents
2013-08-18 16:21:54 +02:00
2017-04-25 11:09:18 +02:00
Install with Docker
-------------------
2019-05-20 15:18:08 +02:00
A preconfigured Docker image is available, including OCR and media conversion tools, listening on port 8080. The database is an embedded H2 database but PostgreSQL is also supported for more performance.
2018-03-14 14:53:41 +01:00
**The default admin password is "admin". Don't forget to change it before going to production.**
2019-05-20 15:18:08 +02:00
- Master branch, can be unstable. Not recommended for production use: `sismics/docs:latest`
2020-03-26 20:00:44 +01:00
- Latest stable version: `sismics/docs:v1.8`
2019-05-20 15:18:08 +02:00
The data directory is `/data` . Don't forget to mount a volume on it.
2017-04-25 11:09:18 +02:00
2019-05-20 15:18:08 +02:00
To build external URL, the server is expecting a `DOCS_BASE_URL` environment variable (for example https://teedy.mycompany.com)
2013-08-18 16:21:54 +02:00
2018-03-05 11:06:26 +01:00
Manual installation
-------------------
#### Requirements
2018-03-18 22:23:29 +01:00
- Java 8 with the [Java Cryptography Extension ](http://www.oracle.com/technetwork/java/javase/downloads/jce-7-download-432124.html )
- Tesseract 3 or 4 for OCR
2018-03-05 11:06:26 +01:00
- ffmpeg for video thumbnails
- mediainfo for video metadata extraction
- A webapp server like [Jetty ](http://eclipse.org/jetty/ ) or [Tomcat ](http://tomcat.apache.org/ )
#### 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.**
2019-02-12 13:57:54 +01:00
How to build Teedy from the sources
2013-09-06 11:18:30 +02:00
----------------------------------
2013-08-18 16:21:54 +02:00
2020-02-14 21:48:45 +01:00
Prerequisites: JDK 8 with JCE, Maven 3, NPM, Grunt, Tesseract 3 or 4
2013-08-18 16:21:54 +02:00
2019-02-12 13:57:54 +01:00
Teedy is organized in several Maven modules:
2013-08-18 16:21:54 +02:00
- 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
2016-05-05 22:43:18 +02:00
From the root directory:
2013-08-18 16:21:54 +02:00
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
2015-08-28 01:32:29 +02:00
You will get your deployable WAR in the `docs-web/target` directory.
2014-11-30 23:12:28 +01:00
2018-03-05 11:06:26 +01:00
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.
2014-11-30 23:12:28 +01:00
License
-------
2019-02-12 13:57:54 +01:00
Teedy is released under the terms of the GPL license. See `COPYING` for more
2014-11-30 23:12:28 +01:00
information or see < http: / / opensource . org / licenses / GPL-2 . 0 > .
