README
¶
Documize Community Edition
Documize is an Integrated Document Environment (IDE) unifying documents, wiki, reporting and dashboards -- one tool to power the enterprise-wide knowledge backbone.
The mission is to bring software dev inspired features (refactoring, testing, linting, metrics, PRs) to those poor souls stuck writing docs in the dark ages.
Latest version
v1.52.0
OS Support
- Windows
- Linux
- macOS
Tech stack
- EmberJS (v2.14.0)
- Go (v1.8.3)
- MySQL (v5.7.10+) or Percona (v5.7.16-10+) or MariaDB (10.3.0+)
Documentation
Keycloak Integration
Documize provides out-of-the-box integration with Redhat Keycloak for open source identity and access management.
Connect and authenticate with LDAP, Active Directory and more.
Auth0 Compatible
Documize is compatible with Auth0 identity as a service.
Open Source Identity and Access Management
Legal
This software (Documize Community Edition) is licensed under GNU AGPL v3 http://www.gnu.org/licenses/agpl-3.0.en.html. You can operate outside the AGPL restrictions by purchasing Documize Enterprise Edition and obtaining a commercial license by contacting sales@documize.com. Documize® is a registered trade mark of Documize Inc.
Directories
¶
| Path | Synopsis |
|---|---|
|
core
|
|
|
api/convert
Package convert provides the gateway to document conversion native and plugin functionality, both in and out of the system.
|
Package convert provides the gateway to document conversion native and plugin functionality, both in and out of the system. |
|
api/convert/html
Package html documizes html files.
|
Package html documizes html files. |
|
api/plugins
Package plugins manages the plug-in componenets of the Documize system.
|
Package plugins manages the plug-in componenets of the Documize system. |
|
convapi
Package convapi provides the definitions of types used for file conversion communication between different components of the Documize system.
|
Package convapi provides the definitions of types used for file conversion communication between different components of the Documize system. |
|
env
Package env provides runtime, server level setup and configuration Package env provides runtime, server level setup and configuration Package env provides runtime, server level setup and configuration
|
Package env provides runtime, server level setup and configuration Package env provides runtime, server level setup and configuration Package env provides runtime, server level setup and configuration |
|
request
Package request provides HTTP request parsing functions.
|
Package request provides HTTP request parsing functions. |
|
response
Package response provides functions to write HTTP response.
|
Package response provides functions to write HTTP response. |
|
timeutil
Package timeutil provides date and time related types and helpers.
|
Package timeutil provides date and time related types and helpers. |
|
uniqueid
Package uniqueid provides utility functions specific to the http-end-point component of Documize.
|
Package uniqueid provides utility functions specific to the http-end-point component of Documize. |
|
Package domain defines data structures for moving data between services.
|
Package domain defines data structures for moving data between services. |
|
audit/mysql
Package audit records user events.
|
Package audit records user events. |
|
conversion/store
Package store provides the implementation for a file system based storage provider.
|
Package store provides the implementation for a file system based storage provider. |
|
mail
Package mail sends transactional emails.
|
Package mail sends transactional emails. |
|
setting
Package setting manages both global and user level settings Package setting manages both global and user level settings
|
Package setting manages both global and user level settings Package setting manages both global and user level settings |
|
space
Package space handles API calls and persistence for spaces.
|
Package space handles API calls and persistence for spaces. |
|
space/mysql
Package mysql handles data persistence for spaces.
|
Package mysql handles data persistence for spaces. |
|
This package provides Documize as a single executable.
|
This package provides Documize as a single executable. |
|
boot
Package boot prepares runtime environment.
|
Package boot prepares runtime environment. |
|
logging
Package logging defines application-wide logging implementation.
|
Package logging defines application-wide logging implementation. |
|
Package embed contains the Documize static web data.
|
Package embed contains the Documize static web data. |
|
Package model ...
|
Package model ... |
|
audit
Package eventing records and propagates events based on user actions.
|
Package eventing records and propagates events based on user actions. |
|
web
Package web contains the Documize static web data.
|
Package web contains the Documize static web data. |
Click to show internal directories.
Click to hide internal directories.