# Setup, Configuration and Management - [CryoSPARC Architecture and System Requirements](https://guide.cryosparc.com/setup-configuration-and-management/hardware-and-system-requirements.md): Description of CryoSPARC HPC software system architecture, typical setups (e.g., workstation, cluster). - [CryoSPARC Installation Prerequisites](https://guide.cryosparc.com/setup-configuration-and-management/cryosparc-installation-prerequisites.md): Before installing CryoSPARC, ensure these six requirements are met. - [How to Download, Install and Configure](https://guide.cryosparc.com/setup-configuration-and-management/how-to-download-install-and-configure.md): Meeting system requirements, obtaining a License ID, and downloading & installing CryoSPARC. - [Obtaining A License ID](https://guide.cryosparc.com/setup-configuration-and-management/how-to-download-install-and-configure/obtaining-a-license-id.md): Fill out the form to obtain a License ID required for installing and using CryoSPARC. - [Downloading and Installing CryoSPARC](https://guide.cryosparc.com/setup-configuration-and-management/how-to-download-install-and-configure/downloading-and-installing-cryosparc.md): Downloading and installing the cryosparc\_master and cryosparc\_worker packages. - [CryoSPARC Cluster Integration Script Examples](https://guide.cryosparc.com/setup-configuration-and-management/how-to-download-install-and-configure/cryosparc-cluster-integration-script-examples.md): Examples of cluster\_info.json and cluster\_script.sh scripts for various cluster workload managers - [Accessing the CryoSPARC User Interface](https://guide.cryosparc.com/setup-configuration-and-management/how-to-download-install-and-configure/accessing-cryosparc.md): Viewing the user interface locally and from home - [(Optional) Hosting CryoSPARC Through a Reverse Proxy](https://guide.cryosparc.com/setup-configuration-and-management/how-to-download-install-and-configure/optional-hosting-cryosparc-through-a-reverse-proxy.md) - [Software Updates and Patches](https://guide.cryosparc.com/setup-configuration-and-management/software-updates.md): How to get the latest CryoSPARC features and fixes or roll back to a previous version. - [Management and Monitoring (≤v4.7)](https://guide.cryosparc.com/setup-configuration-and-management/management-and-monitoring-4.7.md): Instructions for accessing and working in the CryoSPARC command line. - [Environment variables (≤v4.7)](https://guide.cryosparc.com/setup-configuration-and-management/management-and-monitoring-4.7/environment-variables-v4.7.md): (Advanced) Specify additional environment variables in the configuration files to augment CryoSPARC's low-level behaviour. - [cryosparcm reference (≤v4.7)](https://guide.cryosparc.com/setup-configuration-and-management/management-and-monitoring-4.7/cryosparcm-4.7.md): How to use the cryosparcm utility for starting and stopping the CryoSPARC instance, checking status or logs, managing users and using CryoSPARC's command-line interface. - [cryosparcm cli reference (≤v4.7)](https://guide.cryosparc.com/setup-configuration-and-management/management-and-monitoring-4.7/cli-4.7.md): How to use CryoSPARC's low-level command-line interface. - [cryosparcw reference (≤v4.7)](https://guide.cryosparc.com/setup-configuration-and-management/management-and-monitoring-4.7/cryosparcw-4.7.md): How to use the cryosparcw utility for managing CryoSPARC workers - [Management and Monitoring (v5.0+)](https://guide.cryosparc.com/setup-configuration-and-management/management-and-monitoring-v5.0.md): Instructions for accessing and working in the CryoSPARC command line. - [Environment Variables (v5.0+)](https://guide.cryosparc.com/setup-configuration-and-management/management-and-monitoring-v5.0/environment-variables-v5.0.md): (Advanced) Specify additional environment variables in the configuration files to augment CryoSPARC's low-level behaviour. - [cryosparcm reference (v5.0+)](https://guide.cryosparc.com/setup-configuration-and-management/management-and-monitoring-v5.0/cryosparcm-reference-v5.0.md): How to use the cryosparcm utility for starting and stopping the CryoSPARC instance, checking status or logs, managing users and using CryoSPARC's command-line interface. - [cryosparcm cli reference (v5.0+)](https://guide.cryosparc.com/setup-configuration-and-management/management-and-monitoring-v5.0/cryosparcm-cli-reference-v5.0.md): How to use CryoSPARC's low-level command line interface to perform actions that can be performed in the UI. - [cryosparcw reference (v5.0+)](https://guide.cryosparc.com/setup-configuration-and-management/management-and-monitoring-v5.0/cryosparcw-reference-v5.0.md): How to use the cryosparcw utility for managing CryoSPARC workers - [Software System Guides](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides.md): CryoSPARC software management guides. - [Guide: Updating to CryoSPARC v5 (BETA)](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-updating-to-cryosparc-v5.md): CryoSPARC v5 is backwards compatible with v4. The update process includes new validation steps that may take some time, up to one hour for larger instances. - [Guide: Updating to CryoSPARC v4](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-updating-to-cryosparc-v4.md): Installing or updating to CryoSPARC v4 is similar to previous versions of CryoSPARC, but downgrading is not possible past v3.4.0. - [Guide: Installation Testing with cryosparcm test](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-installation-testing-with-cryosparcm-test.md): This guide covers how to use cryosparcm test to verify your CryoSPARC installation is working properly. - [Guide: Verify CryoSPARC Installation with the Extensive Validation Job (v4.3+)](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/tutorial-verify-cryosparc-installation-with-the-extensive-workflow-sysadmin-guide.md) - [Guide: Verify CryoSPARC Installation with the Extensive Workflow (≤v4.2)](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/tutorial-verify-cryosparc-installation-with-the-extensive-workflow-sysadmin-guide-1.md) - [Guide: Performance Benchmarking (v4.3+)](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-performance-benchmarking-v4.3.md): This guide covers the new benchmarking tool in CryoSPARC that allows for benchmarking a worker’s filesystem, CPUs and GPUs. Available in CryoSPARC v4.3.0+. - [Guide: Download Error Reports](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-download-error-reports.md): How to download job and system-level error reports from within the application. - [Guide: Maintenance Mode and Configurable User Facing Messages](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-maintenance-mode-and-configurable-user-facing-messages.md): Pause the job queue during updates and set optional user facing messages. - [Guide: User Management](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/tutorial-user-management.md): User creation, management, setting roles and password management through the CryoSPARC user interface. - [Guide: Multi-user Unix Permissions and Data Access Control](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/unix-permissions-and-data-access-control.md): Tips on how to manage permissions and data access control. - [Guide: Lane Assignments and Restrictions](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-lane-assignments-and-restrictions.md): Assigning CryoSPARC users to specific scheduler lanes. - [Guide: Priority Job Queuing](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/tutorial-priority-job-queuing.md): How to prioritize jobs to override the CryoSPARC scheduler's default behaviour. - [Guide: Configuring Custom Variables for Cluster Job Submission Scripts](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-configuring-custom-variables-for-cluster-job-submission-scripts.md) - [Guide: SSD Particle Caching in CryoSPARC](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/tutorial-ssd-particle-caching-in-cryosparc.md): Overview of how SSD particle caching works, how much SSD space you need, configuration options and troubleshooting. - [Guide: Data Management in CryoSPARC (v4.0+)](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-data-management-in-cryosparc-v4.0.md): An overview of all data management utilities and common use cases. - [Guide: Data Cleanup (v4.3+)](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-data-cleanup-v4.3.md): New features in v4.3+ for managing and cleaning up project data. - [Guide: Reduce Database Size (v4.3+)](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-reduce-database-size-v4.3.md): A guide on reducing the size of large CryoSPARC databases using methods provided by MongoDB. - [Guide: CryoSPARC Live Session Data Management (≤v4.7)](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/cryosparc-live-session-data-management-4.7.md): How to manage the data created by your cryoSPARC Live Sessions via the user interface and data management API. - [Guide: Instance Recovery (v5.0+)](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/guide-instance-recovery-v5.0.md): How to recover a CryoSPARC instance if the database directory is corrupted or lost. - [Guide: Migrating your CryoSPARC Instance](https://guide.cryosparc.com/setup-configuration-and-management/software-system-guides/tutorial-migrating-your-cryosparc-instance.md): A guide to moving CryoSPARC from one location to another. - [Deploying CryoSPARC on AWS](https://guide.cryosparc.com/setup-configuration-and-management/cryosparc-on-aws.md): Version 1.0 (May 10, 2021) - [Performance Benchmarks](https://guide.cryosparc.com/setup-configuration-and-management/cryosparc-on-aws/performance-benchmarks-aws.md): Version 1.0 (May 10, 2021) - [Troubleshooting](https://guide.cryosparc.com/setup-configuration-and-management/troubleshooting.md): Overview of common issues and advice on how to resolve them. --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://guide.cryosparc.com/setup-configuration-and-management.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.