README
¶
We provide frequent product releases ensuring self-host customers enjoy the same features as our cloud/SaaS customers.
Harvey Kandola, CEO & Founder, Documize Inc.
The Mission
To bring software development inspired features to the world of documenting -- refactoring, importing, testing, linting, metrics, PRs, versioning....
What is it?
Documize is an intelligent document environment (IDE) for authoring, tracking and delivering documentation -- everything you need in one place.
Why should I care?
Because maybe like us you're tired of:
- juggling WYSIWYG editors, wiki software and other document related solutions
- playing email tennis with documents, contributions, versions and feedback
- sharing not-so-secure folders with external participants
Sound familiar? Read on.
Who is it for?
Anyone who wants a single place for any kind of document.
Anyone who wants to loop in external participants with complete security.
Anyone who wishes documentation and knowledge capture worked like agile software development.
Anyone who knows that nested folders fail miserably.
Anyone who wants to move on from wiki software.
What's different about Documize?
Sane organization through personal, team and public spaces.
Granular document access control via categories.
Section based approach to document construction.
Reusable templates and content blocks.
Documentation related tasking and delegation.
Integrations for embedding SaaS data within documents, zero add-on/marketplace fees.
What does it look like?
All spaces.
Space view.
Latest Release
OS support
Documize can be installed and run on:
- Linux
- Windows
- macOS
Heck, Documize will probably run just fine on a Raspberry Pi 3.
Database Support
Documize supports the following database systems:
- PostgreSQL (v9.6+)
- MySQL (v5.7.10+ and v8.0.12+)
- Percona (v5.7.16-10+)
- MariaDB (10.3.0+)
Coming soon: Microsoft SQL Server 2017 (Linux/Windows).
Browser Support
Documize supports the following (evergreen) browsers:
- Chrome
- Firefox
- Safari
- Brave
- Vivaldi
- Opera
- MS Edge (16+)
Technology Stack
Documize is built with the following technologies:
- EmberJS (v3.1.2)
- Go (v1.11.2)
Authentication Options
Besides email/password login, you can also leverage the following options.
LDAP / Active Directory
Connect and sync Documize with any LDAP v3 compliant provider including Microsoft Active Directory.
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 or leverage Social Login.
Auth0 Compatible
Documize is compatible with Auth0 identity as a service.
Open Source Identity and Access Management
Developer's Note
We try to follow sound advice when writing commit messages:
https://chris.beams.io/posts/git-commit/
The Legal Bit
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 Package env provides runtime, server level setup and configuration Package env provides runtime, server level setup and configuration |
|
mail
Package gomail provides a simple interface to compose emails and to mail them efficiently.
|
Package gomail provides a simple interface to compose emails and to mail them efficiently. |
|
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 randomly generated string 16 characters long.
|
Package uniqueid provides randomly generated string 16 characters long. |
|
uniqueid/xid
Package xid is a globally unique id generator suited for web scale Xid is using Mongo Object ID algorithm to generate globally unique ids: https://docs.mongodb.org/manual/reference/object-id/ - 4-byte value representing the seconds since the Unix epoch, - 3-byte machine identifier, - 2-byte process id, and - 3-byte counter, starting with a random value.
|
Package xid is a globally unique id generator suited for web scale Xid is using Mongo Object ID algorithm to generate globally unique ids: https://docs.mongodb.org/manual/reference/object-id/ - 4-byte value representing the seconds since the Unix epoch, - 3-byte machine identifier, - 2-byte process id, and - 3-byte counter, starting with a random value. |
|
uniqueid/xid16
Package xid is a globally unique id generator suited for web scale Xid is using Mongo Object ID algorithm to generate globally unique ids: https://docs.mongodb.org/manual/reference/object-id/ - 4-byte value representing the seconds since the Unix epoch, - 3-byte machine identifier, - 2-byte process id, and - 3-byte counter, starting with a random value.
|
Package xid is a globally unique id generator suited for web scale Xid is using Mongo Object ID algorithm to generate globally unique ids: https://docs.mongodb.org/manual/reference/object-id/ - 4-byte value representing the seconds since the Unix epoch, - 3-byte machine identifier, - 2-byte process id, and - 3-byte counter, starting with a random value. |
|
Package domain defines data structures for moving data between services.
|
Package domain defines data structures for moving data between services. |
|
audit
Package audit records user events.
|
Package audit records user events. |
|
backup
Package backup handle data backup/restore to/from ZIP format.
|
Package backup handle data backup/restore to/from ZIP format. |
|
category
Package category handles API calls and persistence for categories.
|
Package category handles API calls and persistence for categories. |
|
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. |
|
permission
Package permission handles API calls and persistence for spaces.
|
Package permission handles API calls and persistence for spaces. |
|
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 Package setting manages both global and user level settings Package setting manages both global and user level settings |
|
smtp
Package smtp provides access to SMTP server for sending email.
|
Package smtp provides access to SMTP server for sending email. |
|
space
Package space handles API calls and persistence for spaces.
|
Package space handles API calls and 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. |
|
storage
Package storage sets up database persistence providers.
|
Package storage sets up database persistence providers. |
|
Package embed contains the Documize static web data.
|
Package embed contains the Documize static web data. |
|
Package model ...
|
Package model ... |
|
audit
Package audit records and propagates events based on user actions.
|
Package audit records and propagates events based on user actions. |
|
backup
Package backup handle data backup/restore to/from ZIP format.
|
Package backup handle data backup/restore to/from ZIP format. |
|
web
Package web contains the Documize static web data.
|
Package web contains the Documize static web data. |