Home

Awesome

<!-- - SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors - SPDX-License-Identifier: CC0-1.0 -->

Nextcloud Talk

REUSE status

A video & audio conferencing app for Nextcloud

Elevator
✨ Why is this so awesome?
📚 Documentation
🚧 Development Setup

✨ Why is this so awesome?

More in the works for the coming versions.

If you have suggestions or problems, please open an issue or contribute directly 🤓

📚 Documentation

📦 Installing for Production

Nextcloud Talk is really easy to install. You just need to enable the app from the Nextcloud App Store and everything will work out of the box.

There are some scenarios (users behind strict firewalls / symmetric NATs) where a TURN server is needed. That's a bit more tricky to install. You can find instructions in our documentation and the team behind the Nextcloud VM has developed a script that takes care of everything for you (vm-talk.sh). The script is tested on the recent Ubuntu Server LTS. Please keep in mind that it's developed for the VM specifically and any issues should be reported in that repository, not here.

Here's a short video on how it's done.

🚧 Development Setup

  1. Simply clone this repository into the apps folder of your Nextcloud development instance.
  2. Run make dev-setup to install the dependencies.
  3. Run make build-js.
  4. Then activate it through the apps management. 🎉
  5. To build the docs locally, install mkdocs locally: apt install mkdocs mkdocs-bootstrap.

Also see our step by step guide on how to set up a full development environment.

🏎️ Faster frontend developing with HMR

You can enable HMR (Hot module replacement) to avoid page reloads when working on the frontend:

  1. Install and enable hmr_enabler app
  2. Run npm run serve
  3. Open the normal Nextcloud server URL (not the URL given by above command)

We are also available on our public Talk team conversation, if you want to join the discussion.

🙈 Ignore code style updates in git blame

git config blame.ignoreRevsFile .git-blame-ignore-revs

🌏 Testing federation locally

When testing federated conversations locally, some additional steps might be needed, to improve the behaviour and allowing the servers to talk to each others:

  1. Allow self-signed certificates 
    occ config:system:set sharing.federation.allowSelfSignedCertificates --value true --type bool
occ security:certificates:import /path/to/the/nextcloud.crt
occ security:certificates
  2. Allow local servers to be remote servers 
    occ config:system:set allow_local_remote_servers --value true --type bool

Additionally you can enable debug mode that will list local users as federated users options allowing you to federate with accounts on the same instance. Federation will still work and use the full federation experience and opposed to the federated files sharing not create a local share instead.

🪄 Useful tricks for testing video calls

👥 Joining a test call with multiple users

📸 Modifying available media devices

🔃 Milestones and Branches

Branches

In the Talk app we have one branch per Nextcloud server version. stable* branches of the app should always work with the same branch of the Nextcloud server. This is only off close to releases of the server, to allow easier finishing of features, so we don't have to backport them.

Milestones

You can always pick a task of any milestone, and we will help you to get it into the assigned milestone or also an earlier one if time permits. It's just a matter of having an overview and better visibility what we think should be worked on, but it's not exclusive.

💙 Contribution Guidelines

For more information please see the guidelines for contributing to this repository.