README
¶
Documize is an open source modern, lightweight and comprehensive alternative to Confluence.
It's built with Golang + EmberJS and compiled down to a single executable binary for Linux, Windows and macOS.
All you need to provide is PostgreSQL, Microsoft SQL Server or any MySQL variant.
- Built for technical and non-technical users
- Designed to unify both customer-facing and internal documentation
- Organization through labels, spaces and categories
- No fee-charging marketplace
Latest Release
We provide frequent product updates for both cloud and self-hosted customers.
Harvey Kandola, CEO/Founder @ Documize
OS Support
- Linux
- Windows
- macOS
- Raspberry Pi (using the ARM builds)
Database Support
- PostgreSQL (v9.6+)
- Microsoft SQL Server (2016+)
- MySQL (v5.7.10+ and v8.0.12+)
- Percona (v5.7.16-10+)
- MariaDB (10.3.0+)
Browser Support
- Chrome
- Firefox
- Safari
- Brave
- Vivaldi
- Opera
- Microsoft Edge (v42+)
Technology Stack
- Go (v1.12.9)
- Ember JS (v3.12.0)
Authentication Options
Besides email/password login, you can also authenticate via:
- LDAP
- Active Directory
- Red Hat Keycloak
- Central Authentication Service (CAS)
When using LDAP/Active Directory, you can optionally also authenticate with email/password.
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.
Documize uses other open source components and we acknowledge them in NOTICES
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 |
|
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
|
Package xid is a globally unique id generator suited for web scale |
|
uniqueid/xid16
Package xid is a globally unique id generator suited for web scale
|
Package xid is a globally unique id generator suited for web scale |
|
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. |
|
onboard
Package onboard handles the setup of sample data for a new Documize instance.
|
Package onboard handles the setup of sample data for a new Documize instance. |
|
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 |
|
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 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. |
|
onboard
Package onboarding handles the setup of sample data for a new Documize instance.
|
Package onboarding handles the setup of sample data for a new Documize instance. |
|
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.