vmario/docs
1
0
Fork 0
mirror of https://github.com/sismics/docs.git synced 2024-06-26 19:41:24 +02:00
Code Issues Packages Projects Releases Wiki Activity
A mirror at the moment. Might get a fork in the future
587 Commits 3 Branches 12 Tags 17 MiB
JavaScript 53.6%
Java 40.5%
HTML 5.3%
Less 0.3%
CSS 0.2%
d2f9fcdda0
Go to file
Benjamin Gamard d2f9fcdda0 zh_CN translation + footer fix
2017-11-04 20:39:39 +01:00
docs-android Hide filename if not available + upgrade Gradle 2017-01-24 22:00:24 +01:00
docs-core support more languages 2017-10-31 21:20:22 +01:00
docs-stress Prepare 1.5 development cycle 2016-05-09 22:52:34 +02:00
docs-web zh_CN translation + footer fix 2017-11-04 20:39:39 +01:00
docs-web-common support more languages 2017-10-31 21:01:23 +01:00
.gitattributes Initial commit 2013-07-27 18:33:20 +02:00
.gitignore git ignore 2016-04-14 20:51:23 +02:00
.travis.yml support more languages 2017-10-31 20:36:55 +01:00
COPYING License 2013-08-18 16:23:15 +02:00
Dockerfile support more languages 2017-10-31 20:34:54 +01:00
docs.xml hook me 2015-03-23 17:30:15 +01:00
pom.xml Prepare 1.5 development cycle 2016-05-09 22:52:34 +02:00
README.md Update README.md 2017-11-01 19:50:42 +01:00

README.md

Sismics Docs Build Status

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
  • Optical character recognition
  • Support image, PDF, ODT and DOCX files
  • Flexible search engine
  • Full text search in all supported files
  • All Dublin Core metadata
  • 256-bit AES encryption of stored files
  • Tag system with nesting
  • User/group permission system
  • Hierarchical groups
  • Audit log
  • Comments
  • Storage quota per user
  • Document sharing by URL
  • RESTful Web API
  • Fully featured Android client
  • Tested to 100k documents

Download

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 or Tomcat. The default admin password is "admin". Don't forget to change it before going to production.

Install with Docker

From a Docker host, run this command to download and install Sismics Docs. 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 sismics_docs_latest -d -p 8100:8080 -v sismics_docs_latest:/data sismics/docs:latest

How to build Docs from the sources

Prerequisites: JDK 7 with JCE, Maven 3, Tesseract 3.02

Docs 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.

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.