Salt la conținutul principal

Documentation Index

Fetch the complete documentation index at: https://docs.twenty.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Gestionarea configurației

Prima instalare? Urmați ghidul de instalare Docker Compose pentru a rula Twenty, apoi reveniți aici pentru configurare.
Twenty oferă două moduri de configurare pentru a se potrivi nevoilor diferite de implementare: Acces la panoul de administrare: Doar utilizatorii cu privilegii de administrator (canAccessFullAdminPanel: true) pot accesa interfața de configurare.

​
1. Configurare Panou Admin (Implicită)

IS_CONFIG_VARIABLES_IN_DB_ENABLED=true  # implicit
Majoritatea configurărilor se fac prin UI după instalare:
  1. Accesați instanța dumneavoastră Twenty (de obicei http://localhost:3000)
  2. Mergeți la Setări / Panou Admin / Variabile de Configurare
  3. Configurați integrările, e-mailul, stocarea și multe altele
  4. Schimbările intră în vigoare imediat (în termen de 15 secunde pentru implementări cu mai multe containere)
Implementări Multi-Container: Când utilizați configurarea bazei de date (IS_CONFIG_VARIABLES_IN_DB_ENABLED=true), atât serverul cât și containerele worker citesc din aceeași bază de date. Modificările din panoul de administrare afectează ambele automat, eliminând necesitatea duplicării variabilelor de mediu între containere (cu excepția variabilelor de infrastructură).
Ce puteți configura prin panoul de administrare:
  • Autentificare - OAuth Google/Microsoft, setări parole
  • E-mail - setări SMTP, șabloane, verificare
  • Stocare - configurație S3, căi stocare locală
  • Integrări - Gmail, Google Calendar, servicii Microsoft
  • Flux de lucru și limitarea ratei - limite de execuție, limitarea ratei pentru API
  • Și multe altele…
Variabile de Configurare Panou Admin
Fiecare variabilă este documentată cu descrieri în panoul dvs. de administrare la Setări → Panou Admin → Variabile de Configurare. Unele setări de infrastructură, cum ar fi conexiunile la baze de date (PG_DATABASE_URL), URL-urile serverului (SERVER_URL) și secretele (ENCRYPTION_KEY, FALLBACK_ENCRYPTION_KEY) pot fi configurate doar prin fișierul .env.Referință tehnică completă →

​
Chei de criptare

Twenty folosește două chei de criptare disponibile doar prin variabile de mediu:
VariabilăScopObligatoriu
ENCRYPTION_KEYCheia principală folosită pentru a cripta secretele în repaus (token-uri OAuth, variabile de aplicație, chei private de semnare, secrete TOTP, valori de configurare sensibile).Da, pentru instalările noi (instalările vechi se pot baza în schimb pe APP_SECRET — vezi mai jos)
FALLBACK_ENCRYPTION_KEYCheie folosită doar pentru verificare. Setată în timpul unei rotații la precedenta ENCRYPTION_KEY astfel încât rândurile existente să rămână decriptabile.Doar în timpul rotației
Pentru compatibilitate cu versiunile anterioare, dacă ENCRYPTION_KEY nu este setată, Twenty revine la APP_SECRET pentru criptarea în repaus — respectând comportamentul moștenit pentru implementările mai vechi. Instalările noi ar trebui să seteze întotdeauna o ENCRYPTION_KEY dedicată. Generează valori cu openssl rand -base64 32 și stochează-le într-un loc sigur (un manager de secrete, configurație sigilată etc.). Pierderea ENCRYPTION_KEY înseamnă pierderea accesului la fiecare secret stocat în baza de date. Pentru a roti ENCRYPTION_KEY fără timp de nefuncționare, vezi Ghidul de rotație a cheilor.

​
2. Configurare Doar Mediu

IS_CONFIG_VARIABLES_IN_DB_ENABLED=false
Toate configurațiile gestionate prin fișiere .env:
  1. Setați IS_CONFIG_VARIABLES_IN_DB_ENABLED=false în fișierul dvs. .env
  2. Adăugați toate variabilele de configurare în fișierul dvs. .env
  3. Reporniți containerele pentru ca schimbările să aibă efect
  4. Panoul de administrare va afișa valorile curente, dar nu le poate modifica

​
Mod cu mai multe spații de lucru

În mod implicit, Twenty rulează în modul cu un singur spațiu de lucru — ideal pentru majoritatea implementărilor auto-găzduite în care aveți nevoie de o singură instanță CRM pentru organizația dvs.

​
Modul cu un singur spațiu de lucru (implicit)

IS_MULTIWORKSPACE_ENABLED=false  # default
  • Un spațiu de lucru pentru fiecare instanță Twenty
  • Primul utilizator devine automat administrator cu privilegii complete (canImpersonate și canAccessFullAdminPanel)
  • Înregistrările noi sunt dezactivate după crearea primului spațiu de lucru
  • Structură URL simplă: https://your-domain.com

​
Activarea modului cu mai multe spații de lucru

IS_MULTIWORKSPACE_ENABLED=true
DEFAULT_SUBDOMAIN=app  # default value
Activați modul cu mai multe spații de lucru pentru implementări de tip SaaS, în care mai multe echipe independente au nevoie de propriile spații de lucru pe aceeași instanță Twenty. Diferențe cheie față de modul cu un singur spațiu de lucru:
  • Pe aceeași instanță pot fi create mai multe spații de lucru
  • Fiecare spațiu de lucru primește propriul subdomeniu (de ex., sales.your-domain.com, marketing.your-domain.com)
  • Utilizatorii se înregistrează și se autentifică la {DEFAULT_SUBDOMAIN}.your-domain.com (de ex., app.your-domain.com)
  • Fără privilegii administrative automate — primul utilizator din fiecare spațiu de lucru este un utilizator obișnuit
  • Setări specifice spațiului de lucru, precum subdomeniu și domeniu personalizat, devin disponibile în setările spațiului de lucru
Setare exclusiv de mediu: IS_MULTIWORKSPACE_ENABLED poate fi configurată doar prin fișierul .env și necesită o repornire. Nu poate fi modificată prin panoul de administrare.

​
Configurarea DNS pentru modul cu mai multe spații de lucru

Când folosiți modul cu mai multe spații de lucru, configurați DNS-ul cu o înregistrare wildcard pentru a permite crearea dinamică de subdomenii: 
*.your-domain.com -> your-server-ip
Acest lucru permite rutarea automată a subdomeniilor pentru spațiile de lucru noi, fără configurare DNS manuală.

​
Restricționarea creării de spații de lucru

În modul cu mai multe spații de lucru, este posibil să doriți să limitați cine poate crea spații de lucru noi: 
IS_WORKSPACE_CREATION_LIMITED_TO_SERVER_ADMINS=true
Când este activată, doar utilizatorii cu canAccessFullAdminPanel pot crea spații de lucru suplimentare. Utilizatorii își pot crea în continuare primul spațiu de lucru în timpul înregistrării inițiale.

​
Integrare Gmail & Google Calendar

​
Creați Proiect Google Cloud

  1. Mergeți la Google Cloud Console
  2. Creați un proiect nou sau selectați unul existent
  3. Activați aceste API-uri:

​
Configurați OAuth

  1. Mergeți la Credentials
  2. Creați Client ID OAuth 2.0
  3. Adăugați aceste URI-uri de redirecționare:
    • https://{your-domain}/auth/google/redirect (pentru SSO)
    • https://{your-domain}/auth/google-apis/get-access-token (pentru integrări)

​
Configurați în Twenty

  1. Mergeți la Setări → Panou Admin → Variabile de Configurare
  2. Găsiți secțiunea Autentificare Google
  3. Setați aceste variabile:
    • 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
Mod doar pentru mediu: Dacă setați IS_CONFIG_VARIABLES_IN_DB_ENABLED=false, adăugați aceste variabile în fișierul dvs. .env în schimb.
Domenii necesare (configurate automat): Consultați codul sursă relevant
  • https://www.googleapis.com/auth/calendar.events
  • https://www.googleapis.com/auth/gmail.readonly
  • https://www.googleapis.com/auth/profile.emails.read

​
Dacă aplicația dvs. este în modul de test

Dacă aplicația dvs. este în modul de test, va trebui să adăugați utilizatori de test în proiectul dvs. În ecranul de consimțământ OAuth, adăugați utilizatorii dvs. de test în secțiunea “Utilizatori de test”.

​
Integrare Microsoft 365

Utilizatorii trebuie să aibă un Licență Microsoft 365 pentru a putea utiliza API-ul Calendar și Mesagerie. Nu vor putea sincroniza contul lor pe Twenty fără una.

​
Creați un proiect în Microsoft Azure

Va trebui să creați un proiect în Microsoft Azure și să obțineți acreditările.

​
Activați API-urile

În Microsoft Azure Console activați următoarele API-uri în “Permisiuni”:
  • Graph Microsoft: Mail.ReadWrite
  • Graph Microsoft: Mail.Send
  • Graph Microsoft: Calendars.Read
  • Graph Microsoft: User.Read
  • Graph Microsoft: openid
  • Graph Microsoft: email
  • Graph Microsoft: profile
  • Graph Microsoft: offline_access
Notă: “Mail.ReadWrite” și “Mail.Send” sunt obligatorii doar dacă doriți să trimiteți e-mailuri utilizând acțiunile noastre de flux de lucru. Puteți utiliza “Mail.Read” dacă doriți doar să primiți e-mailuri.

​
URIs de redirecționare autorizate

Trebuie să adăugați următoarele URI-uri de redirecționare în proiectul dvs.:
  • https://{your-domain}/auth/microsoft/redirect dacă doriți să utilizați SSO Microsoft
  • https://{your-domain}/auth/microsoft-apis/get-access-token

​
Configurați în Twenty

  1. Mergeți la Setări → Panou Admin → Variabile de Configurare
  2. Găsiți secțiunea Autentificare Microsoft
  3. Setați aceste variabile:
    • 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
Mod doar pentru mediu: Dacă setați IS_CONFIG_VARIABLES_IN_DB_ENABLED=false, adăugați aceste variabile în fișierul dvs. .env în schimb.

​
Configurați scopurile

Consultați codul sursă relevant
  • ‘openid’
  • ‘email’
  • ‘profil’
  • ‘offline_access’
  • ‘Mail.ReadWrite’
  • ‘Mail.Send’
  • ‘Calendars.Read’

​
Dacă aplicația dvs. este în modul de test

Dacă aplicația dvs. este în modul de test, va trebui să adăugați utilizatori de test în proiectul dvs. Adăugați utilizatorii de test în secțiunea “Utilizatori și grupuri”.

​
Procese în fundal pentru Calendar și Mesagerie

După configurarea integrărilor Gmail, Google Calendar, sau Microsoft 365, trebuie să porniți joburile de fundal care sincronizează datele. Înregistrați următoarele joburi recurente în containerul dvs. worker: 
# 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

​
Configurare Email

  1. Mergeți la Setări → Panou Admin → Variabile de Configurare
  2. Găsiți secțiunea Email
  3. Configurați setările dvs. SMTP:
Mod doar pentru mediu: Dacă setați IS_CONFIG_VARIABLES_IN_DB_ENABLED=false, adăugați aceste variabile în fișierul dvs. .env în schimb.

​
Stocare S3

În mod implicit, Twenty stochează fișierele încărcate în sistemul de fișiere local. Pentru implementări în producție, utilizați S3 sau un serviciu compatibil cu S3 (MinIO, DigitalOcean Spaces etc.). pentru a vă asigura că fișierele persistă între repornirile containerelor și se scalează pe mai multe instanțe de server.
Setați STORAGE_TYPE=S_3 și configurați variabilele STORAGE_S3_* prin panoul de administrare sau .env. Consultați referința config-variables.ts pentru lista completă a variabilelor S3. Când utilizați S3 cu funcționalități dependente de CORS (de ex., descărcări de fișiere în browser), asigurați-vă că bucketul permite originea frontend-ului Twenty în configurația sa CORS.

​
Funcții logice și interpretor de cod

Twenty acceptă funcții logice pentru fluxuri de lucru și interpretorul de cod pentru analiza datelor cu AI. Ambele rulează cod furnizat de utilizator și necesită o configurare explicită din motive de securitate.

​
Valori implicite de securitate

În producție (NODE_ENV=production): Atât funcțiile logice, cât și interpretorul de cod au implicit valoarea Dezactivat. Trebuie să le activezi explicit cu LOGIC_FUNCTION_TYPE și CODE_INTERPRETER_TYPE dacă ai nevoie de aceste funcționalități. În dezvoltare (NODE_ENV=development): Ambele au implicit valoarea LOCAL pentru comoditate când rulezi local.
Atenționare de securitate: Driverul local (LOGIC_FUNCTION_TYPE=LOCAL sau CODE_INTERPRETER_TYPE=LOCAL) rulează codul direct pe gazdă într-un proces Node.js, fără sandboxing. Ar trebui utilizat doar pentru cod de încredere, în dezvoltare. Pentru implementări în producție care gestionează cod neverificat, folosiți LOGIC_FUNCTION_TYPE=LAMBDA sau CODE_INTERPRETER_TYPE=E2B (cu sandboxing) ori păstrați-le dezactivate.

​
Funcții logice - Drivere disponibile

DriverVariabilă de mediuCaz de utilizareNivel de securitate
DezactivatLOGIC_FUNCTION_TYPE=DISABLEDDezactivează complet funcțiile logiceN/A
LocalLOGIC_FUNCTION_TYPE=LOCALDezvoltare și medii de încredereScăzut (fără sandboxing)
LambdaLOGIC_FUNCTION_TYPE=LAMBDAProducție cu cod neverificatRidicat (izolare la nivel de hardware)

​
Funcții logice - Configurare recomandată

Pentru dezvoltare: 
LOGIC_FUNCTION_TYPE=LOCAL  # default when NODE_ENV=development
Pentru producție (AWS): 
LOGIC_FUNCTION_TYPE=LAMBDA
LOGIC_FUNCTION_LAMBDA_REGION=us-east-1
LOGIC_FUNCTION_LAMBDA_ROLE=arn:aws:iam::123456789:role/your-lambda-role
LOGIC_FUNCTION_LAMBDA_ACCESS_KEY_ID=your-access-key
LOGIC_FUNCTION_LAMBDA_SECRET_ACCESS_KEY=your-secret-key
Pentru a dezactiva funcțiile logice: 
LOGIC_FUNCTION_TYPE=DISABLED  # default when NODE_ENV=production

​
Interpretor de cod - Drivere disponibile

DriverVariabilă de mediuCaz de utilizareNivel de securitate
DezactivatCODE_INTERPRETER_TYPE=DISABLEDDezactivați execuția codului de către AIN/A
LocalCODE_INTERPRETER_TYPE=LOCALDoar pentru dezvoltareScăzut (fără sandboxing)
E2BCODE_INTERPRETER_TYPE=E_2_BProducție cu execuție în sandboxRidicat (sandbox izolat)
Când utilizați LOGIC_FUNCTION_TYPE=DISABLED sau CODE_INTERPRETER_TYPE=DISABLED, orice încercare de execuție va returna o eroare. Acest lucru este util dacă doriți să rulați Twenty fără aceste capabilități.