For the complete documentation index, see llms.txt. This page is also available as Markdown.

Docker

Run on any platform supporting docker images

Usage

To run ngSurvey on your local machine using port 8080:

  1. Pull the Docker image from Docker Hub.

  2. Set the required ConnectionStrings:NgSurveyDB environment variable to your database host and details.

docker pull ngsurvey/ngsurveyee:latest
docker run -d --name ngsurvey -p 8080:80 -e "ConnectionStrings:NGSurveyDB=Server=YourSQLServerHost;Initial Catalog=NGSurvey;User ID=youruserid;Password=yourpassword" ngsurvey/ngsurveyee:latest

Once running, access ngSurvey at http://localhost:8080 with the default account:

  • User: ngsadmin

  • Password: admin

To deploy on platforms like Azure, AWS, Google Cloud, or Windows Server, consult the respective vendor's Docker documentation.


Using Docker Compose - SQL Express

For a quick 5-minute setup with ngSurvey and a fully configured SQL Express instance with persistent data storage:

  1. Download the pre-configured YAML file: ngsurveyee.yml.

  2. Run the following command:

    docker-compose -f ngsurveyee.yml up

ngSurvey will be available at http://localhost:8080.

  • The setup creates two containers: one for ngSurvey and one for SQL Express.

  • Data will persist even if the containers are updated or stopped.

  • Important: Update the default password in ngsurveyee.yml using a text editor before deployment.


Using Docker Compose - MySQL

For a quick 5-minute setup with ngSurvey and a fully configured MySQL instance with persistent data storage:

  1. Download the pre-configured YAML file: ngsurveyee.mysql.yml.

  2. Run the following command:

ngSurvey will be available at http://localhost:8080.

  • The setup creates two containers: one for ngSurvey and one for MySQL.

  • Data will persist even if the containers are updated or stopped.

  • Important: Update the default password in ngsurveyee.mysql.yml using a text editor before deployment.


Using Docker Compose - PostgreSQL

For a quick 5-minute setup with ngSurvey and a fully configured PostgreSQL instance with persistent data storage:

  1. Download the pre-configured YAML file: ngsurveyee.postgres.yml.

  2. Run the following command:

ngSurvey will be available at http://localhost:8080.

  • The setup creates two containers: one for ngSurvey and one for PostgreSQL.

  • Data will persist even if the containers are updated or stopped.

  • Important: Update the default password in ngsurveyee.postgres.yml using a text editor before deployment.


Database Setup

Out of the box, ngSurvey will automatically configure, create, or update the database specified in your connection string. When running on AWS, ngSurvey will automatically pick up all RDS connection properties.


Mail Server / Third-Party APIs Setup

Once installed, you can configure your mail server via the Administration > System > Settings page. You can also set up third-party API integrations such as Google reCAPTCHA.



If you're planning to collect a large amount of files or use a large amount of files as medias we would recommend setting up a Docker volume and use ngSurvey filesystem storage feature to store your files.

Last updated

Was this helpful?