2021-11-26 10:31:39 -06: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 14:17:00 -05:00
# Collabora Online
2022-01-19 02:59:35 -06:00
<!--
2022-03-18 06:31:20 -05: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 02:59:35 -06:00
-->
2022-03-18 06:31:20 -05: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 02:47:39 -06:00
2021-06-14 02:14:02 -05:00
[![irc ](https://img.shields.io/badge/IRC-%23cool--dev%20on%20libera-orange.svg )](https://web.libera.chat/?channels=cool-dev)
2020-10-03 15:41:35 -05: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 14:11:12 -05:00
[![L10n ](https://img.shields.io/badge/L10n-Weblate-lightgrey.svg )](https://hosted.weblate.org/projects/collabora-online/)
2020-10-18 16:46:36 -05: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 15:41:35 -05:00
2021-11-26 10:31:39 -06:00
2022-09-07 11:52:21 -05:00
**Your own private Office in the Cloud**
2020-10-13 17:10:33 -05:00
2022-07-07 00:02:56 -05:00
![](https://raw.githubusercontent.com/CollaboraOnline/CollaboraOnline.github.io/master/static/images/homepage-image.png)
2020-10-13 17:10:33 -05:00
2023-01-16 03:59:48 -06:00
## Get in touch 💬
2023-09-29 04:27:56 -05:00
* [📋 Forum ](https://forum.collaboraonline.com/ )
2023-01-16 03:59:48 -06:00
* [👥 Facebook ](https://www.facebook.com/collaboraoffice/ )
2023-11-01 07:12:54 -05:00
* [🐣 𝕏 (Twitter) ](https://twitter.com/CollaboraOffice )
2023-01-16 03:59:48 -06:00
* [🐘 Mastodon ](https://mastodon.social/@CollaboraOffice )
2020-10-13 17:10:33 -05: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 06:16:45 -06: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-13 17:10:33 -05:00
2020-10-01 09:21:53 -05:00
## Website
2020-10-01 14:17:00 -05:00
For many more details, build instructions, downloads and more please visit https://collaboraonline.github.io/
2020-10-01 09:21:53 -05:00
2020-10-01 14:17:00 -05:00
## Developer assistance
2023-11-16 10:32:22 -06:00
Please ask your questions on any of the bridged Matrix/Telegram rooms
2022-04-13 09:52:17 -05:00
* Matrix: [#cool-dev:libera.chat ](https://app.element.io/#/room/#cool-dev:libera.chat )
* Telegram: [CollaboraOnline ](https://t.me/CollaboraOnline )
2020-10-01 14:17:00 -05:00
Join the conversation on our Discourse server at https://forum.collaboraonline.com/
2020-10-01 09:21:53 -05:00
2020-11-10 02:10:30 -06:00
Watch the tinderbox status (if it's green) at
2022-04-25 04:56:52 -05:00
https://cpci.cbg.collabora.co.uk:8080/job/Tinderbox%20for%20online%20master%20against%20co-22.05/
2020-11-10 02:10:30 -06:00
2020-10-03 11:38:25 -05:00
## Development bits
2015-03-25 09:15:57 -05:00
2016-11-24 08:56:06 -06:00
This project has several components:
2020-10-13 17:10:33 -05: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 08:38:04 -05:00
* **browser/**
2020-10-13 17:10:33 -05:00
* The client side JavaScript component
* **test/**
* C++ based unit tests
* **cypress_test/**
* JavaScript based integration tests
2020-05-27 08:36:07 -05:00
2020-10-01 14:17:00 -05:00
## Further recommended reading with build details
2015-04-21 05:48:17 -05:00
2020-10-01 14:17:00 -05:00
Please consult the README files in the component's directory for more details:
2022-07-07 00:02:56 -05:00
- **[wsd/README](wsd)**
- **[browser/README](browser)**
2015-03-25 09:15:57 -05:00
2020-10-23 05:21:43 -05:00
## iOS and Android apps
See the corresponding READMEs:
2022-07-07 00:02:56 -05:00
* **[ios/README](ios)**
* **[android/README](android)**
2020-10-23 05:21:43 -05:00
2021-11-26 10:31:39 -06:00
## GitPod
2023-11-16 10:31:45 -06:00
Head over to https://collaboraonline.github.io/post/build-code/#build-code-on-gitpod and follow the steps.
2021-11-26 10:31:39 -06:00
2020-10-13 17:10:33 -05:00
## Enjoy!