Skip to content

Latest commit

 

History

History
114 lines (81 loc) · 5.66 KB

README.md

File metadata and controls

114 lines (81 loc) · 5.66 KB

Open in Gitpod

Collabora Online

Master: Pull request policy

Matrix Telegram Forum Website L10n Gitpod Ready-to-Code

Your own private Office in the Cloud

Get in touch 💬

Key features

  • View and edit text documents, spreadsheets, presentations & more
  • Collaborative editing features
  • Works in any modern browser – no plugin needed
  • Open Source – primarily under the MPLv2 license. Some parts are under other open source licences, see e.g. browser/LICENSE.

Website

For many more details, build instructions, downloads and more please visit https://collaboraonline.github.io/ and also you can check out the SDK Documentation.

Developer assistance

Please ask your questions on any of the bridged Matrix/Telegram rooms

Join the conversation on our Discourse server at https://forum.collaboraonline.com/

Watch the tinderbox status (if it's green) at https://cpci.cbg.collabora.co.uk:8080/job/Tinderbox%20for%20online%20master%20against%20co-24.04/

Development bits

This project has several components:

  • 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
  • browser/
    • The client side JavaScript component
  • test/
    • C++ based unit tests
  • cypress_test/
    • JavaScript based integration tests

Further recommended reading with build details

Please consult the README files in the component's directory for more details:

iOS and Android apps

Building

See the corresponding READMEs:

Releases and pre-releases

Releases and pre-release builds are made from the distro/collabora/co-24.04-mobile branch. Releases for Android and iOS are generally built from the same commit, and are tagged as a release on GitHub.

Android snapshots are automatically built once a week, but may be built more frequently if there's something new to test. iOS testflight builds are exclusively built when there is something new to test. Pre-release builds are not tagged in GitHub.

Getting changes into 24.04-mobile

You should still develop against master, even if you're working on mobile-only features. Changes made in master will be moved into the distro/collabora/co-24.04 branch according to the release schedule. Changes from the distro/collabora/co-24.04 branch are then regularly cherry-picked into the distro/collabora/co-24.04-mobile branch.

If you have a change which you want to get into mobile snapshots or releases more quickly, you should still develop it against master. When it's merged into master, you should make a backport pull request against distro/collabora/co-24.04-mobile. Please don't make pull requests directly against distro/collabora/co-24.04-mobile (i.e. without the change first being merged into master).

GitPod

Head over to https://collaboraonline.github.io/post/build-code/#build-code-on-gitpod and follow the steps.

Integrating

To integrate Collabora Online into your own solution, you can see our step-by-step tutorial, view the available integrations, understand the post message API used to customize and interact with Collabora Online, and a lot more.

Enjoy!