ngSurvey
  • ✔️ What is ngSurvey ?
  • ❔Help on Help
  • 📁Projects
    • Creating a New Survey
    • Folders
      • Project Trashcan
    • Survey Information
    • Survey Search
    • Collaboration
    • Import / Export
      • JSON Survey Export / Import
      • XLSForm
        • Survey Sheet
          • Types
          • Groups
          • Appearances
          • Relevant
          • Constraint
          • Calculations
          • Multi-Languages
          • Choice filters (Casacade)
        • Choices Sheet
        • Settings Sheet
        • XLSForm Samples
  • 📄Forms / Surveys
    • Overview Dashboard
      • Dashboard Title
      • Dashboard Information Box
      • Dashboard Reports
      • Last Respondents
      • Last Sentiments
    • Form Designer
      • Questions
        • Creating a Question
        • Editing a Question
          • Question Preset Styles
        • Question Properties
          • Conversation reply type
            • Auto reply type
          • Question Branching
          • Skip / Hide Logic
        • Question Types
          • Standard
            • Single Choice
            • Multiple Choice
            • Image Choices
            • Dropdown List
            • Autocomplete
            • Text / Comment Field
          • Matrix Questions
            • Columns / Rows Sums
            • Single Matrix
            • Multi Matrix
            • Mobile Rendering
          • Satisfaction Questions
            • Net Promoter Score® Question
              • Understanding the Net Promoter Score® (NPS)
            • CSAT Score
              • Understating CSAT Score
            • CES Score
              • Understanding CES
            • Star Rating
            • Smileys
            • Thumbs Up / Down
          • Choice-Based Conjoint (CBC)
            • Create a Conjoint Question
            • Design Experiments
              • Balanced Design
              • Manual Design
              • Import Design
            • Reporting / Export
          • Advanced Types
            • Appointment Calendar
            • Constant Sum
            • Answer Ranking
            • Slider Scale
            • File Upload
            • Hidden Question
            • Contact Details
          • Questions Generator
          • Smart Generator
        • Question Blocks
        • Static / Images Content
        • Rating
        • Panel Linking
          • Panel Auto Filling
          • Panel Updating
      • Answers
        • Adding an Answer
        • Editing an Answer
        • Answer Properties
          • Field Properties
          • Reporting / Exports
          • Skip / Hide Logic
          • Entry Validation
        • Answer Types
          • Creating New Type
            • Custom Validation Code
            • Lists
              • JSON / REST API Lists
              • SQL Server Lists
                • Parent / Child Related Lists
                • SQL Parameters
              • List Items
            • Widgets
              • Widget Samples
                • Widget Definitions
                • Basic Field
                • Multiple input type
                • Basic Selection
                • Material Date
                • Material selection
                • Total Score Per Page
          • Selection Answers
            • Checkbox
            • Radio Button
          • Other selection
          • Entry Field
          • Password
          • Captcha
          • Calendar Date
          • Calendar time
          • Compare Field
          • Countries
          • Email
          • Email Validator
          • Hidden Field
          • File Upload
          • Language Selector
          • Phone Confirmation
          • Signature Pad
          • Slider
          • Constant sum
          • Constant sum total
          • Ranking Field
          • Ranking drag / drop
          • Text label
          • Time Picker
          • Appointment Calendar
      • Pages
        • Page Branching
        • Skip / Hide Logic
        • Conditional Redirection
        • Thanks / End Page
          • Redirection URL
          • Conditional Thanks Message
        • Page Looping
          • Looping Pipes
        • Pages Navigator
      • Multi-Language Forms
        • Setup multi-languages
        • Import / Export
        • Auto-translation
        • Resources
      • Survey Properties
        • Progress Completion
          • Respondent Answers Update
        • Single Question Flow
          • Flow Animation Transitions
        • Privacy
          • Privacy checklist
        • Quotas
        • Kiosk
        • Form Code
        • Survey Security
      • Footer Manager
      • Repeatable Sections
      • Rich Text Editor
        • Rich Attributes
      • Piping
        • Text / Data Piping
        • Carry Forward Answers
      • Preview / Testing
        • Pref-filled answers
      • Form Trashcan
      • Scoring
      • Timer
      • Conditions
        • Condition Groups
        • Conditions Rules
          • Question Conditions
          • Javascript Conditions
      • Geolocation
        • Browser Location
        • IP Address Location
        • Location Reporting
      • Google Analytics
        • Google Analytics Events
    • Flow Logic Graph
      • Page Branching Graph
      • Question Branching Graph
    • Security
      • Security Items
        • Active Directory Security
        • Azure Active Directory Security
        • Auth0 Security
        • Captcha
        • CAS Authentication
        • HTTP Function
          • Azure Function Login Sample
        • Invitation Code
        • IP Protection
        • IP Access Control
        • Local Users Security
        • OpenId Connect
        • Panel Security
          • Panelist Mapping
        • Password
        • Quota Restrictions
        • Tokens
          • Token Generator
            • Individual Entry
            • Automatic Generator
            • CSV File
          • Token Manager
          • Token and Querystring
          • Token Hierarchy / Permissions
        • Referer
        • SQL Security
      • Key Provider
      • Data Attributes
    • Style / Branding
      • Style Library
      • Style Editor
        • Style
          • Header / Footer
          • Header Logo Image
        • Theme
        • Elements
        • CSS
          • CSS Classes
          • CSS Rating Sample
        • Mobile / Responsive Design
        • Custom Font
      • Media Gallery
    • Tasks
      • Task Items
        • Completion Alerts
        • Google Sheet Task
        • SQL Query Task
        • Webhooks
          • Webhooks payload transform
      • Triggers
    • Publish
      • Web Link
      • Offline Survey
        • Uploading respondents
      • Embed Form
      • QR Code
      • Word Format Export
      • Website Intercepts
        • How to implement intercepts
        • Intercept Hosts
        • Intercepts
          • Intercept Properties
          • Intercept Layout
          • Intercept Triggers
          • Multi-Language Intercepts
          • Intercept Display Formats
      • Page
    • Campaigns
      • Information Box
      • Campaign
        • Email Distribution
          • Email List
          • Import Emails
        • Panel Members Distribution
        • Mobile Phone Distribution
          • SMS Distribution
          • WhatsApp Distribution
            • WhatsApp Invitations
            • WhatsApp Conversation
          • Phone Number List
          • Import Phones
        • Invitation Message
          • Invitation Piping Tags
          • Embedding a Question
          • WhatsApp Template
        • Reminders
          • One time reminders
        • Schedules
        • Virtual Campaign
        • Campaign Results
      • Campaign Batches
      • Invitation Templates
      • REST Trigger
    • Respondents
      • Respondent Details
      • Editing Respondent Answers
      • Respondents Status
      • Archived Respondents
      • Actions Links
    • Reporting
      • Default Report
      • Report Builder
        • Report Items
          • Bar Chart
          • Pie Chart
          • Free Text Report
          • Sentiment Index
          • Net Promoter Score®
          • Historical Trends Chart
          • Cross Tabulation
          • Tag Clouds
          • T.U.R.F
          • Ranking Report
          • Constant Sum Report
          • Languages Chart
          • Location Chart
      • Text Reports
        • Sentiment Analysis
      • Report Filters
      • Test Data Generator
      • Historical Trends
      • Files Vault
      • Multi-Language Report
      • Reporting Printing
    • Data Exports / Imports
      • Data Exports
        • Export Jobs
        • CSV / Excel
          • Excel
          • CSV Individual Answers
          • CSV Separated Selection / Fields
          • Questions as Rows
        • SPSS / SAV
        • JSON
        • Aggregated Results
        • Word Respondents
        • Export Templates
      • Data Imports
      • Variables
    • Data Access
    • Activity Log
  • 💬Conversational Surveys
    • Get Conversation Started
    • Conversation Questions
      • Answer Reply
      • Text Reply
      • File Upload
      • NPS
      • CSAT
      • CES
      • Language Reply
    • Conversation Commands
    • WhatsApp Conversations
    • Unifonic Template Message
  • 📖Shared Sessions Surveys
    • Sessions
  • ✨AI Suite
    • AI Generated Survey
    • Smart Questions Generator
    • Smart Answers Suggestions
    • Smart Analysis
    • Smart Columns
      • Smart Columns Properties
      • Smart Works
        • Custom Prompt
        • Translation
        • NPS
        • Sentiment
        • Labels
  • 👪Panels
    • Panel Connectors
      • Built-in Connector
        • Import panelist from CSV
      • Database Connector
    • Panel information
    • Panelists
    • Panel Views
    • Panel Attributes
    • Entry Approvals
    • Panelist Surveys
    • Panel Properties
  • 👤Personal Account
    • Account Settings
    • Developer
      • API Connection Sample
        • Get Survey From API
      • Power Apps / Logic App Flow Integration
        • Connector Setup
        • Connector / Mail Example
      • Zapier.com Connection
  • 🔐Access Control
    • Users
    • Groups
    • Roles
      • Rights
  • 🔑Data Encryption
    • Encryption Setup
      • Transparent Encryption
        • Azure Encryption Setup
        • IIS Encryption Setup
      • PGP Encryption
    • Data Classification
      • Internal
      • Sensitive
      • Restricted
    • Respondent Answers Encryption
    • File Upload Encryption
    • Campaign Encryption
  • 🕸️ Tenants
  • 🚀On-Site Setup
    • Enterprise Edition Installation
      • Docker
        • Filesystem Storage
      • Microsoft Azure
      • Amazon Web Services
        • AWS Elastic Beanstalk
          • AWS EBS / STAND ALONE SQL SERVER
          • AWS EBS / SQL Server
        • Cognito
        • LightSail
      • Microsoft IIS
        • Azure KeyVault
        • Update / Upgrade
      • ZIP Archive
      • Linux (Ubuntu / CentOS)
        • Linux SSL
      • Database Backend
        • Microsoft SQL Server
        • Oracle MySQL
        • MariaDB
        • PostgreSQL
      • WhatsApp Messenging
        • Twilio
        • Unifonic
      • Cluster / Scale out setup
      • Microsoft Entra / Azure AD
        • Entra Setup
        • Register Entra Users
      • Active Directory
        • Active Directory Setup
        • Register Active Directory Users
      • Environment Variable Settings
      • Content Security Policy (CSP)
      • Cross Origins Setup (CORS)
    • System Settings
      • General
      • Mailing Server
        • SMTP Mailing Server
        • IIS SMTP / Exchange Server
        • Postmark
        • Twilio / Sendgrid
        • MailJet
      • Account Security
      • Connections vault
      • AI Suite Provider
        • OpenAI
        • Azure AI
      • Third Party APIs
        • Microsoft
        • IPStack
      • Google
        • Captcha Setup
        • Google Web Font
        • Service Account
      • Azure Entra Settings
      • Active Directory Settings
      • OpenId Connect Settings
      • Mobile Messenging
        • Twilio
        • HTTP SMS Messenging
        • Amazon SNS
        • Unifonic
      • Translations
      • File Storage
      • Bounce Account
    • White-Label
    • Register Trial Copy
    • Upgrades
    • Release Notes
    • Change log
  • 📚Walkthroughs
    • Quick create survey start
    • Translate a survey
    • Rename a survey
    • Restore a deleted survey
    • Invite respondents to a survey
    • Capture value from query string
    • Share a survey with other users
    • Using token in email campaigns
    • Using a campaign with MailChimp
    • Power BI Integration
      • Link data to Power BI
      • Reporting with Power BI
    • Tableau Integration
      • Link data to Tableau
        • Reporting with Tableau
    • Link existing SQL table to a survey
    • Send invitations using an existing SQL Table
    • Export data to Excel
    • Export data to R
    • Zendesk integration
  • ©️ Copyrights / EULA
    • License
    • Copyrights and disclaimers
