Created by Github action --------- Co-authored-by: Abdul Rahman <ar5438376@gmail.com> Co-authored-by: Crowdin Bot <support+bot@crowdin.com> Co-authored-by: github-actions <github-actions@twenty.com> Co-authored-by: Charles Bochet <charles@twenty.com>
251 lines
9.4 KiB
Plaintext
251 lines
9.4 KiB
Plaintext
---
|
|
title: Opstelling
|
|
image: /images/user-guide/table-views/table.png
|
|
---
|
|
|
|
<Frame>
|
|
<img src="/images/user-guide/table-views/table.png" alt="Header" />
|
|
</Frame>
|
|
|
|
import OptionTable from '@site/src/theme/OptionTable'
|
|
|
|
# Konfigurasiebestuur
|
|
|
|
<Warning>
|
|
**First time installing?** Follow the [Docker Compose installation guide](https://docs.twenty.com/l/af/developers/self-hosting/docker-compose) to get Twenty running, then return here for configuration.
|
|
</Warning>
|
|
|
|
Twenty bied **twee konfigurasiemodusse** aan om by verskillende implementeringsbehoeftes te pas:
|
|
|
|
**Toegang tot administrasiepaneel:** Slegs gebruikers met administrateurvoorregte (`canAccessFullAdminPanel: true`) kan toegang verkry tot die konfigurasiekoppelvlak.
|
|
|
|
## 1. Administrasiepaneelkonfigurasie (Verstek)
|
|
|
|
```bash
|
|
IS_CONFIG_VARIABLES_IN_DB_ENABLED=true # default
|
|
```
|
|
|
|
**Meeste konfigurasie gebeur deur die UI** na installasie:
|
|
|
|
1. Verkry toegang tot jou Twenty-instansie (gewoonlik `http://localhost:3000`)
|
|
2. Gaan na **Instellings / Administrasiepaneel / Konfigurasieveranderlikes**
|
|
3. Konfigureer integrasies, e-pos, berging, en meer
|
|
4. Veranderings tref onmiddellik in werking (binne 15 sekondes vir multi-houer implementasies)
|
|
|
|
<Warning>
|
|
**Multi-Houer Implementasies:** Wanneer databasis konfigurasie gebruik word (`IS_CONFIG_VARIABLES_IN_DB_ENABLED=true`), lees beide die bediener en werker houers vanaf dieselfde databasis. Veranderings aan die administrasiepaneel raak beide outomaties, wat die behoefte om omgewing veranderlikes tussen houers te dupliseer uitskakel (behalwe vir infrastruktuur veranderlikes).
|
|
</Warning>
|
|
|
|
**Wat jy deur die administrasiepaneel kan konfigureer:**
|
|
|
|
- **Verifikasie** - Google/Microsoft OAuth, wagwoordinstellings
|
|
- **E-pos** - SMTP instellings, templates, verifikasie
|
|
- **Berging** - S3 konfigurasie, plaaslike berging paaie
|
|
- **Integrasies** - Gmail, Google Kalender, Microsoft dienste
|
|
- **Workflow & Rate Limiting** - Execution limits, API throttling
|
|
- **En baie meer...**
|
|
|
|

|
|
|
|
<Warning>
|
|
Elke veranderlike word gedokumenteer met beskrywings in jou administrasiepaneel by **Instellings → Administrasiepaneel → Konfigurasieveranderlikes**.
|
|
Sommige infrastruktuurinstellings soos databasisverbindings (`PG_DATABASE_URL`), bediener URL's (`SERVER_URL`), en toepassingsgeheime (`APP_SECRET`) kan slegs via `.env` lêer gekonfigureer word.
|
|
|
|
[Complete technical reference →](https://github.com/twentyhq/twenty/blob/main/packages/twenty-server/src/engine/core-modules/twenty-config/config-variables.ts) </Warning>
|
|
|
|
## 2. Slegs Omgewingskonfigurasie
|
|
|
|
```bash
|
|
IS_CONFIG_VARIABLES_IN_DB_ENABLED=false
|
|
```
|
|
|
|
**Alle konfigurasie deur `.env` lêers bestuur:**
|
|
|
|
1. Stel `IS_CONFIG_VARIABLES_IN_DB_ENABLED=false` in jou `.env` lêer
|
|
2. Voeg alle konfigurasie veranderlikes in jou `.env` lêer
|
|
3. Herbegin houers om veranderinge in werking te laat tree
|
|
4. Administrasiepaneel sal huidige waardes vertoon, maar kan dit nie wysig nie
|
|
|
|
## Gmail & Google Kalender Integrasie
|
|
|
|
### Skep 'n Google Cloud Projek
|
|
|
|
1. Gaan na [Google Cloud Console](https://console.cloud.google.com/)
|
|
2. Skep 'n nuwe projek of kies 'n bestaande een
|
|
3. Aktiveer hierdie API's:
|
|
|
|
- [Gmail API](https://console.cloud.google.com/apis/library/gmail.googleapis.com)
|
|
- [Google Kalender API](https://console.cloud.google.com/apis/library/calendar-json.googleapis.com)
|
|
- [People API](https://console.cloud.google.com/apis/library/people.googleapis.com)
|
|
|
|
### Konfigureer OAuth
|
|
|
|
1. Gaan na [Geloofsbriewe](https://console.cloud.google.com/apis/credentials)
|
|
2. Skep OAuth 2.0 Kliënt-ID
|
|
3. Voeg hierdie herleiding URI's by:
|
|
- `https://{your-domain}/auth/google/redirect` (for SSO)
|
|
- `https://{your-domain}/auth/google-apis/get-access-token` (for integrations)
|
|
|
|
### Konfigureer in Twenty
|
|
|
|
1. Gaan na **Instellings → Administrasiepaneel → Konfigurasieveranderlikes**
|
|
2. Vind die **Google Auth** afdeling
|
|
3. Stel hierdie veranderlikes in:
|
|
- `MESSAGING_PROVIDER_GMAIL_ENABLED=true`
|
|
- `CALENDAR_PROVIDER_GOOGLE_ENABLED=true`
|
|
- `AUTH_GOOGLE_CLIENT_ID={client-id}`
|
|
- `AUTH_GOOGLE_CLIENT_SECRET={client-secret}`
|
|
- `AUTH_GOOGLE_CALLBACK_URL=https://{your-domain}/auth/google/redirect`
|
|
- `AUTH_GOOGLE_APIS_CALLBACK_URL=https://{your-domain}/auth/google-apis/get-access-token`
|
|
|
|
<Warning>
|
|
**Environment-only mode:** If you set `IS_CONFIG_VARIABLES_IN_DB_ENABLED=false`, add these variables to your `.env` file instead.
|
|
</Warning>
|
|
|
|
**Vereiste omvang** (outomaties gekonfigureer):
|
|
[Sien relevante bronkode](https://github.com/twentyhq/twenty/blob/main/packages/twenty-server/src/engine/core-modules/auth/utils/get-google-apis-oauth-scopes.ts#L4-L10)
|
|
|
|
- `https://www.googleapis.com/auth/calendar.events`
|
|
- `https://www.googleapis.com/auth/gmail.readonly`
|
|
- `https://www.googleapis.com/auth/profile.emails.read`
|
|
|
|
### As jou toepassing in toetsmodus is
|
|
|
|
As jou toepassing in toetsmodus is, sal jy toetsgebruikers by jou projek moet voeg.
|
|
|
|
Onder [OAuth toestemming skerm](https://console.cloud.google.com/apis/credentials/consent), voeg jou toetsgebruikers by die "Toetsgebruikers" afdeling.
|
|
|
|
## Microsoft 365 Integrasie
|
|
|
|
<Warning>
|
|
Gebruikers moet 'n [Microsoft 365 Lisensie](https://admin.microsoft.com/Adminportal/Home) hê om van die Kalender en Boodskap API gebruik te kan maak. Hulle sal nie hul rekening op Twenty sonder een kan sinchroniseer nie.
|
|
</Warning>
|
|
|
|
### Skep 'n projek in Microsoft Azure
|
|
|
|
Jy sal 'n projek in [Microsoft Azure](https://portal.azure.com/#view/Microsoft_AAD_IAM/AppGalleryBladeV2) moet skep en die geloofsbriewe kry.
|
|
|
|
### Aktiveer API's
|
|
|
|
Op Microsoft Azure Console aktiveer die volgende API's in "Toestemmings":
|
|
|
|
- Microsoft Graph: Mail.ReadWrite
|
|
- Microsoft Graph: Mail.Send
|
|
- Microsoft Graph: Calendars.Read
|
|
- Microsoft Graph: User.Read
|
|
- Microsoft Graph: openid
|
|
- Microsoft Graph: email
|
|
- Microsoft Graph: profiel
|
|
- Microsoft Graph: offline_access
|
|
|
|
Let op: "Mail.ReadWrite" en "Mail.Send" is slegs verpligtend as jy e-posse wil stuur deur ons werkvloeiaaksies. Jy kan "Mail.Read" in plaas gebruik as jy slegs e-posse wil ontvang.
|
|
|
|
### Gemagtigde herleidings URI's
|
|
|
|
U moet die volgende herleidings URI's by u projek voeg:
|
|
|
|
- `https://{your-domain}/auth/microsoft/redirect` if you want to use Microsoft SSO
|
|
- `https://{your-domain}/auth/microsoft-apis/get-access-token`
|
|
|
|
### Konfigureer in Twenty
|
|
|
|
1. Gaan na **Instellings → Administrasiepaneel → Konfigurasieveranderlikes**
|
|
2. Vind die **Microsoft Auth** afdeling
|
|
3. Stel hierdie veranderlikes in:
|
|
- `MESSAGING_PROVIDER_MICROSOFT_ENABLED=true`
|
|
- `CALENDAR_PROVIDER_MICROSOFT_ENABLED=true`
|
|
- `AUTH_MICROSOFT_ENABLED=true`
|
|
- `AUTH_MICROSOFT_CLIENT_ID={client-id}`
|
|
- `AUTH_MICROSOFT_CLIENT_SECRET={client-secret}`
|
|
- `AUTH_MICROSOFT_CALLBACK_URL=https://{your-domain}/auth/microsoft/redirect`
|
|
- `AUTH_MICROSOFT_APIS_CALLBACK_URL=https://{your-domain}/auth/microsoft-apis/get-access-token`
|
|
|
|
<Warning>
|
|
**Environment-only mode:** If you set `IS_CONFIG_VARIABLES_IN_DB_ENABLED=false`, add these variables to your `.env` file instead.
|
|
</Warning>
|
|
|
|
### Konfigureer omvang
|
|
|
|
[Sien relevante bronkode](https://github.com/twentyhq/twenty/blob/main/packages/twenty-server/src/engine/core-modules/auth/utils/get-microsoft-apis-oauth-scopes.ts#L2-L9)
|
|
|
|
- 'openid'
|
|
- 'e-pos'
|
|
- 'profiel'
|
|
- 'offline_access'
|
|
- 'Mail.ReadWrite'
|
|
- 'Mail.Send'
|
|
- 'Calendars.Read'
|
|
|
|
### As jou toepassing in toetsmodus is
|
|
|
|
As jou toepassing in toetsmodus is, sal jy toetsgebruikers by jou projek moet voeg.
|
|
|
|
Voeg jou toetsgebruikers by die "Gebruikers en groepe" afdeling.
|
|
|
|
## Agtergrondtake vir Kalender & Boodskappe
|
|
|
|
Na die konfigurasie van Gmail, Google Kalender, of Microsoft 365 integrasies, moet jy die agtergrondtake begin wat data sinkroniseer.
|
|
|
|
Registreer die volgende herhaalde take in jou werkerhouer:
|
|
|
|
```bash
|
|
# from your worker container
|
|
yarn command:prod cron:messaging:messages-import
|
|
yarn command:prod cron:messaging:message-list-fetch
|
|
yarn command:prod cron:calendar:calendar-event-list-fetch
|
|
yarn command:prod cron:calendar:calendar-events-import
|
|
yarn command:prod cron:messaging:ongoing-stale
|
|
yarn command:prod cron:calendar:ongoing-stale
|
|
yarn command:prod cron:workflow:automated-cron-trigger
|
|
```
|
|
|
|
## E-poskonfigurasie
|
|
|
|
1. Gaan na **Instellings → Administrasiepaneel → Konfigurasieveranderlikes**
|
|
2. Vind die **E-Pos** afdeling
|
|
3. Konfigureer jou SMTP-instellings:
|
|
|
|
<ArticleTabs label1="Gmail" label2="Office365" label3="Smtp4dev">
|
|
|
|
<ArticleTab>
|
|
|
|
Jy moet 'n [App Wagwoord](https://support.google.com/accounts/answer/185833) voorsien.
|
|
|
|
- EMAIL_DRIVER=smtp
|
|
- EMAIL_SMTP_HOST=smtp.gmail.com
|
|
- EMAIL_SMTP_PORT=465
|
|
- EMAIL_SMTP_USER=gmail_email_address
|
|
- EMAIL_SMTP_PASSWORD='gmail_app_password'
|
|
|
|
</ArticleTab>
|
|
|
|
<ArticleTab>
|
|
|
|
**smtp4dev** is 'n vals SMTP e-posbediener vir ontwikkeling en toetsing.
|
|
|
|
- EMAIL_DRIVER=smtp
|
|
- EMAIL_SMTP_HOST=smtp.office365.com
|
|
- EMAIL_SMTP_PORT=587
|
|
- EMAIL_SMTP_USER=office365_email_address
|
|
- EMAIL_SMTP_PASSWORD='office365_password'
|
|
|
|
</ArticleTab>
|
|
|
|
<ArticleTab>
|
|
|
|
**smtp4dev** is 'n vals SMTP e-posbediener vir ontwikkeling en toetsing.
|
|
|
|
- Voer die smtp4dev-beeld uit: `docker run --rm -it -p 8090:80 -p 2525:25 rnwood/smtp4dev`
|
|
- Toegang die smtp4dev UI hier: [http://localhost:8090](http://localhost:8090)
|
|
- Stel die volgende veranderlikes in:
|
|
- EMAIL_DRIVER=smtp
|
|
- EMAIL_SMTP_HOST=localhost
|
|
- EMAIL_SMTP_PORT=2525
|
|
|
|
</ArticleTab>
|
|
|
|
</ArticleTabs>
|
|
|
|
<Warning>
|
|
**Environment-only mode:** If you set `IS_CONFIG_VARIABLES_IN_DB_ENABLED=false`, add these variables to your `.env` file instead.
|
|
</Warning> |