Created by Github action --------- Co-authored-by: github-actions <github-actions@twenty.com>
215 lines
7.5 KiB
Plaintext
215 lines
7.5 KiB
Plaintext
---
|
||
title: 1-Click w/ Docker Compose
|
||
image: /images/user-guide/objects/objects.png
|
||
---
|
||
|
||
<Frame>
|
||
<img src="/images/user-guide/objects/objects.png" alt="Header" />
|
||
</Frame>
|
||
|
||
<Warning>
|
||
Docker containers are for production hosting or self-hosting, for the contribution please check the [Local Setup](https://docs.twenty.com/l/he/developers/local-setup).
|
||
</Warning>
|
||
|
||
## סקירה כללית
|
||
|
||
מדריך זה מספק הוראות שלב-אחר-שלב להתקנה ולהגדרת אפליקציית Twenty באמצעות Docker Compose. המטרה היא להפוך את התהליך לפשוט למניעת תקלות נפוצות שעלולות לפגוע בהגדרתך.
|
||
|
||
**חשוב:** שנה הגדרות רק אם הן מצויינות במדריך זה. שינוי תצורות אחרות עלול להוביל לבעיות.
|
||
|
||
See docs [Setup Environment Variables](https://docs.twenty.com/l/he/developers/self-hosting/setup) for advanced configuration. All environment variables must be declared in the docker-compose.yml file at the server and / or worker level depending on the variable.
|
||
|
||
## דרישות מערכת
|
||
|
||
- זיכרון RAM: ודא שהסביבה שלך כוללת לפחות 2GB של RAM. חוסר בזיכרון יכול לגרום לקריסות בתהליכים.
|
||
- Docker ו-Docker Compose: ודא ששניהם מותקנים ומעודכנים.
|
||
|
||
## Option 1: One-line script
|
||
|
||
התקן את הגרסה היציבה האחרונה של Twenty באמצעות פקודה אחת:
|
||
|
||
```bash
|
||
bash <(curl -sL https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-docker/scripts/install.sh)
|
||
```
|
||
|
||
להתקנת גרסה או ענף ספציפי:
|
||
|
||
```bash
|
||
VERSION=vx.y.z BRANCH=branch-name bash <(curl -sL https://raw.githubusercontent.com/twentyhq/twenty/main/packages/twenty-docker/scripts/install.sh)
|
||
```
|
||
|
||
- החלף את x.y.z עם מספר הגרסה הרצוי.
|
||
- החלף את branch-name בשם הענף שברצונך להתקין.
|
||
|
||
## אופציה 2: שלבים ידניים
|
||
|
||
בצע את השלבים הללו להגדרה ידנית.
|
||
|
||
### שלב 1: הקמת קובץ הסביבה
|
||
|
||
1. **צור את קובץ ה-.env**
|
||
|
||
העתק את קובץ הסביבה לדוגמה לקובץ .env חדש בתיקיית העבודה שלך:
|
||
|
||
```bash
|
||
curl -o .env https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/main/packages/twenty-docker/.env.example
|
||
```
|
||
|
||
2. **צור מפתחות סודיים**
|
||
|
||
הרץ את הפקודה הבאה ליצירת מחרוזת רנדומלית ייחודית:
|
||
|
||
```bash
|
||
openssl rand -base64 32
|
||
```
|
||
|
||
**חשוב:** שמור על ערך זה בסוד / אל תשתף אותו.
|
||
|
||
3. **עדכן את `.env`**
|
||
|
||
Replace the placeholder value in your .env file with the generated token:
|
||
|
||
```ini
|
||
APP_SECRET=first_random_string
|
||
```
|
||
|
||
4. **הגדר את סיסמת Postgres**
|
||
|
||
עדכן את הערך `PG_DATABASE_PASSWORD` ב-.env לסיסמה חזקה ללא תווים מיוחדים.
|
||
|
||
```ini
|
||
PG_DATABASE_PASSWORD=my_strong_password
|
||
```
|
||
|
||
### שלב 2: השג את קובץ Docker Compose
|
||
|
||
הורד את קובץ `docker-compose.yml` לתיקיית העבודה שלך:
|
||
|
||
```bash
|
||
curl -o docker-compose.yml https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/main/packages/twenty-docker/docker-compose.yml
|
||
```
|
||
|
||
### שלב 3: שגר את האפליקציה
|
||
|
||
Start the Docker containers:
|
||
|
||
```bash
|
||
docker compose up -d
|
||
```
|
||
|
||
### שלב 4: גש לאפליקציה
|
||
|
||
If you host twentyCRM on your own computer, open your browser and navigate to [http://localhost:3000](http://localhost:3000).
|
||
|
||
אם אתה מארח אותו בשרת, בדוק שהשרת פועל ושהכול תקין עם
|
||
|
||
```bash
|
||
curl http://localhost:3000
|
||
```
|
||
|
||
## הגדרה
|
||
|
||
### חשוף את Twenty לגישה חיצונית
|
||
|
||
ברירת המחדל, Twenty רץ על `localhost` ב-port `3000`. כדי לגשת באמצעות דומיין חיצוני או כתובת IP, יש להגדיר את `SERVER_URL` בקובץ `.env` שלך.
|
||
|
||
#### הבנת `SERVER_URL`
|
||
|
||
- **פרוטוקול:** השתמש ב-`http` או `https` תלוי בהגדרתך.
|
||
- השתמש ב-`http` אם לא הגדרת SSL.
|
||
- השתמש ב-`https` אם הגדרת SSL.
|
||
- **דומיין/כתובת IP:** זהו שם הדומיין או כתובת ה-IP שבה האפליקציה שלך נגישה.
|
||
- **פורט:** כולל את מספר הפורט אם אינך משתמש בפורטים ברירת המחדל (`80` ל-`http`, `443` ל-`https`).
|
||
|
||
### דרישות SSL
|
||
|
||
SSL (HTTPS) נדרש כדי שתכונות מסוימות בדפדפן יפעלו כראוי. בעוד שתכונות אלו עשויות לפעול במהלך פיתוח מקומי (כי דפדפנים מטפלים ב-localhost באופן שונה), יש להגדיר SSL בצורה נכונה כאשר מאחסנים Twenty על דומיין רגיל.
|
||
|
||
לדוגמה, ה-clipboard API עשוי לדרוש הקשר מאובטח - תכונות מסוימות כמו כפתורי העתקה בכל האפליקציה עשויות לא לעבוד ללא HTTPS.
|
||
|
||
אנו ממליצים בחום לאחסן את Twenty מאחורי פרוקסי הפוך עם ניתוק SSL להשגת אבטחה מיטבית ופונקציונליות.
|
||
|
||
#### Configuring `SERVER_URL`
|
||
|
||
1. **קבע את כתובת הגישה שלך**
|
||
- **ללא פרוקסי הפוך (גישה ישירה):**
|
||
|
||
אם אתה ניגש לאפליקציה ישירות ללא פרוקסי הפוך:
|
||
|
||
```ini
|
||
SERVER_URL=http://your-domain-or-ip:3000
|
||
```
|
||
|
||
- **עם פרוקסי הפוך (פורטים סטנדרטיים):**
|
||
|
||
אם אתה משתמש בפרוקסי הפוך כמו Nginx או Traefik והגדרת SSL:
|
||
|
||
```ini
|
||
SERVER_URL=https://your-domain-or-ip
|
||
```
|
||
|
||
- **עם פרוקסי הפוך (פורטים מותאמים אישית):**
|
||
|
||
אם אתה משתמש בפורטים לא סטנדרטיים:
|
||
|
||
```ini
|
||
SERVER_URL=https://your-domain-or-ip:custom-port
|
||
```
|
||
|
||
2. **Update the `.env` File**
|
||
|
||
פתח את קובץ `.env` שלך ועדכן את ה-`SERVER_URL`:
|
||
|
||
```ini
|
||
SERVER_URL=http(s)://your-domain-or-ip:your-port
|
||
```
|
||
|
||
**Examples:**
|
||
|
||
- גישה ישירה ללא SSL:
|
||
```ini
|
||
SERVER_URL=http://123.45.67.89:3000
|
||
```
|
||
- גישה דרך דומיין עם SSL:
|
||
```ini
|
||
SERVER_URL=https://mytwentyapp.com
|
||
```
|
||
|
||
3. **הפעל מחדש את האפליקציה**
|
||
|
||
כדי שהשינויים יכנסו לתוקף, הפעל מחדש את מיכלי Docker:
|
||
|
||
```bash
|
||
docker compose down
|
||
docker compose up -d
|
||
```
|
||
|
||
#### Considerations
|
||
|
||
- **תצורת פרוקסי הפוך:**
|
||
|
||
ודא שהפרוקסי ההפוך מעביר בקשות לפורט פנימי הנכון (`3000` כברירת מחדל). הגדר סיום SSL וכל כותרות נדרשות.
|
||
|
||
- **הגדרות חומת אש:**
|
||
|
||
פתח את הפורטים הנדרשים בחומת האש שלך כדי לאפשר גישה חיצונית.
|
||
|
||
- **Consistency:**
|
||
|
||
ה-`SERVER_URL` חייב להתאים לאופן שבו המשתמשים ניגשים ליישום שלך בדפדפןיהם.
|
||
|
||
#### שימור
|
||
|
||
- **נפחי נתונים:**
|
||
|
||
הגדרת Docker Compose משתמשת בנפחים כדי לשמור נתונים עבור מסד הנתונים ואחסון השרת.
|
||
|
||
- **Stateless Environments:**
|
||
|
||
אם פורסים בסביבה חסרת מדינה (לדוגמה, שירותי ענן מסוימים), הגדר אחסון חיצוני לשמירת נתונים.
|
||
|
||
## פתרון תקלות
|
||
|
||
אם אתה נתקל בכל בעיה, בדוק את [פתרון תקלות](https://docs.twenty.com/l/he/developers/self-hosting/troubleshooting) לפתרונות.
|
||
|