Powered by GitBook

(c) 2024 Data Illusion Zumbrunn. All rights reserved. Reproduction strictly forbidden.

On this page

Was this helpful?

  1. On-Site Setup
  2. Enterprise Edition Installation

Environment Variable Settings

PreviousRegister Active Directory UsersNextContent Security Policy (CSP)

Last updated 2 months ago

Was this helpful?

Beside its you can also configure ngSurvey's core using following environment variable. These variables can also bet set either in the web.config file if you are using IIS or within the ngsurvey.settings.json file.

In a default Azure Linux app service or a custom Linux container any : in the variable name should be replaced by __ (double underscore).

🔅 Environment variables

  • NGSurvey:Secretencryption key used to sign the JWT and security items tokens. Must be at least 64 chars long.

  • NGSurvey:AutoDBSetupby default ngSurvey will automatically configure or upgrade your target database. If you want to disable the auto install / upgrade process you can set this variable to false. In such a case you will need to install manually the database using the file for Microsoft SQL Server. MariaDB or MySQL will only be installed by ngSurvey directly, we don't offer any scripts or code to install and setup the database manually by yourself.

  • NGSurvey:MailingBatchPoolingDelayis the delay in minutes after which the mailing related batchs like campaign email sending will trigger. Default is 1 minute.

  • NGSurvey:MaxMailingThread let you define how many worker threads will be used during the email sending process. Be careful when setting the number of threads as each thread will open a connection to your mail server. The default is 2.

  • NGSurvey:EnableTenants if you own a Tenant License you have to enable the tenants on your installation by setting this variable to true.

  • NGSurvey:DisableEmailBlacklistingdisables the ability to blacklist emails for campaigns if set to true.

  • NGSurvey:DisableMobilePhoneNumberBlacklistingdsables the ability to blacklist mobile phones for campaigns if set to true.

  • NGSurvey:EnableSwaggerif set to false will disable the access to the API documentation at https://yourngsurveysite/api.

  • NGSurvey:DistributedCacheenables distributed cache if set to true. Distributed cache must be enabled if you are using ngSurvey on like configuration

  • NGSurvey:CacheTimeoutngSurvey uses internal caches to improve performances. By default these caches don't expire. You can set a timeout in minutes if you would like to set an expiration time for these caches to be flushed at regular interval.

  • NGSurvey:PanelSyncronizerThreadsNumber defines the number of threads that will be used to synchronize the panels against their data sources. The default is 6. Be careful as each thread can open a new connection to the data source to which your panel is connected.

  • NGSurvey:Languagesan array of languages code that will be selectable for the administration section. :

  • NGSurvey:ClusterNodedefines if set to true if the instance is running on a cluster node. Instances having the cluster node set to true will not run any kind of background jobs. You should keep the background jobs either on a separate instances that is not serving any surveys or on only one instance.

  • NGSurvey:EncryptionKeythis encryption key will be used for all encryption of data at the database level like connection strings, passwords, sensitive settings. Must be min. 64 characters long. Make sure to keep a backup of the key as it without the key you may not be able to recover any of your ngSurvey data.

  • NGSurvey:AccountLockoutThreshold number of times a login can try to authenticate before its being locked out.

  • NGSurvey:AccountLockoutDurationnumber of minutes during which the login account is locked before allowing to authenticate again.

  • NGSurvey:EnableHSTSenables HSTS if you are using SSL all cookies will be set as secure.

  • NGSurvey:WebSetupDisableddisable the web installation interface of ngSurvey to true.

  • NGSurvey:CaptchaDisableddisable catpcha features if set to true.

  • NGSurvey:TwoFactorDisableddisables two factor on login authentication if set true. Can be used to bypass the two factor authentication if any issue arises.

  • NGSurvey:ClearActivityLogsOlderThanDaysnumber of days to keep the activity log data.

  • NGSurvey:ClearActivityLogTresholdDaysnumber of days before the activity log data gets permanently deleted.

  • NGSurvey:EncryptActivityLogif set to true will encrypt the activity log data at the database level.

  • NGSurvey:PersitentMailStorageLocationpath to a folder that can be used to backup messages that are saved in the pickup exchange folder in case you are using the Exchange pickup folder to send out emails.

  • NGSurvey:MaxAllowedTextSizemaximum allowed text size in bytes that can be stored in the system. Can be used to prevent overflow attacks on the system. Default is 10485760.

  • NGSurvey:MailServerTestif set to true will not send directly emails through the configured mail server.

  • NGSurvey:LoadTestif set to true will allow posting multiple times the same respondent answers.

  • NGSurvey:AdminDisabledif set to true will disable all admin related features from the API. If disabled only the API related to survey retrieval and respondent submissions will be available.

  • NGSurvey:CPSPolicyif set to "Self" will enforce the content security policy (CSP) on the browser. Note that widget based answer items and any custom JavaScript related features will be disabled if set to Self.

  • NGSurvey:ProxyAddressURL of the proxy that should be used for external accesses (AI).

  • NGSurvey:ProxyUsernameUsername of the proxy (optional).

  • NGSurvey:ProxyPasswordPassword of the proxy (optional).

  • KeyVault:Name name of the Azure key vault if you plan to store your environment variable in Azure's key vault.

  • AzureAd:ClientId client Id of the Azure's key vault.

  • AzureAd:ClientSecret client secret to access the Azure's ley vault.

🚀
system settings
dacpac
cluster