Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: updated the developer docs #8112

Closed
wants to merge 2 commits into from
Closed

feat: updated the developer docs #8112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9fd3d58
feat: updated the developer docs
Khaan25 Oct 27, 2024
d1e652c
feat: improved docs
Khaan25 Oct 27, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 7 additions & 25 deletions packages/twenty-website/src/content/developers/self-hosting/cloud-providers.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,9 @@ image: /images/user-guide/notes/notes_header.png
---

<ArticleWarning>
This document is maintained by the community. It might contain issues.
This document is maintained by the community. It might contain issues.
</ArticleWarning>


## Kubernetes via Terraform and Manifests

Community-led documentation for Kubernetes deployment is available (here)[https://github.com/twentyhq/twenty/tree/main/packages/twenty-docker/k8s]
Expand All @@ -19,14 +18,12 @@ Community-led, might not be up to date

[![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/twentyhq/twenty)


## RepoCloud
## RepoCloud

Community-led, might not be up to date

[![Deploy on RepoCloud](https://d16t0pc4846x52.cloudfront.net/deploy.png)](https://repocloud.io/details/?app_id=259)


## Azure Container Apps

Community-led, might not be up to date
Expand Down Expand Up @@ -271,11 +268,8 @@ resource "azapi_update_resource" "cors" {
```hcl
# backend.tf

# Create three random UUIDs
resource "random_uuid" "access_token_secret" {}
resource "random_uuid" "login_token_secret" {}
resource "random_uuid" "refresh_token_secret" {}
resource "random_uuid" "file_token_secret" {}
# Create app random UUID
resource "random_uuid" "app_secret" {}

resource "azurerm_container_app" "twenty_server" {
name = local.server_name
Expand Down Expand Up @@ -343,20 +337,8 @@ resource "azurerm_container_app" "twenty_server" {
value = "https://${local.front_app_name}"
}
env {
name = "ACCESS_TOKEN_SECRET"
value = random_uuid.access_token_secret.result
}
env {
name = "LOGIN_TOKEN_SECRET"
value = random_uuid.login_token_secret.result
}
env {
name = "REFRESH_TOKEN_SECRET"
value = random_uuid.refresh_token_secret.result
}
env {
name = "FILE_TOKEN_SECRET"
value = random_uuid.file_token_secret.result
name = "APP_SECRET"
value = random_uuid.app_secret.result
}
}
}
Expand Down Expand Up @@ -446,4 +428,4 @@ resource "azurerm_container_app" "twenty_db" {

Please feel free to Open a PR to add more Cloud Provider options.

<ArticleEditContent></ArticleEditContent>
<ArticleEditContent></ArticleEditContent>
9 changes: 3 additions & 6 deletions packages/twenty-website/src/content/developers/self-hosting/docker-compose.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,21 +46,18 @@ Follow these steps for a manual setup.

2. **Generate Secret Tokens**

Run the following command four times to generate four unique random strings:
Run the following command to generate a unique random string:
```bash
openssl rand -base64 32
```
**Important:** Keep these tokens secure and do not share them.

3. **Update the `.env`**

Replace the placeholder values in your .env file with the generated tokens:
Replace the placeholder value in your .env file with the generated token:

```ini
ACCESS_TOKEN_SECRET=first_random_string
LOGIN_TOKEN_SECRET=second_random_string
REFRESH_TOKEN_SECRET=third_random_string
FILE_TOKEN_SECRET=fourth_random_string
APP_SECRET=first_random_string
```
**Note:** Only modify these lines unless instructed otherwise.

Expand Down
5 changes: 1 addition & 4 deletions packages/twenty-website/src/content/developers/self-hosting/self-hosting-var.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,14 +54,11 @@ yarn command:prod cron:calendar:calendar-event-list-fetch
### Tokens

<ArticleTable options={[
['ACCESS_TOKEN_SECRET', '<random>', 'Secret used for the access tokens'],
['APP_SECRET', '<random>', 'Secret used for the app tokens'],
['ACCESS_TOKEN_EXPIRES_IN', '30m', 'Access token expiration time'],
['LOGIN_TOKEN_SECRET', '<random>', 'Secret used for the login tokens'],
['LOGIN_TOKEN_EXPIRES_IN', '15m', 'Login token expiration time'],
['REFRESH_TOKEN_SECRET', '<random>', 'Secret used for the refresh tokens'],
['REFRESH_TOKEN_EXPIRES_IN', '90d', 'Refresh token expiration time'],
['REFRESH_TOKEN_COOL_DOWN', '1m', 'Refresh token cooldown'],
['FILE_TOKEN_SECRET', '<random>', 'Secret used for the file tokens'],
['FILE_TOKEN_EXPIRES_IN', '1d', 'File token expiration time'],
['API_TOKEN_EXPIRES_IN', '1000y', 'Api token expiration time'],
]}></ArticleTable>
Expand Down
Loading