docs/README.md

82 lines
1.9 KiB
Markdown
Raw Normal View History

2013-08-18 16:21:54 +02:00
Sismics Docs
============
2014-11-30 23:12:28 +01:00
_Web interface_
![Web interface](http://sismics.com/docs/screenshot1.png)
_Android application_
2014-11-30 23:13:08 +01:00
![Android documents list](http://sismics.com/docs/android1.png) ![Android navigation](http://sismics.com/docs/android2.png) ![Android document details](http://sismics.com/docs/android3.png)
2013-08-18 16:21:54 +02:00
What is Docs?
---------------
Docs is an open source, lightweight document management system.
Docs is written in Java, and may be run on any operating system with Java support.
Features
--------
- Responsive user interface
2013-09-23 13:36:58 +02:00
- Optical character recognition
2013-08-18 16:21:54 +02:00
- Support image and PDF files
- Flexible search engine
- Full text search in image and PDF
2013-09-23 13:36:58 +02:00
- SHA-256 encryption
2013-08-18 16:21:54 +02:00
- Tag system
2015-05-09 16:21:59 +02:00
- Multi-users ACL system
2015-08-28 01:18:18 +02:00
- Audit log
2015-05-09 16:21:59 +02:00
- Document sharing by URL
2013-08-18 16:21:54 +02:00
- RESTful Web API
2015-08-28 01:18:18 +02:00
- Fully featured Android client
2013-08-18 16:21:54 +02:00
2014-11-30 23:12:28 +01:00
Download
--------
2013-08-18 16:21:54 +02:00
2014-11-30 23:12:28 +01:00
The latest release is downloadable here: <https://github.com/sismics/docs/releases> in WAR format.
You will need a Java webapp server to run it, like [Jetty](http://eclipse.org/jetty/) or [Tomcat](http://tomcat.apache.org/)
2013-08-18 16:21:54 +02:00
How to build Docs from the sources
2013-09-06 11:18:30 +02:00
----------------------------------
2013-08-18 16:21:54 +02:00
2015-03-27 00:57:40 +01:00
Prerequisites: JDK 7 with JCE, Maven 3, Tesseract 3.02
2013-08-18 16:21:54 +02:00
Docs is organized in several Maven modules:
- docs-parent
- 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 `docs-parent` directory:
2013-08-18 16:31:41 +02:00
mvn -Pinit validate -N
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
License
-------
Docs is released under the terms of the GPL license. See `COPYING` for more
information or see <http://opensource.org/licenses/GPL-2.0>.