eduvia/workavia-drive
11
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: updated documentation (#476)

Browse Source 
Co-authored-by: Monta <monta@HP-ProBook-445-14-inch-G9-Notebook-PC-505aadfc.localdomain>
This commit is contained in:
Montassar Ghanmy
2024-05-07 17:21:17 +01:00
committed by GitHub
parent 3b20806622
commit 24da0c8cfb
22 changed files with 102 additions and 858 deletions
Download Patch File Download Diff File Expand all files Collapse all files
Documentation/docs/onprem/configuration/index.md
+4 -4
View File
@@ -1,16 +1,16 @@
---
description: More details about TDrive configuration.
description: More details about Twake Drive configuration.
---
# ⚙️ Server configuration
### Detach the configuration and start using your own
Each configuration file is optional, if not given, TDrive will fallback to default configuration.
Each configuration file is optional, if not given, Twake Drive will fallback to default configuration.
#### Backend configuration
You can find an example of TDrive configuration (default configuration) here: [https://github.com/TDriveApp/TDrive/blob/main/tdrive/backend/node/config/default.json](https://github.com/TDriveApp/TDrive/blob/main/tdrive/backend/node/config/default.json)
You can find an example of Twake Drive configuration (default configuration) here: [https://github.com/linagora/twake-drive/blob/main/tdrive/backend/node/config/default.json](https://github.com/linagora/twake-drive/blob/main/tdrive/backend/node/config/default.json)
Copy the content of this file and put it in `[docker-compose.yml location]/configuration/backend-node/production.json`
@@ -18,7 +18,7 @@ Copy the content of this file and put it in `[docker-compose.yml location]/confi
#### Frontend configuration (only for scalable mode)
You can find an example of TDrive configuration (default configuration) here: [https://github.com/TDriveApp/TDrive/blob/main/tdrive/frontend/src/app/environment/environment.ts.dist](https://github.com/TDriveApp/TDrive/blob/main/tdrive/frontend/src/app/environment/environment.ts.dist)
You can find an example of Twake Drive configuration (default configuration) here: [https://github.com/linagora/twake-drive/blob/main/tdrive/frontend/src/app/environment/environment.ts.dist](https://github.com/linagora/twake-drive/blob/main/tdrive/frontend/src/app/environment/environment.ts.dist)
Copy the content of this file and put it in `[docker-compose.yml location]/configuration/frontend/environment.ts`
Documentation/docs/onprem/configuration/security.md
+3 -3
View File
@@ -1,12 +1,12 @@
---
description: You should update this security keys to ship TDrive in production.
description: You should update this security keys to ship Twake Drive in production.
---
# 🔒 Security
<!-- TODO[NOT UP TO DATE] -->
> See how to [Detach Configuration](./) first.
The following keys must be updated to increase TDrive security in [docker-compose.yml location]/configuration/backend-node/production.json:
The following keys must be updated to increase Twake Drive security in [docker-compose.yml location]/configuration/backend-node/production.json:
```json
{
Documentation/docs/onprem/installation.md
+21 -21
View File
@@ -1,32 +1,32 @@
# 🏗 Install on your server
## Use TDrive in SaaS
## Use Twake Drive in SaaS
You can test or use TDrive in our SaaS : [chat.tdrive.app](https://chat.tdrive.app)
You can test or use Twake Drive in our SaaS : [chat.tdrive.app](https://chat.tdrive.app)
## Run TDrive in your server
## Run Twake Drive in your server
1. First you'll need to [install docker and docker-compose](https://docs.docker.com/compose/install/).
2. Then you can install TDrive on your server with this command
2. Then you can install Twake Drive on your server with this command
```
git clone https://github.com/TDriveApp/TDrive.git
cd TDrive/tdrive
git clone git@github.com:linagora/twake-drive.git
cd tdrive/tdrive
docker-compose -f docker-compose.onpremise.mongo.yml up -d
```
TDrive will be running on port 3000
Twake Drive will be running on port 3000
### What's next ?
If you kept the default configuration, you can simply follow the signup steps, no email verification is required by default so you will get into TDrive right after the signup steps.
If you kept the default configuration, you can simply follow the signup steps, no email verification is required by default so you will get into Twake Drive right after the signup steps.
## Ship TDrive in production
## Ship Twake Drive in production
See how to [manage configuration](./configuration/index.md)). And then how to [update security keys](./configuration/security.md).
### Update TDrive
### Update Twake Drive
```
docker-compose stop
@@ -42,21 +42,21 @@ Currently you'll need at least a **2 cpu + 4 gb of ram** machine for **20-50 use
If you enable ElasticSearch, use two machines, or limit the cpu/ram dedicated to it and use a larger machine (at least 2gb of ram and 1 cpu dedicated to ES for 20-50 users).
If you need to deploy TDrive for more users, you can use only one big machine up to 500 users (Will need something like **12 cpu and 32go of ram**), then you'll need to use multiple nodes.
If you need to deploy Twake Drive for more users, you can use only one big machine up to 500 users (Will need something like **12 cpu and 32go of ram**), then you'll need to use multiple nodes.
---
# 🎡 Scale with TDrive
# 🎡 Scale with Twake Drive
<!-- TODO[NOT UP TO DATE] -->
> We deployed Twake Drive on production for companies of 10 to 50 users in a single node. We also deployed Twake Drive in a scalable mode and we support currently thousands of concurrent users.
> If you deploy Twake Drive in your own company we would love to have your feedback here [https://github.com/TDriveApp/TDrive/issues/289](https://github.com/TDriveApp/TDrive/issues/289) to improve our requirements documentation.
> Now if you want to scale with Twake Drive and support thousand of users, continue reading.
> We deployed TDrive on production for companies of 10 to 50 users in a single node. We also deployed TDrive in a scalable mode and we support currently thousands of concurrent users.
> If you deploy TDrive in your own company we would love to have your feedback here [https://github.com/TDriveApp/TDrive/issues/289](https://github.com/TDriveApp/TDrive/issues/289) to improve our requirements documentation.
> Now if you want to scale with TDrive and support thousand of users, continue reading.
Scaling with TDrive is possible if you install TDrive with **RabbitMQ, Redis, ElasticSearch and ScyllaDB**.
Scaling with Twake Drive is possible if you install Twake Drive with **RabbitMQ, Redis, ElasticSearch and ScyllaDB**.
```
git clone https://github.com/TDriveApp/TDrive.git
cd TDrive/tdrive
git clone git@github.com:linagora/twake-drive.git
cd twake-drive/tdrive
cp -n docker-compose.yml.dist.onpremise docker-compose.yml
cp -nR default-configuration/ configuration/
@@ -71,8 +71,8 @@ sleep 10m #Wait php to create tables in scylladb
docker-compose up -d
```
> To run ElasticSearch (optional, but enabled by default in the TDrive docker-compose) you must increase the max_map_count of your system: [https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#\_set_vm_max_map_count_to_at_least_262144](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#_set_vm_max_map_count_to_at_least_262144)
> To run ElasticSearch (optional, but enabled by default in the Twake Drive docker-compose) you must increase the max_map_count of your system: [https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#\_set_vm_max_map_count_to_at_least_262144](https://www.elastic.co/guide/en/elasticsearch/reference/current/docker.html#_set_vm_max_map_count_to_at_least_262144)
>
> To fix an other bug with ElasticSearch container, you must also run this command: `chmod 777 ./docker-data/es_tdrive` (create the folder if it doesn't exists in your docker-compose.yml folder)
TDrive will be running on port 8000 🎉
Twake Drive will be running on port 8000 🎉