vmario/docs
1
0
Fork 0
mirror of https://github.com/sismics/docs.git synced 2024-11-24 22:57:56 +01:00
Code Issues Packages Projects Releases Wiki Activity
A mirror at the moment. Might get a fork in the future
671 Commits 3 Branches 12 Tags 17 MiB
JavaScript 53.5%
Java 40.6%
HTML 5.3%
Less 0.3%
CSS 0.1%
5b8cd18128
Go to file
Benjamin Gamard 5b8cd18128 #159: display and validate route steps
2018-02-02 12:37:56 +01:00
docs-android new android icon 2017-12-21 12:51:47 +01:00
docs-core #159: display and validate route steps 2018-02-02 12:37:56 +01:00
docs-stress Prepare 1.5 development cycle 2016-05-09 22:52:34 +02:00
docs-web #159: display and validate route steps 2018-02-02 12:37:56 +01:00
docs-web-common #159: display and validate route steps 2018-02-02 12:37:56 +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 optimize docker image 2017-11-04 20:50:57 +01:00
docs.xml hook me 2015-03-23 17:30:15 +01:00
pom.xml cleanup logs for Travis + new process for each test 2017-11-18 20:01:11 +01:00
README.md Update README.md 2018-01-08 11:51:15 +01:00

README.md

Sismics Docs

Twitter: @sismicsdocs License: GPL v2 Build Status

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

✨ We just launched a Cloud version of Sismics Docs! Head to sismicsdocs.com for more informations ✨

Demo

A demo is available at demo.sismicsdocs.com

  • 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 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
  • 2-factor authentication
  • 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.