docs/README.md

140 lines
5.1 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
2018-03-05 11:06:26 +01:00
**Discuss it on [Product Hunt](https://www.producthunt.com/posts/sismics-docs) 🦄**
<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
2018-03-01 17:35:29 +01:00
![New!](https://www.sismicsdocs.com/img/laptop-demo.png?20180301)
2018-02-02 17:28:23 +01: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
2018-03-20 22:46:56 +01:00
- Support image, PDF, ODT, DOCX, PPTX files
2018-03-02 19:05:20 +01:00
- Video file support ![New!](https://www.sismics.com/public/img/new.png)
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
- All [Dublin Core](http://dublincore.org/) metadata
- Workflow system ![New!](https://www.sismics.com/public/img/new.png)
2016-03-22 14:21:10 +01:00
- 256-bit AES encryption of stored files
- Tag system with nesting
- Import document from email (EML format) ![New!](https://www.sismics.com/public/img/new.png)
2018-02-27 20:06:34 +01:00
- Automatic inbox scanning and importing ![New!](https://www.sismics.com/public/img/new.png)
2016-03-22 14:21:10 +01:00
- 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
2018-10-17 11:40:42 +02:00
- Webhooks to trigger external service ![New!](https://www.sismics.com/public/img/new.png)
2015-08-28 01:18:18 +02:00
- Fully featured Android client
2018-03-02 19:05:20 +01:00
- [Bulk files importer](https://github.com/sismics/docs/tree/master/docs-importer) (single or scan mode) ![New!](https://www.sismics.com/public/img/new.png)
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
-------------------
From a Docker host, run this command to download and install Sismics Docs. The server will run on <http://[your-docker-host-ip]:8100>.
2018-03-14 14:53:41 +01:00
**The default admin password is "admin". Don't forget to change it before going to production.**
2017-04-25 11:09:18 +02:00
docker run --rm --name sismics_docs_latest -d -e DOCS_BASE_URL='http://[your-docker-host-ip]:8100' -p 8100:8080 -v sismics_docs_latest:/data sismics/docs:latest
<img src="http://www.newdesignfile.com/postpic/2011/01/green-info-icon_206509.png" width="16px" height="16px"> **Note:** You will need to change [your-docker-host-ip] with the IP address or FQDN of your docker host e.g.
FQDN: http://docs.sismics.com
IP: http://192.168.100.10
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.**
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
2018-03-18 22:23:29 +01:00
Prerequisites: JDK 8 with JCE, Maven 3, Tesseract 3 or 4
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
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.
Community
---------
Get updates on Sismics Docs' development and chat with the project maintainers:
- Follow [@sismicsdocs on Twitter](https://twitter.com/sismicsdocs)
- Read and subscribe to [The Official Sismics Docs Blog](https://blog.sismicsdocs.com/)
- Check the [Official Website](https://www.sismicsdocs.com)
- Join us [on Facebook](https://www.facebook.com/sismicsdocs)
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>.