README.md
<h1 align="center">#matrix</h1>
<p align="center">Online open-source workplace for distributed teams.</p>
<p align="center">
<a href="https://codeclimate.com/github/ResultadosDigitais/matrix/maintainability"><img src="https://api.codeclimate.com/v1/badges/a41e6e73f69c94d8b9c5/maintainability" /></a>
<a href="https://circleci.com/gh/ResultadosDigitais/matrix"><img alt="CircleCI Status" src="https://img.shields.io/circleci/project/github/babel/babel/master.svg?label=CircleCI&maxAge=43200"></a>
<a href="http://hash-matrix.slack.com/"><img alt="chat on Slack" src="https://img.shields.io/badge/Slack-chat%20with%20us-blue?logo=slack"></a>
</p>
## Welcome to the **#matrix**
The objective of **#matrix** project is to provide a virtual office environment like in a physical office. When we are working in a physical office, it's very common to go from one room to another to meet people and have conversations, for example: kitchen, lounge, gaming room, etc.
When working remotely there is less interaction with other members of your team like in a physical office. The **#matrix** project was born as a proposal to improve that experience. The idea is to allow you to create several virtual rooms mimicking the real world where people can _enter_ an room.
**#matrix** creates a virtual office for remote teams. Read more on [this post in Medium](https://medium.com/rd-shipit/matrix-d4cfc4ad4c75).
## Table of Contents
- [Welcome to the **#matrix**](#welcome-to-the-matrix)
- [Table of Contents](#table-of-contents)
- [Understanding #matrix](#understanding-matrix)
- [Rooms](#rooms)
- [Availability And Meetings](#availability-and-meetings)
- [Installation](#installation)
- [Environment Variables](#environment-variables)
- [External Meet](#external-meet)
- [Authentication](#authentication)
- [Docker Compose](#docker-compose)
- [On GCP](#on-gcp)
- [On Heroku](#on-heroku)
- [On Kubernetes](#on-kubernetes)
- [Production concerns](#production-concerns)
- [Versions](#versions)
- [Contributing](#contributing)
- [Frequently Asked Questions](#frequently-asked-questions)
- [Get in Touch](#get-in-touch)
- [License](#license)
## Understanding #matrix
### Rooms
When you are inside of the **#matrix** you will see several rooms. Because there is no way to actually _see_ the person you can't tell if they are on a meeting or phone call. To help with that, we show a headset icon around their avatar. In the image below you can see that people in the _Platform-Email_ room are in a meeting.
| Office Page | With Sidebar |
| :--------------------------------------------------------------------: | :----------------------------------------------------------------------------------: |
| <img src="docs/img/matrix-rooms.png" title="Office page" width="100%"> | <img src="docs/img/matrix-online.png" title="Office page with Sidebar" width="100%"> |
### Availability And Meetings
**#matrix** is a virtual environment office, so you can show you are available for the other on enter in a room through the `ENTER ROOM` button. This is like "Hey, I am here in the office".
Or you can enter in a meeting through the button `ENTER MEETING`.
The embeded meet is provided by [meet.jit.si](https://meet.jit.si) service and this service is maintained by the [Jitsi team](https://jitsi.org/the-community/#meet-our-team)
at [8x8](https://8x8.com). Access the [jitsi GitHub](https://github.com/jitsi/jitsi-meet#security) and learn more about this amazing video bridge service. You can change that using [external meet option](#External-Meet) in any room.
| Meeting Room | With Sidebar |
| :------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------------: |
| <img src="docs/img/matrix-meet-room.png" title="Office page" width="100%"> | <img src="docs/img/matrix-meet-room-sidebar.png" title="Office page with Sidebar" width="100%"> |
## Installation
### Environment Variables
The **#matrix** project has some environment variables that important to define.
- We are using Google to authorizations, you only need to configure the Google API credentials following [this step by step](/docs/GOOGLE-CREDENTIAL-STEP-BY-STEP.md) and after define these variables:
GOOGLE_CLIENT_ID=${paste_your_client_id_here}
GOOGLE_SECRET={paste_your_secret_here}
GOOGLE_CALLBACK_URL=http://localhost:8080/auth/google/callback
**Note: if you used version 1, with variable GOOGLE_CREDENTIAL, follow [this guide](/docs/MIGRATION-TO-V2.md)**
- You can change the secret and maximum age from session:
COOKIE_SESSION_SECRET=matrix-session
COOKIE_SESSION_MAX_AGE=2592000000
- You can define a white List of trusted email domains can enter in the **#matrix**
WHITELIST_DOMAINS=["domain1.com","domain2.com"]
- If you are running with ssl It's important to configure SSL, to define this:
ENFORCE_SSL=true
- The **#matrix** needs to know, where it get rooms definitions:
ROOMS_SOURCE=ENVIRONMENT | REMOTE
- There is a config that define the rooms of The **#matrix**, If you want to customize your rooms or add and a new room, you have to configure a `ROOMS_SOURCE=ENVIRONMENT` and config `ROOMS_DATA` like the example:
ROOMS_DATA=[
{
"id":"${UUID}",
"name":"Lounge",
"disableMeeting":true
},
{
"id":"${UUID}",
"name":"WAR ROOM CDP",
"description": "Welcome to the WAR room"
},
{
"id":"${UUID}",
"name":"Data Services",
"externalMeetUrl": "https://external-url-room/key-room"
}
]
Another option is to have a remote rooms config file (this file needs to be accessible via http/s). You can configure a `ROOMS_SOURCE=REMOTE` and config `ROOMS_DATA` like the example:
ROOMS_DATA=https://myfilelocation.io/myrooms_data.json
#### External Meet
The embeded meet is provided by [meet.jit.si](https://meet.jit.si) service, but you can change that in any room, using serices like [Meet](https://meet.google.com/) or [Zoom](https://zoom.us/). For that, you just need provide the parameter `externalMeetUrl` in your room config:
ROOMS_DATA=[
{
"id":"${UUID}",
"name":"Meeting External",
"externalMeetUrl": "https://external-url-room/key-room"
}
]
### Authentication
The login is so simple. You only need to configure the Google API credentials following [this step by step](/docs/GOOGLE-CREDENTIAL-STEP-BY-STEP.md) .
| Login | Login in Dark Mode |
| :-------------------------------------------------------------------: | :-------------------------------------------------------------------------------------: |
| <img src="docs/img/matrix-login.png" title="Login page" width="100%"> | <img src="docs/img/matrix-dark-login.png" title="Login page in Dark Mode" width="100%"> |
### Docker Compose
If you want run the **#matrix**, you need [docker-compose](https://docs.docker.com/compose/) and follow steps:
1. Clone this repository `git clone git@github.com:ResultadosDigitais/matrix.git`
2. We are using Google to authorizations, you need create a credential [here](/docs/GOOGLE-CREDENTIAL-STEP-BY-STEP.md) you can follow step by step
3. duplicate file `variables.example.env` and rename to `variables.env`, after that set your environment variables;
4. Run application with docker compose:
$ docker-compose up
5. Open your browser and access:
http://localhost:8080/
6. When you finish, you can run:
$ docker-compose down
### On GCP
If you prefer, you can run **#matrix** on GCP:
<a href="https://deploy.cloud.run?git_repo=https://github.com/ResultadosDigitais/matrix">
<img alt="Run on Google Cloud" src="https://deploy.cloud.run/button.svg" style="max-width:200px" />
</a>
### On Heroku
If you prefer, you can run **#matrix** in Heroku:
[](https://heroku.com/deploy?template=https://github.com/ResultadosDigitais/matrix)
### On Kubernetes
It is possible to run **#matrix** on Kubernetes, what you need to have is a running cluster and a Docker repository to fetch image from.
Example files can be found in `docs/kubernetes/`. Copy the files and follow the instructions bellow:
1. Change the values for `MATRIX_IMG` and `MATRIX_TAG` in deployment.yaml
2. Adjust the `GOOGLE_CALLBACK_URL`
3. Add your Google Credentials in `credentials.env` and create the secret with
```bash
kubectl create secret generic matrix-credentials --from-env-file=env_credentials
```
4. Create you `rooms.json` file and create a config map with
```bash
kubectl create configmap matrix-rooms --from-file=rooms.json
```
5. Apply the services and deployment files
```bash
kubectl apply -f deployment.yaml
kubectl apply -f service.yaml
```
Currently the service is using a LoadBalancer, it is possible to change to ClusterIP and use it behind an Ingress as well. Also note that in the example we are using HTTP, it is highly recommended to use HTTPS instead!
If you are using HTTPS, do change `ENFORCE_SSL` to `true` and add your company domain to `WHITELIST_DOMAINS`.
### Production concerns
If you will run in production we strongly recommend you close your environment using an internal VPN. In this solution everybody with the link and a valid google credential can enter your virtual office. Because this is important for you to maintain your environment closed. Or you can define a variable `WHITELIST_DOMAINS` to limit only authorized users to enter in the **#matrix**. You have to choose a strong key to the `COOKIE_SESSION_SECRET` and have to put in `GOOGLE_CALLBACK_URL` your production domain.
WHITELIST_DOMAINS=["domain1.com","domain2.com"]
If you can't use a VPN or don't have a custom domain for your users, and you still want to restrict access to the **#matrix**, you can define a `WHITELIST_USERS` variable to create an array of trusted e-mails that can access your virtual office.
WHITELIST_USERS=["teste@domain.com","teste2@domain.com"]
## Versions
| Version | Name | Description | Docs |
| --- | --- | --- | --- |
| Latest | upcoming | small improvements | [changelog](/docs/CHANGELOG.md) |
| 2.0.0 | Seraph | New authentication | [Migration guide to 2.0.0](/docs/MIGRATION-TO-V2.md) |
| 1.1.0 | Morpheus | New layout | [Pull request](https://github.com/ResultadosDigitais/matrix/pull/174) |
| 1.0.0 | Neo | The one project | - |
Please read more details about our versions folowing [changelog](/docs/CHANGELOG.md) file.
## Frequently Asked Questions
Some questions come up over and over again. Check here first:
[FAQ](docs/faq.md)
## Get in Touch
There are several ways to get in touch with us:
* Open an issue at: https://github.com/ResultadosDigitais/matrix/issues
* See questions on Stackoverflow using tags: https://stackoverflow.com/questions/tagged/hash-matrix
* Chat with us on: http://hash-matrix.slack.com/ ([Invite here](https://join.slack.com/t/hash-matrix/shared_invite/zt-cwglw6te-kMlJiimq7qn4WeSTiv91og))
## Contributors ✨
Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<table>
<tr>
<td align="center"><a href="http://juliemar.com.br"><img src="https://avatars0.githubusercontent.com/u/643779?v=4" width="100px;" alt=""/><br /><sub><b>Juliemar Berri</b></sub></a><br /><a href="#blog-juliemar" title="Blogposts">📝</a> <a href="https://github.com/ResultadosDigitais/matrix/commits?author=juliemar" title="Code">💻</a> <a href="#maintenance-juliemar" title="Maintenance">🚧</a> <a href="https://github.com/ResultadosDigitais/matrix/commits?author=juliemar" title="Documentation">📖</a> <a href="#talk-juliemar" title="Talks">📢</a></td>
<td align="center"><a href="http://www.brunonardini.com.br"><img src="https://avatars1.githubusercontent.com/u/673904?v=4" width="100px;" alt=""/><br /><sub><b>Bruno Nardini</b></sub></a><br /><a href="https://github.com/ResultadosDigitais/matrix/commits?author=megatroom" title="Code">💻</a> <a href="#maintenance-megatroom" title="Maintenance">🚧</a> <a href="https://github.com/ResultadosDigitais/matrix/commits?author=megatroom" title="Documentation">📖</a></td>
<td align="center"><a href="http://alesshh.com"><img src="https://avatars3.githubusercontent.com/u/1260049?v=4" width="100px;" alt=""/><br /><sub><b>Alessandro Tegner</b></sub></a><br /><a href="https://github.com/ResultadosDigitais/matrix/commits?author=alesshh" title="Code">💻</a> <a href="#maintenance-alesshh" title="Maintenance">🚧</a> <a href="#infra-alesshh" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a></td>
<td align="center"><a href="http://angeliski.com.br"><img src="https://avatars3.githubusercontent.com/u/1574240?v=4" width="100px;" alt=""/><br /><sub><b>Rogerio Angeliski</b></sub></a><br /><a href="https://github.com/ResultadosDigitais/matrix/commits?author=angeliski" title="Code">💻</a> <a href="#maintenance-angeliski" title="Maintenance">🚧</a> <a href="https://github.com/ResultadosDigitais/matrix/commits?author=angeliski" title="Documentation">📖</a></td>
<td align="center"><a href="https://github.com/diogonicoleti"><img src="https://avatars1.githubusercontent.com/u/4973742?v=4" width="100px;" alt=""/><br /><sub><b>Diogo Nicoleti</b></sub></a><br /><a href="https://github.com/ResultadosDigitais/matrix/commits?author=diogonicoleti" title="Code">💻</a></td>
<td align="center"><a href="https://arquivei.com.br"><img src="https://avatars1.githubusercontent.com/u/205890?v=4" width="100px;" alt=""/><br /><sub><b>Ricardo F. Verhaeg</b></sub></a><br /><a href="https://github.com/ResultadosDigitais/matrix/commits?author=Verhaeg" title="Documentation">📖</a></td>
<td align="center"><a href="https://www.linkedin.com/in/nataliafavareto"><img src="https://avatars1.githubusercontent.com/u/36651634?v=4" width="100px;" alt=""/><br /><sub><b>Natalia Favareto</b></sub></a><br /><a href="https://github.com/ResultadosDigitais/matrix/commits?author=NFavareto" title="Code">💻</a></td>
</tr>
<tr>
<td align="center"><a href="https://github.com/Jarzamendia"><img src="https://avatars2.githubusercontent.com/u/14064715?v=4" width="100px;" alt=""/><br /><sub><b>João Ernesto Arzamendia</b></sub></a><br /><a href="https://github.com/ResultadosDigitais/matrix/commits?author=Jarzamendia" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/g-nogara"><img src="https://avatars0.githubusercontent.com/u/48070989?v=4" width="100px;" alt=""/><br /><sub><b>Guilherme Nogara</b></sub></a><br /><a href="https://github.com/ResultadosDigitais/matrix/commits?author=g-nogara" title="Code">💻</a></td>
<td align="center"><a href="https://github.com/phiter"><img src="https://avatars2.githubusercontent.com/u/12252332?v=4" width="100px;" alt=""/><br /><sub><b>Phiter Fernandes</b></sub></a><br /><a href="https://github.com/ResultadosDigitais/matrix/commits?author=phiter" title="Code">💻</a></td>
<td align="center"><a href="http://silvanavlima.github.io"><img src="https://avatars3.githubusercontent.com/u/1433196?v=4" width="100px;" alt=""/><br /><sub><b>Silvana Lima</b></sub></a><br /><a href="https://github.com/ResultadosDigitais/matrix/commits?author=silvanavlima" title="Code">💻</a></td>
</tr>
</table>
<!-- markdownlint-enable -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
Everyone interacting in **#matrix** codebase, issue trackers, chat rooms, and mailing lists is expected to follow [code of conduct](docs/CODE_OF_CONDUCT.md).
## License
The **#matrix** is released under the [MIT License](docs/LICENSE)
> "The answer is out there, Neo, and it's looking for you, and it will find you if you want it to."