2021-11-26 17:31:39 +01:00
< p align = "right" > < a href = "#gitpod" > < img alt = "Open in Gitpod" src = "https://gitpod.io/button/open-in-gitpod.svg" > < / a > < / p >
2020-10-01 21:17:00 +02:00
# Collabora Online
2022-01-19 09:59:35 +01:00
<!--
2022-03-18 12:31:20 +01:00
[![Master: Pull request policy ](https://img.shields.io/badge/Master-PRs%20can%20be%20merge%20without%20approval-42BC00?logoColor=42BC00&logo=git "Main release is still distant. Thanks for your support and contributions! : )")](https://github.com/CollaboraOnline/online/blob/master/CONTRIBUTING.md#contributing-to-source-code)
2022-01-19 09:59:35 +01:00
-->
2022-03-18 12:31:20 +01:00
[![Master: Pull request policy ](https://img.shields.io/badge/Master-protected%2C%20PRs%20need%20approval-red?logoColor=lightred&logo=git "Collabora Team is preparing for the next release, therefore 'master' branch is protected now, PRs need 1 review before merging. Thanks for your support and contributions! : )")](https://github.com/CollaboraOnline/online/blob/master/CONTRIBUTING.md#contributing-to-source-code)
2022-01-19 09:47:39 +01:00
2024-02-09 12:03:55 +01:00
[![Matrix ](https://img.shields.io/badge/Matrix-%23cool--dev-turquoise.svg )](https://matrix.to/#/#cool-dev:clicks.codes)
2020-10-03 22:41:35 +02:00
[![Telegram ](https://img.shields.io/badge/Telegram-Collabora%20Online-green.svg )](https://t.me/CollaboraOnline)
[![Forum ](https://img.shields.io/badge/Forum-Discourse-blue.svg )](https://forum.collaboraonline.com/)
[![Website ](https://img.shields.io/badge/Website-collaboraonline.github.io-blueviolet.svg )](https://collaboraonline.github.io/)
2020-10-08 21:11:12 +02:00
[![L10n ](https://img.shields.io/badge/L10n-Weblate-lightgrey.svg )](https://hosted.weblate.org/projects/collabora-online/)
2020-10-18 23:46:36 +02:00
[![Gitpod Ready-to-Code ](https://img.shields.io/badge/Gitpod-ready--to--code-blue?logo=gitpod )](https://gitpod.io/#https://github.com/CollaboraOnline/online)
2020-10-03 22:41:35 +02:00
2021-11-26 17:31:39 +01:00
2022-09-07 18:52:21 +02:00
**Your own private Office in the Cloud**
2020-10-14 00:10:33 +02:00
2022-07-07 07:02:56 +02:00
![](https://raw.githubusercontent.com/CollaboraOnline/CollaboraOnline.github.io/master/static/images/homepage-image.png)
2020-10-14 00:10:33 +02:00
2023-01-16 10:59:48 +01:00
## Get in touch 💬
2023-09-29 11:27:56 +02:00
* [📋 Forum ](https://forum.collaboraonline.com/ )
2023-01-16 10:59:48 +01:00
* [👥 Facebook ](https://www.facebook.com/collaboraoffice/ )
2023-11-01 13:12:54 +01:00
* [🐣 𝕏 (Twitter) ](https://twitter.com/CollaboraOffice )
2023-01-16 10:59:48 +01:00
* [🐘 Mastodon ](https://mastodon.social/@CollaboraOffice )
2020-10-14 00:10:33 +02:00
## Key features
* View and edit text documents, spreadsheets, presentations & more
* Collaborative editing features
* Works in any modern browser – no plugin needed
2021-11-18 13:16:45 +01:00
* Open Source – primarily under the [MPLv2 ](http://mozilla.org/MPL/2.0/ ) license. Some parts are under other open source licences, see e.g. [browser/LICENSE ](https://github.com/CollaboraOnline/online/blob/master/browser/LICENSE ).
2020-10-14 00:10:33 +02:00
2020-10-01 16:21:53 +02:00
## Website
2020-10-01 21:17:00 +02:00
For many more details, build instructions, downloads and more please visit https://collaboraonline.github.io/
2020-10-01 16:21:53 +02:00
2020-10-01 21:17:00 +02:00
## Developer assistance
2023-11-16 17:32:22 +01:00
Please ask your questions on any of the bridged Matrix/Telegram rooms
2024-02-09 12:03:55 +01:00
* Matrix: [#cool-dev:clicks.codes ](https://matrix.to/#/#cool-dev:clicks.codes )
2022-04-13 16:52:17 +02:00
* Telegram: [CollaboraOnline ](https://t.me/CollaboraOnline )
2020-10-01 21:17:00 +02:00
Join the conversation on our Discourse server at https://forum.collaboraonline.com/
2020-10-01 16:21:53 +02:00
2020-11-10 09:10:30 +01:00
Watch the tinderbox status (if it's green) at
2022-04-25 11:56:52 +02:00
https://cpci.cbg.collabora.co.uk:8080/job/Tinderbox%20for%20online%20master%20against%20co-22.05/
2020-11-10 09:10:30 +01:00
2020-10-03 18:38:25 +02:00
## Development bits
2015-03-25 15:15:57 +01:00
2016-11-24 15:56:06 +01:00
This project has several components:
2020-10-14 00:10:33 +02:00
* **wsd/**
* The Web Services Daemon - which accepts external connections
* **kit/**
* The client which lives in its own chroot and renders documents
* **common/**
* Shared code between these processes
2021-11-03 14:38:04 +01:00
* **browser/**
2020-10-14 00:10:33 +02:00
* The client side JavaScript component
* **test/**
* C++ based unit tests
* **cypress_test/**
* JavaScript based integration tests
2020-05-27 15:36:07 +02:00
2020-10-01 21:17:00 +02:00
## Further recommended reading with build details
2015-04-21 12:48:17 +02:00
2020-10-01 21:17:00 +02:00
Please consult the README files in the component's directory for more details:
2022-07-07 07:02:56 +02:00
- **[wsd/README](wsd)**
- **[browser/README](browser)**
2015-03-25 15:15:57 +01:00
2020-10-23 12:21:43 +02:00
## iOS and Android apps
See the corresponding READMEs:
2022-07-07 07:02:56 +02:00
* **[ios/README](ios)**
* **[android/README](android)**
2020-10-23 12:21:43 +02:00
2021-11-26 17:31:39 +01:00
## GitPod
2023-11-16 17:31:45 +01:00
Head over to https://collaboraonline.github.io/post/build-code/#build-code-on-gitpod and follow the steps.
2021-11-26 17:31:39 +01:00
2020-10-14 00:10:33 +02:00
## Enjoy!