documize/README.md

Documize Community is an open source modern, lightweight alternative to Confluence and other similar solutions.

- Built for technical and non-technical users
- Designed to unify both customer-facing and internal documentation
- Organization through labels, spaces and categories

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.

![Documize Community](screenshot-1.png "Documize Community")

## Latest Release

[Community edition: v4.0.0](https://github.com/documize/community/releases)

[Community+ edition: v4.0.0](https://www.documize.com/community/downloads)

The Community+ edition is our enterprise-ready offering with customer support and advanced capabilities.

## OS Support

- Linux
- Windows
- macOS
- Raspberry Pi (using the ARM builds)

## Database Support

For all database types, Full-Text Search support (FTS) is mandatory.

- PostgreSQL (v9.6+)
- Microsoft SQL Server (2016+ with FTS)
- MySQL (v5.7.10+ and v8.0.12+)
- Percona (v5.7.16-10+)
- MariaDB (10.3.0+)

## Browser Support

- Firefox
- Chrome
- Safari
- Microsoft Edge (v42+)
- Brave
- Vivaldi
- Opera

## Technology Stack

- Go (v1.17.2)
- 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 enable dual-authentication with email/password.

## Product/Technical Support

For both Community and Enterprise editions, please contact our help desk for product help, suggestions and other enquiries.

<support@documize.com>

We aim to respond within two working days!

## The Legal Bit

<https://documize.com>

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 Community+ 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](NOTICES.md)
Prep re-branding 2021-11-03 11:46:20 -04:00			`Documize Community is an open source modern, lightweight alternative to Confluence and other similar solutions.`
bulk data load methods for space and document views 2017-10-08 20:53:25 -04:00
README update 2019-02-22 16:47:26 +00:00			`- Built for technical and non-technical users`
Update README.md 2019-02-27 13:58:18 +00:00			`- Designed to unify both customer-facing and internal documentation`
README update 2019-02-22 16:47:26 +00:00			`- Organization through labels, spaces and categories`
added screenshot to README 2017-12-20 16:51:32 +00:00
Update README.md 2019-11-19 18:11:49 +00:00			`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.`

Prep re-branding 2021-11-03 11:46:20 -04:00			`![Documize Community](screenshot-1.png "Documize Community")`
revised screenshots 2018-01-28 14:04:35 +00:00
Sync'ed versions between EE & CE Both sit @ 1.76.0 2018-11-13 15:19:05 +00:00			`## Latest Release`
Update README.md 2016-07-18 10:18:21 -07:00
Prep re-branding 2021-11-03 11:46:20 -04:00			`[Community edition: v4.0.0](https://github.com/documize/community/releases)`
Updated README with edition download links 2018-03-23 12:02:27 +00:00
Prep re-branding 2021-11-03 11:46:20 -04:00			`[Community+ edition: v4.0.0](https://www.documize.com/community/downloads)`

			`The Community+ edition is our enterprise-ready offering with customer support and advanced capabilities.`
Provide granular Dashbaord/Action view permissions Closes #154 2018-05-11 15:17:10 +01:00
Update README.md 2019-05-17 11:36:53 +01:00			`## OS Support`
updated readme 2017-10-07 09:06:42 -04:00
workspace bar ready! 2016-11-05 14:53:44 -07:00			`- Linux`
updated readme 2017-10-07 09:06:42 -04:00			`- Windows`
updated mysql driver and fixed pinned card scrolling 2016-12-14 16:54:12 +00:00			`- macOS`
Update README.md 2019-05-15 16:50:51 +01:00			`- Raspberry Pi (using the ARM builds)`
Implement PostgreSQL Full Text Search++ 1. Full text search supports MySQL, MariaDB, Percona and now PostgreSQL. 2. Changed SQL Variant to typed enum. 3. Changed doc.Versioned from INT to BOOL. 4. Search Reindexer now parses all documents and attachments. 5. Site meta API call returns storage provider type. 6. README prep'ed for PostgreSQL support. 7. DELETE SQL statements ignore zero rows affected. Closes #100 !!! Co-Authored-By: Saul S <sauls8t@users.noreply.github.com> Co-Authored-By: McMatts <matt@documize.com> 2018-09-28 16:33:15 +01:00
Sync'ed versions between EE & CE Both sit @ 1.76.0 2018-11-13 15:19:05 +00:00			`## Database Support`
Implement PostgreSQL Full Text Search++ 1. Full text search supports MySQL, MariaDB, Percona and now PostgreSQL. 2. Changed SQL Variant to typed enum. 3. Changed doc.Versioned from INT to BOOL. 4. Search Reindexer now parses all documents and attachments. 5. Site meta API call returns storage provider type. 6. README prep'ed for PostgreSQL support. 7. DELETE SQL statements ignore zero rows affected. Closes #100 !!! Co-Authored-By: Saul S <sauls8t@users.noreply.github.com> Co-Authored-By: McMatts <matt@documize.com> 2018-09-28 16:33:15 +01:00
Enable Full-text Search when using SQL Server 2016+ 2019-09-11 19:08:53 +01:00			`For all database types, Full-Text Search support (FTS) is mandatory.`

Implement PostgreSQL Full Text Search++ 1. Full text search supports MySQL, MariaDB, Percona and now PostgreSQL. 2. Changed SQL Variant to typed enum. 3. Changed doc.Versioned from INT to BOOL. 4. Search Reindexer now parses all documents and attachments. 5. Site meta API call returns storage provider type. 6. README prep'ed for PostgreSQL support. 7. DELETE SQL statements ignore zero rows affected. Closes #100 !!! Co-Authored-By: Saul S <sauls8t@users.noreply.github.com> Co-Authored-By: McMatts <matt@documize.com> 2018-09-28 16:33:15 +01:00			`- PostgreSQL (v9.6+)`
Enable Full-text Search when using SQL Server 2016+ 2019-09-11 19:08:53 +01:00			`- Microsoft SQL Server (2016+ with FTS)`
State minimum MySQL v8 version 2018-10-23 13:47:34 +01:00			`- MySQL (v5.7.10+ and v8.0.12+)`
Implement PostgreSQL Full Text Search++ 1. Full text search supports MySQL, MariaDB, Percona and now PostgreSQL. 2. Changed SQL Variant to typed enum. 3. Changed doc.Versioned from INT to BOOL. 4. Search Reindexer now parses all documents and attachments. 5. Site meta API call returns storage provider type. 6. README prep'ed for PostgreSQL support. 7. DELETE SQL statements ignore zero rows affected. Closes #100 !!! Co-Authored-By: Saul S <sauls8t@users.noreply.github.com> Co-Authored-By: McMatts <matt@documize.com> 2018-09-28 16:33:15 +01:00			`- Percona (v5.7.16-10+)`
			`- MariaDB (10.3.0+)`

Sync'ed versions between EE & CE Both sit @ 1.76.0 2018-11-13 15:19:05 +00:00			`## Browser Support`
Version bump 2018-06-29 16:07:01 +01:00
			`- Firefox`
Prep re-branding 2021-11-03 11:46:20 -04:00			`- Chrome`
Version bump 2018-06-29 16:07:01 +01:00			`- Safari`
Prep re-branding 2021-11-03 11:46:20 -04:00			`- Microsoft Edge (v42+)`
Version bump 2018-06-29 16:07:01 +01:00			`- Brave`
Implement PostgreSQL Full Text Search++ 1. Full text search supports MySQL, MariaDB, Percona and now PostgreSQL. 2. Changed SQL Variant to typed enum. 3. Changed doc.Versioned from INT to BOOL. 4. Search Reindexer now parses all documents and attachments. 5. Site meta API call returns storage provider type. 6. README prep'ed for PostgreSQL support. 7. DELETE SQL statements ignore zero rows affected. Closes #100 !!! Co-Authored-By: Saul S <sauls8t@users.noreply.github.com> Co-Authored-By: McMatts <matt@documize.com> 2018-09-28 16:33:15 +01:00			`- Vivaldi`
			`- Opera`
Version bump 2018-06-29 16:07:01 +01:00
Sync'ed versions between EE & CE Both sit @ 1.76.0 2018-11-13 15:19:05 +00:00			`## Technology Stack`
updated readme 2017-10-07 09:06:42 -04:00
Prep re-branding 2021-11-03 11:46:20 -04:00			`- Go (v1.17.2)`
Bump version to 3.3.2 2019-10-14 12:27:41 +01:00			`- Ember JS (v3.12.0)`
added tech stack to README 2016-07-08 16:35:20 -07:00
Sync'ed versions between EE & CE Both sit @ 1.76.0 2018-11-13 15:19:05 +00:00			`## Authentication Options`
updated readme 2017-10-07 09:06:42 -04:00
Update README 2019-08-28 12:27:38 +01:00			`Besides email/password login, you can also authenticate via:`
Document how to write good commit messages 2018-01-29 09:23:02 +00:00
Update README 2019-08-28 12:27:38 +01:00			`* LDAP`
			`* Active Directory`
			`* Red Hat Keycloak`
			`* Central Authentication Service (CAS)`

Enable Full-text Search when using SQL Server 2016+ 2019-09-11 19:08:53 +01:00			`When using LDAP/Active Directory, you can enable dual-authentication with email/password.`
Support dual login via LDAP and forms authentication Closes #256 as we now support dual login -- LDAP and forms authentication. Also bumped the vendored library to LDAP.v3 as it contains bug fixes. 2019-05-13 16:14:11 +01:00
Clarify support options 2020-03-09 12:30:16 +00:00			`## Product/Technical Support`

Update README.md 2021-03-28 16:00:39 -04:00			`For both Community and Enterprise editions, please contact our help desk for product help, suggestions and other enquiries.`
Clarify support options 2020-03-09 12:30:16 +00:00
Update README.md 2020-03-09 12:30:37 +00:00			`<support@documize.com>`
Clarify support options 2020-03-09 12:30:16 +00:00
			`We aim to respond within two working days!`

Sync'ed versions between EE & CE Both sit @ 1.76.0 2018-11-13 15:19:05 +00:00			`## The Legal Bit`
Update README.md 2016-07-09 08:04:18 -07:00
workspace bar ready! 2016-11-05 14:53:44 -07:00			`<https://documize.com>`
Update README.md 2016-07-08 17:09:58 -07:00
Prep re-branding 2021-11-03 11:46:20 -04:00			`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 Community+ edition and obtaining a commercial license by contacting <sales@documize.com>. Documize® is a registered trade mark of Documize Inc.`
Add NOTICES.md Covers third party dependencies 2019-03-20 12:53:50 +00:00
Update README.md 2019-03-21 11:37:16 +00:00			`Documize uses other open source components and we acknowledge them in [NOTICES](NOTICES.md)`