feat: init

Documentation/docs/how-to-use-it/applications/README.md

@@ -0,0 +1,6 @@
+---
+description: Discover Twake application
+---
+
+# 💠 Applications
+

Documentation/docs/how-to-use-it/applications/calendar.md

@@ -0,0 +1,6 @@
+---
+description: How to use Twake calendar
+---
+
+# 📆 Calendar
+

Documentation/docs/how-to-use-it/applications/connectors/README.md

@@ -0,0 +1,6 @@
+---
+description: How to add connector on Twake
+---
+
+# 🔃 Connectors
+

Documentation/docs/how-to-use-it/applications/connectors/n8n.md

@@ -0,0 +1,21 @@
+---
+description: Did you ever dreamed to use Twake and n8n together ?
+---
+
+# n8n
+
+## How to connect Twake with n8n
+
+n8n is a powerful workflow automation tool wich can be self hosted : [n8n.io](https://n8n.io)
+
+![n8n interface](../../../assets/image.png)
+
+### Install n8n in Twake
+
+Install your n8n application in your workspace and get your key :
+
+![](../../../assets/how-to-install-n8n.gif)
+
+### Create your credential on n8n
+
+![](../../../assets/n8n-implement.gif)

Documentation/docs/how-to-use-it/applications/drive/README.md

@@ -0,0 +1,6 @@
+---
+description: How you can use the drive on Twake
+---
+
+# 📂 Drive
+

Documentation/docs/how-to-use-it/applications/drive/file-and-folder.md

@@ -0,0 +1,8 @@
+---
+description: How you can create file & folder on Twake
+---
+
+# File and folder
+
+## 
+

Documentation/docs/how-to-use-it/applications/drive/share-file-with-public-link.md

@@ -0,0 +1,21 @@
+---
+description: How you can share your files with a public link
+---
+
+# Share file with public link
+
+In Twake, you can share your folders or files to external user. You juste have to create a public link on what you want to share and send the link. Your partner will access to these elements without creating a Twake account.
+
+### Create a public link
+
+Click on "public access" of what you want to share and "create an access link".
+
+![](../../../assets/sans-titre-2-1.gif)
+
+###
+
+### Remove a public link
+
+If you want to remove the public link, select folder you want to unlink, then, "Public access" and "Suppress the link"
+
+![](../../../assets/sans-titre-2.gif)

Documentation/docs/how-to-use-it/applications/how-to-use-chat/README.md

@@ -0,0 +1,11 @@
+---
+description: How Twake chat is working
+---
+
+# 💬 Chat
+
+The discussion application are Twake's entry points. This is where you communicate with your team.
+
+[channels](channels.md)
+
+[message](message.md)

Documentation/docs/how-to-use-it/applications/how-to-use-chat/channels.md

@@ -0,0 +1,51 @@
+---
+description: Discover how channels are used on Twake
+---
+
+# Channels
+
+## Create a channel
+
+To create a channel, you must have `Administrator` rights for the workspace in question.
+
+[rights](../../company-and-workspace/rights.md)
+
+To create your channel, click on the `+` button right to the "Channel" inscription. Fill a name for your channel, select a wonderful emoji and select if it is a public or private channel \(by default, channels are private\).
+
+## Channel sections
+
+You can organize your channel by grouping them. If you are `Administrator`, you can drag a channel and drop in the section you want `Add here` or in `New group`.
+
+To edit section name, you just have to click on it, change the name and press `Enter`
+
+![](../../../assets/channel-move.gif)
+
+## Public channel
+
+Public channels are visible to all members of the workspace.
+
+## Private channel
+
+Private channels are channels accessible only to a limited number of users. Members not present in these channels cannot see them.
+
+### Modify the members of a private channel
+
+You can choose the members of a private channel when creating it. To modify the members of a private channel once created, place your mouse on the channel, click on the `...` then on `Edit channel`, in the `Participants` box, you can add or remove the members of the channel.
+
+![](../../../assets/private-channel-member.gif)
+
+## External member
+
+You have the possibility to invite external members to your channel. External members are members who are not in the workspace and who are added to one, or more, specific channel\(s\).
+
+This feature is useful for inviting users who are not in your company. Freelancers, for example, can be added to a specific channel to collaborate on a project. They will only have access to this channel, they will not see public channels.
+
+![](../../../assets/externalmember.gif)
+
+## Mute a channel
+
+You can mute a channel so that you do not receive notification of it. You will not receive a new notification from that channel unless you are mentioned \(with @username\). To do it, click on `...` and `Mute`a barred bell icon will appear.
+
+## Star a channel
+
+If a channel is very important for you, you can star it. Stared channels are gathered at the top of your channel. It is only for your view, not for everyone. To star a channel click on `...` and `Star this channel`. Your channel will be move to the stared channel section \(at the top\).

Documentation/docs/how-to-use-it/applications/how-to-use-chat/message.md

@@ -0,0 +1,59 @@
+---
+description: Send message on Twake
+---
+
+# Message
+
+## Send a message
+
+To send a message, select the channel where you want to post. In the input message, write what you want to send. Press `enter` to send the message.
+
+If you want to add a new line to your message, press `Shift + Enter`.
+
+![](../../../assets/sendmessage.gif)
+
+#### Pin
+
+If one of the message is important for the team, you can pin it \(or unpin\)
+
+![](../../../assets/pinmessage.gif)
+
+#### Reaction
+
+You can react to a message with emoji. Click on the `Emoji button` in message to show emoji picker.
+
+### Response to a message
+
+Someone ask you a question ? You can answer it by clicking `Answer` below the message.
+
+![](../../../assets/responsemessage.gif)
+
+### Reorganize your chat
+
+You can reorganize your chat by dragging and dropping your messages.
+
+![](../../../assets/d-and-dmessage.gif)
+
+###
+
+### See thread message
+
+You can see a thread in a specific view. Hover over in one, the button `Show on the right` . A side panel opens.
+
+## Integration
+
+### Gif
+
+You can send gif in your channel. Just clic gif icon to open a gif selector.
+
+![](<../../../assets/gif-(1).gif>)
+
+### Call
+
+If you need to call your team, there is native integration with Jitsi. Just click on the green button with the phone and a menu opens on the left to create a Jitsi call. Once the information is filled in, the call link is sent to your team.
+
+## Send document
+
+If you want to send a document through the chat, drag it from your computer and drop it into the chat. It will be uploaded and shared with your teammates.
+
+You can also send a document from Twake drive: click on the `+` button, to the left of the input. You can select a file from Twake and share it in the chat room.

Documentation/docs/how-to-use-it/applications/tasks.md

@@ -0,0 +1,6 @@
+---
+description: How to use Twake task
+---
+
+# ✅ Tasks
+

Documentation/docs/how-to-use-it/company-and-workspace/README.md

@@ -0,0 +1,17 @@
+---
+description: How company and workspace work on Twake
+---
+
+# 🏢 Company & workspace
+
+## Company
+
+Companies are the largest entities on Twake. They represent your virtual business. You will find all your employees and connectors that you have developed internally. Inside your company is your workspaces.
+
+You can switch from one company to an other by clicking on the left bottom button :
+
+![](../../assets/changecomp.gif)
+
+## Workspace
+
+Workspaces represent the teams or departments in your company. Each workspace has its members, discussions, files, tasks, and calendar. It's your team's sharing space.

Documentation/docs/how-to-use-it/company-and-workspace/invite-user-from-chat.md

@@ -0,0 +1,15 @@
+---
+description: Invite user from Twake
+---
+
+# Invite user from Chat
+
+You can invite user in your workspace.
+
+Open the menu, and click on `Collaborators` > `Add colleagues`. Enter emails of your colleagues \(separated with coma\) and validate.
+
+![](../../assets/invitefromtwake.gif)
+
+You can also invite users from the console :
+
+[users](../console/users.md)

Documentation/docs/how-to-use-it/company-and-workspace/rights.md

@@ -0,0 +1,70 @@
+---
+description: How rights are managed on Twake
+---
+
+# Rights
+
+Twake has several levels of rights. Users belong to one or more workspaces within the company. They can have different statuses inherent to their membership to the company or workspace
+
+## Owner
+
+He's the main administrator of the whole company. He can:
+
+- Allow connectors and applications to be installed in workspaces
+- Change the corporate identity
+- Giving/withdrawing the right "Owner of the company" to a member of the company
+
+The creator of the company is the only owner. You can not change this role. Only the creator can be owner of the company.
+
+## Admin
+
+An admin has the same right than the owner. He can:
+
+- Allow connectors and applications to be installed in workspaces
+- Change the corporate identity
+- Giving/withdrawing the right "Owner of the company" to a member of the company
+
+The creator of the company is the only owner. You can not change this role. Only the creator can be owner of the company.
+
+To grant the admin right, open the console \([https://console.twake.app](https://console.twake.app)\). Open `Users` section and `Edit` the member you want to set admin. Update the Role with `Admin` and save.
+
+![](../../assets/setadmin.gif)
+
+## Workspace administrator
+
+He's the team administrator. He has the same rights as a user. In addition, he can:
+
+- Add/remove connectors and applications in the workspace
+- Changing the identity of the workspace
+- Adding members to the workspace
+- Delete workspace
+
+By default, the creator of the workspace is the administrator. This right can be cumulated with that of a company administrator.
+
+To grant the workspace level, open your workspace collaborators page, and select `Administrator`
+
+![](../../assets/setwsadmin.gif)
+
+## User
+
+The "user" right is the default right of a member in a workspace. It can :
+
+- Read and send messages to public and private chat channels \(to which he has been invited\)
+- Create, modify, delete documents from the drive
+- Create, edit, delete events and calendars
+- Create, modify, delete tables and tasks Invite users to the workspace
+- Create a workspace within the company
+
+It's a default right. If the collaborator is not Company or Workspace administrator and he is not a Guest user, he is a simple User
+
+## Guest
+
+This status is intended for external partners working on a specific topic with the team. Guest user can :
+
+- Talk in the channel where they are invited
+
+They can not join by themself any channel \(even public\). They need to be invited by a normal user.
+
+To set the Guest level, open the console \([https://console.twake.app](https://console.twake.app)\) and the users page. Set the user's role to "Guest".
+
+![](../../assets/setguest.gif)

Documentation/docs/how-to-use-it/console/README.md

@@ -0,0 +1,12 @@
+---
+description: How to use the Twake console
+---
+
+# 🧰 Console
+
+The console is where you can manage your company and all information shared on Twake, LinShare and more.
+
+
+
+
+

Documentation/docs/how-to-use-it/console/users.md

@@ -0,0 +1,36 @@
+---
+description: How users are managed in the Twake console
+---
+
+# Users
+
+As user admin, you have access to the user management page.
+
+Open the console : [https://console.twake.app/](https://console.twake.app/) and open the page "Users".
+
+![User management page](../../assets/image-2.png)
+
+## Add a user
+
+To work with your colleagues in your company, you have 2 choices :
+
+- Create user account
+- Invite them by email
+
+You can also invite users from the chat :
+
+[invite-user-from-chat](../company-and-workspace/invite-user-from-chat.md)
+
+### Send email invitation
+
+To send an invitation, you can click on `Add user` > `Invite users`.Enter emails you want to invite separated with coma. After validation, an email is sent to this address. Your colleagues will have a link to signup and join your company.
+
+![Invite user](../../assets/inviteuser.gif)
+
+### Create user account
+
+You can create directly accounts for your colleagues. For that, click on `Add user` > `Create account`. After giving email, name and Role, you can specify a password \(or generate a random one\). You just have to send credentials to your teammate.
+
+![](../../assets/createuser.gif)
+
+## Manage user

Documentation/docs/how-to-use-it/desktop-and-mobile-app.md

@@ -0,0 +1,32 @@
+---
+description: "Yes, we have desktop and mobile apps !"
+---
+
+# 🖥 Desktop and mobile app
+
+## Desktop
+
+You can download Twake for Mac, Windows, Linux here: [https://github.com/linagora/Twake-Desktop/tree/master/download](https://github.com/linagora/Twake-Desktop/tree/master/download)
+
+Click on the version according your OS, and click on "download" to get the desktop application.
+
+![](<../assets/image-(3)-(1).png>)
+
+### Switch to on-premise servers
+
+On the desktop app, you can use the following options to change your server:
+
+• On MacOS, click on Help &gt; Change Twake Server  
+• On Windows, MacOS and Linux, use the shortcut CTRL+ALT+SHIFT+S or CMD+ALT+SHIFT+S
+
+## Mobile App
+
+The mobile app is available on iOS App Store and Android Play Store.
+
+### Switch to on-premise servers
+
+On the mobile app, just log out and you should be able to change the server from the bottom left login page link "Change Server".
+
+#### Push notifications on the on-premise mobile app
+
+This feature is not yet available, say you want this feature using a "thumbs up" emoji here: [https://github.com/TwakeApp/Twake/issues/130](https://github.com/TwakeApp/Twake/issues/130)

Documentation/docs/how-to-use-it/privacy-security.md

@@ -0,0 +1,102 @@
+# 🔒 Privacy
+
+You will find everything related to privacy in this document [https://twake.app/en/privacy/](https://twake.app/en/privacy/).
+
+At Twake we are committed to protecting your privacy. We implemented specific security features to ensure that your data is safe and secure.
+
+## General presentation of Twake
+
+Twake is available in two main versions :
+
+- SaaS : Twake as a service (SaaS available on twake.app)
+- On-Premise : Twake on-premise (on private servers or on dedicated servers managed by
+  Twake)
+
+The Twake SaaS version is hosted in France by a French infrastructure provider. All servers are located in Paris (UE).
+
+The Twake On-Premise version can be deployed on any local server and can work fully disconnected from the Internet or with an unique and unidirectional connection to twake.app for licencing management, mailing and iOS and Android push notifications (that are not available without additional configuration in fully disconnected mode).
+
+On SaaS version, Twake provide two main tiers softwares :
+
+- ONLYOFFICE spreadsheet, ONLYOFFICE document and ONLYOFFICE presentation, https://
+  onlyoffice.com
+- Jitsi video-conferencing, https://jitsi.org/
+
+On the On-Premise version those softwares are optionals.
+
+## Quick FAQ about Twake security
+
+#### Where are your servers ?
+
+Twake servers are all in France, in Paris.
+
+#### Are you GRPD compliant ?
+
+Yes ! As you can see in this document, we do everything we can do to protect your personal and professional data. Concerning your password and personal data specifically, passwords are hashed using PBKDF2, your data is encrypted before to be sent to the database (encryption at rest on the application layer) and we use TLS.0 for communications (encryption on transit). Moreover, we do not require any personal data in order for you to use our software, you can use Twake without disclosing personal information.
+
+#### What protocol do you use ?
+
+We use HTTPS for unidirectional traffic encryption and WSS for bidirectional realtime traffic encryption. Passwords are hashed with PBKDF2. Files are encrypted with OpenSSL AES-256-CBC with a key composed of three parts stored in database, in code and in the server configuration. Finally our database data is encrypted with OpenSSL AES-256-CBC. In order to always improve our security, next version of Twake will include full end-to-end encryption for direct and private channels using the Matrix protocol.
+
+#### How do you manage backups ?
+
+We backup our encrypted database and your encrypted documents in a replicated Object Storage. We keep a backup of each month and a backup of each of the last seven days.
+
+#### What if I want to export all my data ?
+
+We do not provide an export feature on the software itself. But we have the ability to export your data on-demand, please contact us for more information.
+
+#### Can I delete my account and erase my data ?
+
+Yes, you can delete your account and erase your data. To proceed, open your account from the "console" and click on "Delete my account". You will be asked to confirm your choice. Once your account is deleted, you will not be able to access it anymore.
+
+#### How do you manage security with tiers applications and modules ?
+
+We cannot guarantee the security of the data you send to tiers applications and modules. If you work with an external app like Zapier or Giphy, they will have access to some of your information. You can see the access scope of an application before to add it to your company.
+
+## High availability
+
+Twake is built on scalable technologies and allow us to scale to million users but also to be fault tolerant. We define two kind of replication, hardware replication and software replication:
+
+Hardware replication in case of hard disk crash or network issue is managed by our infrastructure provider, you will find more details on how they manage this following these links:
+
+- Servers: https://www.ovhcloud.com/en/public-cloud/
+- Object storage and backups: https://www.ovhcloud.com/en/public-cloud/object-storage/
+
+Software replication is done by ourself. Each middleware and nodes used by Twake are replicated at least three time. In the rare case of node failure, our system automatically alerts us and start using the remaining available node until we operate and fix the broken one.
+
+## Application encryption
+
+Data are stored encrypted in ScyllaDB and searchable entities will be stored in Elastic Search.
+
+#### ScyllaDB
+
+Any data (except non-sensible data like identifiers, dates and counters) stored in ScyllaDB is encrypted using OpenSSL AES-256-CBC before being sent to the database.
+
+#### Indexed search storage
+
+We provide advanced search features to our product Twake using Elastic Search to index our entities. Entities are not stored in Elastic Search and only indexes will be available if Twake Elastic Search servers are compromised.
+
+## Other
+
+#### Random token generation
+
+For random generation we use the PHP built-in random_bytes function with bin2hex if needed on PHP side and the crypto library with randomBytes from NodeJS and frontend side.
+
+#### Passwords storage and authentication
+
+Passwords are not stored in clear, only a hash of it is stored in database. We use the hash_pbkdf2 method with a randomly generated salt for each user.
+
+#### SQL Injection
+
+Each database access use Doctrine ORM sanitisation before write or reads, we never use custom access to the database to reduce risks of injection. We developed a middleware to use ScyllaDB databases but this middleware works after Doctrine ORM sanitisation.
+On NodeJS, we also implemented an ORM for all database access in order to keep this level of security.
+
+#### XSS
+
+We use React as front-end framework and we never execute tiers Javascript. External apps are loaded in webviews or iframes and use a bridge designed like a router for data exchange between frames.
+
+## Continuous security checks
+
+- We use Snyk to ensure that our dependencies are up to date and secure.
+- We are active on huntr.dev to ensure that we fix all security issues reported by the community.

Documentation/docs/how-to-use-it/welcome.md

@@ -0,0 +1,10 @@
+---
+description: Discover how to use Twake
+---
+
+# 👋 Welcome to Twake !
+
+Twake is an open source collaborative workspace. It can be self-hosted, used is saas and easily integrated into your teams. Twake offers all the features for collaboration :  team chat, file storage, team calendar,  tasks manager.
+
+In this chapter, you'll find how to use Twake.
+