תיעוד 5
ניהול הגדרות באמצעות משתני סביבה
הגדר את בעלי המופע של n8n בהתקנה עצמית, SSO, מדיניות אבטחה, הזרמת יומנים, MCP וחבילות קהילה מתוך משתני סביבה.
באפשרותך לנהל תת-קבוצה של הגדרות המופע באמצעות משתני סביבה, במקום להגדיר אותן דרך ממשק המשתמש (UI). הדבר שימושי כאשר מקצים מופעי n8n באופן אוטומטי, כגון באמצעות צינור פריסה פנימי.
לכל תחום נתמך יש משתנה סביבה ייעודי בשם <AREA>_MANAGED_BY_ENV. הגדר משתנה זה ל-true כדי להפעיל ניהול באמצעות משתני סביבה עבור אותו תחום. לאחר מכן, n8n מחיל את משתני הסביבה הרלוונטיים ונועל את פקדי ה-UI התואמים.
#כיצד זה עובד
כאשר מגדירים את <AREA>_MANAGED_BY_ENV ל-true:
- n8n מחיל מחדש את ההגדרות ממשתני הסביבה בכל הפעלה.
- פקדי ה-UI התואמים הופכים לקריאה בלבד.
כאשר <AREA>_MANAGED_BY_ENV מוגדר ל-false (ברירת המחדל), n8n מתעלם ממשתני הסביבה הקשורים, גם אם הגדרת אותם.
ערכים נשמרים בעת כיבוי
*_MANAGED_BY_ENVהגדרת
*_MANAGED_BY_ENVבחזרה ל-falseמחזירה הרשאת כתיבה ב-UI, אך שומרת על הערכים שהוחלו לאחרונה. ערוך אותם דרך ה-UI לאחר מכן אם ברצונך לשנות אותם.
פקדי UI בלתי צפויים במצב קריאה בלבד
אם הגדרה מופיעה במצב קריאה בלבד ולא ציפית לכך, בדוק אם משתנה ה-
*_MANAGED_BY_ENVהתואם מוגדר ל-trueבסביבה שלך.
התחומים הנתמכים והמשתנים שמפעילים אותם:
- בעלי המופע:
N8N_INSTANCE_OWNER_MANAGED_BY_ENV - SSO:
N8N_SSO_MANAGED_BY_ENV - מדיניות אבטחה:
N8N_SECURITY_POLICY_MANAGED_BY_ENV - הזרמת יומנים:
N8N_LOG_STREAMING_MANAGED_BY_ENV - MCP:
N8N_MCP_MANAGED_BY_ENV - חבילות קהילה:
N8N_COMMUNITY_PACKAGES_MANAGED_BY_ENV
הגדר את
<AREA>_MANAGED_BY_ENVכדי להפעיל את הקבוצהלשאר משתני הסביבה עבור תחום מסוים אין השפעה אלא אם כן
<AREA>_MANAGED_BY_ENVמוגדר ל-true. הגדר אותו ל-trueכדי להפעיל את הקבוצה.
#בעלי המופע
זמינות התכונה
ניהול בעלי המופע באמצעות משתני סביבה זמין החל מגרסה 2.17.0 של n8n.
הקצה מראש את בעלי המופע מתוך משתני סביבה במקום לעבור את תהליך ההגדרה בתוך האפליקציה. כדי לשנות את כתובת הדוא"ל של הבעלים לאחר ההגדרה, עיין ב-שינוי דוא"ל בעלי המופע עבור n8n בהתקנה עצמית.
N8N_INSTANCE_OWNER_PASSWORD_HASHחייב להיות גיבוב bcryptמשתנה זה מצפה לערך bcrypt מגובב מראש. הגדרת סיסמה בטקסט גלוי (plaintext) שוברת את ההתחברות.
| משתנה | סוג | ברירת מחדל | תיאור |
|---|---|---|---|
N8N_INSTANCE_OWNER_MANAGED_BY_ENV | Boolean | false | הגדר ל-true כדי לנהל את בעלי המופע מתוך משתני סביבה. כאשר מוגדר true, n8n דורס את פרטי בעלי המופע שלהלן בכל הפעלה, נועל את פקד ה-UI עבור אותו משתמש, ודוחה פעולות כתיבה דרך ה-API. |
N8N_INSTANCE_OWNER_EMAIL | String | - | כתובת דוא"ל עבור בעלי המופע. |
N8N_INSTANCE_OWNER_FIRST_NAME | String | - | שם פרטי עבור בעלי המופע. |
N8N_INSTANCE_OWNER_LAST_NAME | String | - | שם משפחה עבור בעלי המופע. |
N8N_INSTANCE_OWNER_PASSWORD_HASH | String | - | גיבוב bcrypt של סיסמת בעלי המופע. הגדרת סיסמה בטקסט גלוי שוברת את ההתחברות. |
דוא"ל הבעלים חייב להיות ייחודי
N8N_INSTANCE_OWNER_EMAILאינו יכול להיות שייך כבר למשתמש אחר במופע. הגדרה זו מעדכנת את חשבון בעלי המופע הקיים, היא אינה מעבירה בעלות למשתמש קיים אחר ואינה ממזגת חשבונות משתמשים. כדי להשתמש בכתובת דוא"ל שכבר שייכת למשתמש אחר, שנה או מחק תחילה את אותו משתמש כדי שהדוא"ל יתפנה.
#SSO
זמינות התכונה
כניסה יחידה (Single sign-on) זמינה ב:
- התקנה עצמית: Business, Enterprise
גרסת n8n Cloud Enterprise תומכת גם היא בכניסה יחידה, אך לא באמצעות משתני הסביבה שבדף זה.
ניהול SSO מתוך משתני סביבה זמין החל מגרסה 2.18.0 של n8n.
הגדר כניסה יחידה מתוך משתני סביבה.
#הפעלה והגדרות משותפות
| משתנה | סוג | ברירת מחדל | תיאור |
|---|---|---|---|
N8N_SSO_MANAGED_BY_ENV | Boolean | false | הגדר ל-true כדי לנהל SSO מתוך משתני סביבה. כאשר מוגדר true, n8n מחיל את משתני ה-SSO בכל הפעלה ונועל את פקדי ה-UI התואמים. |
N8N_SSO_USER_ROLE_PROVISIONING | Enum string: disabled, instance_role, instance_and_project_roles | disabled | כיצד n8n מקצה תפקידים למשתמשים שמתחברים דרך SSO. הערך disabled אינו מקצה תפקידים כלל. הערך instance_role מקצה את התפקיד ברמת המופע בלבד. הערך instance_and_project_roles מקצה תפקידים הן ברמת המופע והן ברמת הפרויקט. |
#OIDC
| משתנה | סוג | ברירת מחדל | תיאור |
|---|---|---|---|
N8N_SSO_OIDC_LOGIN_ENABLED | Boolean | false | האם לאפשר התחברות באמצעות OIDC. |
N8N_SSO_OIDC_CLIENT_ID | String | - | מזהה לקוח OIDC שהונפק על ידי ספק הזהויות שלך. |
N8N_SSO_OIDC_CLIENT_SECRET | String | - | סוד לקוח OIDC שהונפק על ידי ספק הזהויות שלך. |
N8N_SSO_OIDC_DISCOVERY_ENDPOINT | String | - | כתובת URL של נקודת קצה לגילוי OIDC (כתובת ה-.well-known/openid-configuration של ספק הזהויות שלך). |
N8N_SSO_OIDC_PROMPT | String | - | פרמטר prompt אופציונלי של OIDC לשליחה עם בקשת ההרשאה, לדוגמה login או consent. |
N8N_SSO_OIDC_ACR_VALUES | String | - | פרמטר acr_values אופציונלי של OIDC. השתמש בו כדי לבקש הקשר אימות ספציפי, למשל זרימת אימות כפול (MFA) מסוג step-up. |
#SAML
משתני מטא-דאטה של SAML מוציאים זה את זה
הגדר או את
N8N_SSO_SAML_METADATA(מחרוזת XML מוטמעת) או אתN8N_SSO_SAML_METADATA_URL(כתובת URL), אך לא את שניהם.
| משתנה | סוג | ברירת מחדל | תיאור |
|---|---|---|---|
N8N_SSO_SAML_LOGIN_ENABLED | Boolean | false | האם לאפשר התחברות באמצעות SAML. |
N8N_SSO_SAML_METADATA | String | - | מטא-דאטה של ספק הזהויות של SAML כמחרוזת XML. מוציא זה את זה עם N8N_SSO_SAML_METADATA_URL, אל תגדיר את שניהם. |
N8N_SSO_SAML_METADATA_URL | String | - | כתובת URL לאחזור מטא-דאטה של ספק הזהויות של SAML. מוציא זה את זה עם N8N_SSO_SAML_METADATA, אל תגדיר את שניהם. |
#מדיניות אבטחה
זמינות התכונה
ניהול מדיניות האבטחה מתוך משתני סביבה זמין החל מגרסה 2.18.0 של n8n.
נהל את מדיניות האבטחה של המופע מתוך משתני סביבה, כולל אכיפת MFA והגבלות על מרחב אישי (personal space).
| משתנה | סוג | ברירת מחדל | תיאור |
|---|---|---|---|
N8N_SECURITY_POLICY_MANAGED_BY_ENV | Boolean | false | הגדר ל-true כדי לנהל את מדיניות האבטחה מתוך משתני סביבה. כאשר מוגדר true, n8n מחיל את משתני מדיניות האבטחה בכל הפעלה ונועל את פקדי ה-UI התואמים. |
N8N_MFA_ENFORCED_ENABLED | Boolean | false | האם לאכוף אימות דו-שלבי עבור כל המשתמשים (true) או לא (false). |
N8N_PERSONAL_SPACE_PUBLISHING_ENABLED | Boolean | true | האם משתמשים יכולים לפרסם מתוך המרחב האישי שלהם (true) או לא (false). |
N8N_PERSONAL_SPACE_SHARING_ENABLED | Boolean | true | האם משתמשים יכולים לשתף משאבים מתוך המרחב האישי שלהם (true) או לא (false). |
#הזרמת יומנים
זמינות התכונה
ניהול הזרמת יומנים מתוך משתני סביבה זמין החל מגרסה 2.19.0 של n8n.
נהל יעדי הזרמת יומנים מתוך משתני סביבה. עיין ב-הגדרה באמצעות משתני סביבה עבור מבנה ה-JSON של כל יעד ויעד.
| משתנה | סוג | ברירת מחדל | תיאור |
|---|---|---|---|
N8N_LOG_STREAMING_MANAGED_BY_ENV | Boolean | false | הגדר ל-true כדי לנהל הזרמת יומנים מתוך משתני סביבה. כאשר מוגדר true, n8n מחיל את משתני הזרמת היומנים בכל הפעלה ונועל את פקדי ה-UI התואמים. |
N8N_LOG_STREAMING_DESTINATIONS | JSON string | - | מערך JSON של יעדי הזרמת יומנים. כל יעד הוא אובייקט עם שדה type בעל ערך webhook, syslog או sentry, בתוספת ההגדרה המתאימה לאותו סוג. |
#MCP
זמינות התכונה
ניהול גישת MCP ברמת המופע מתוך משתני סביבה זמין החל מגרסה 2.20.0 של n8n.
נהל גישת MCP ברמת המופע מתוך משתני סביבה.
| משתנה | סוג | ברירת מחדל | תיאור |
|---|---|---|---|
N8N_MCP_MANAGED_BY_ENV | Boolean | false | הגדר ל-true כדי לנהל הגדרות MCP מתוך משתני סביבה. כאשר מוגדר true, n8n מחיל את משתני ה-MCP בכל הפעלה ונועל את פקדי ה-UI התואמים. |
N8N_MCP_ACCESS_ENABLED | Boolean | false | האם להפעיל גישת MCP ברמת המופע (true) או לא (false). |
#חבילות קהילה
זמינות התכונה
ניהול חבילות קהילה מותקנות מתוך משתני סביבה זמין החל מגרסה 2.21.0 של n8n.
נהל את קבוצת חבילות הקהילה המותקנות מתוך משתני סביבה. n8n מתאים ומסנכרן את החבילות המותקנות מול הרשימה בכל הפעלה. חבילות מנוהלות אינן ניתנות להסרה או לעדכון דרך ה-UI.
חובה ש-N8N_COMMUNITY_PACKAGES_ENABLED יוגדר גם הוא ל-true (ברירת המחדל). כאשר חבילות קהילה מושבתות, n8n מתעלם מ-N8N_COMMUNITY_PACKAGES_MANAGED_BY_ENV ורושם אזהרה ביומן.
| משתנה | סוג | ברירת מחדל | תיאור |
|---|---|---|---|
N8N_COMMUNITY_PACKAGES_MANAGED_BY_ENV | Boolean | false | הגדר ל-true כדי לנהל חבילות קהילה מותקנות מתוך משתני סביבה. כאשר מוגדר true, n8n מתאים ומסנכרן את החבילות המותקנות מול N8N_COMMUNITY_PACKAGES בכל הפעלה, מתקין חבילות חסרות, מתקן גרסאות, ומסיר כל חבילה המותקנת כעת שאינה מופיעה ברשימה. דף ההגדרות של Community nodes הופך לקריאה בלבד: אינך יכול להתקין, לעדכן או להסיר חבילות דרך ה-UI כל עוד אפשרות זו מופעלת. |
N8N_COMMUNITY_PACKAGES | JSON string | - | מערך JSON של חבילות קהילה להתקנה. כל רשומה היא אובייקט עם שדה name (חובה) ושדות אופציונליים version ו-checksum. ניתן גם להטמיע את הגרסה בתוך השם בתבנית <package-name>@<version>. עיין ב-התקנה באמצעות משתני סביבה עבור הפירוט המלא של כל שדה ושדה. |
#דוגמה משולבת
הדוגמה הבאה מגדירה מופע שבו כל ששת התחומים מנוהלים באמצעות משתני סביבה. היא יוצרת את בעלי המופע, מגדירה OIDC SSO, אוכפת MFA, רושמת יעד הזרמת יומנים מסוג webhook, מפעילה גישת MCP ומנהלת חבילת קהילה.
# Instance owner <a href="#instance-owner" id="instance-owner"></a>
export N8N_INSTANCE_OWNER_MANAGED_BY_ENV=true
export N8N_INSTANCE_OWNER_EMAIL=<owner-email>
export N8N_INSTANCE_OWNER_FIRST_NAME=<first-name>
export N8N_INSTANCE_OWNER_LAST_NAME=<last-name>
export N8N_INSTANCE_OWNER_PASSWORD_HASH=<bcrypt-hash>
# SSO using OIDC <a href="#sso-using-oidc" id="sso-using-oidc"></a>
export N8N_SSO_MANAGED_BY_ENV=true
export N8N_SSO_USER_ROLE_PROVISIONING=instance_role
export N8N_SSO_OIDC_LOGIN_ENABLED=true
export N8N_SSO_OIDC_CLIENT_ID=<client-id>
export N8N_SSO_OIDC_CLIENT_SECRET=<client-secret>
export N8N_SSO_OIDC_DISCOVERY_ENDPOINT=<discovery-url>
# Security policy <a href="#security-policy" id="security-policy"></a>
export N8N_SECURITY_POLICY_MANAGED_BY_ENV=true
export N8N_MFA_ENFORCED_ENABLED=true
export N8N_PERSONAL_SPACE_PUBLISHING_ENABLED=false
export N8N_PERSONAL_SPACE_SHARING_ENABLED=false
# Log streaming <a href="#log-streaming" id="log-streaming"></a>
export N8N_LOG_STREAMING_MANAGED_BY_ENV=true
export N8N_LOG_STREAMING_DESTINATIONS='[{"type":"webhook","url":"https://logs.example.com/n8n"}]'
# MCP <a href="#mcp" id="mcp"></a>
export N8N_MCP_MANAGED_BY_ENV=true
export N8N_MCP_ACCESS_ENABLED=true
# Community packages <a href="#community-packages" id="community-packages"></a>
export N8N_COMMUNITY_PACKAGES_MANAGED_BY_ENV=true
export N8N_COMMUNITY_PACKAGES='[{"name":"n8n-nodes-foo","version":"1.2.3"}]'#הגדרת משתני סביבה
עבור הדרכים הנתמכות להגדרת משתני סביבה, עיין ב-שיטות תצורה.