docs/README.md

101 lines
3.0 KiB
Markdown
Raw Normal View History

<h3 align="center">
<img src="https://www.sismicsdocs.com/img/github-title.png" alt="Sismics Docs" width=500 />
</h3>
2013-08-18 16:21:54 +02:00
[![Twitter: @sismicsdocs](https://img.shields.io/badge/contact-@sismicsdocs-blue.svg?style=flat)](https://twitter.com/sismicsdocs)
[![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html)
[![Build Status](https://secure.travis-ci.org/sismics/docs.png)](http://travis-ci.org/sismics/docs)
2013-08-18 16:21:54 +02:00
Docs is an open source, lightweight document management system for individuals and businesses.
2013-08-18 16:21:54 +02:00
<hr />
<h2 align="center">
✨ We just launched a Cloud version of Sismics Docs! Head to <a href="https://www.sismicsdocs.com/">sismicsdocs.com</a> for more informations ✨
</h2>
<hr />
2013-08-18 16:21:54 +02:00
2017-11-21 23:56:32 +01:00
Demo
----
A demo is available at [demo.sismicsdocs.com](https://demo.sismicsdocs.com)
- 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
- Support image, PDF, ODT and DOCX files
2013-08-18 16:21:54 +02:00
- Flexible search engine
2016-03-22 14:21:10 +01:00
- Full text search in all supported files
- All [Dublin Core](http://dublincore.org/) metadata
2016-03-22 14:21:10 +01:00
- 256-bit AES encryption of stored files
- Tag system with nesting
- User/group permission system
2018-01-08 11:51:15 +01:00
- 2-factor authentication
- 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
2015-08-28 01:18:18 +02:00
- Fully featured Android client
2015-09-12 21:31:51 +02:00
- Tested to 100k documents
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.
2017-04-25 11:09:18 +02:00
You will need a Java webapp server to run it, like [Jetty](http://eclipse.org/jetty/) or [Tomcat](http://tomcat.apache.org/).
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
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-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
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>.