Installation Guide¶
This document will guide you through the GovReady-Q installation process.
Setting up GovReady-Q involves installing the GovReady-Q server, a database, a WSGI server to run the Python code, and optionally connecting GovReady-Q to a mailserver to send invitations and notifications.
Note
This is a note.
Contents
- System Requirements
- Installing GovReady-Q server
- CentOS / RHEL 7 from sources
- 1. Installing required OS packages
- 2. Cloning the GovReady-Q repository
- 3. Installing desired database
- 4. Creating the local/environment.json file
- 5. Installing GovReady-Q
- 6. Starting and stopping GovReady-Q
- 7. Running GovReady-Q with Gunicorn HTTP WSGI
- 8. Monitoring GovReady-Q with Supervisor
- 9. Using NGINX as a reverse proxy
- 10. Additional options
- Notes
- Ubuntu from sources
- 1. Installing required OS packages
- 2. Cloning the GovReady-Q repository
- 3. Installing desired database
- 4. Creating the local/environment.json file
- 5. Installing GovReady-Q
- 6. Starting and stopping GovReady-Q
- 7. Running GovReady-Q with Gunicorn HTTP WSGI
- 8. Monitoring GovReady-Q with Supervisor
- 9. Using NGINX as a reverse proxy
- 10. NGINX with HTTPS
- 11. Additional options
- Notes
- macOS from sources
- Installing GovReady-Q server using Docker
- Docker Local
- 1. Installing Docker
- 2. Running GovReady-Q server container
- 3. Stopping, starting GovReady-Q server container
- 4. Destroying the GovReady-Q server container
- 5. Viewing the GovReady-Q server logs in the container
- Advanced configuration options
- Docker Cloud
- 1. Installing Docker
- 2. Running GovReady-Q server container
- 3. Stopping, starting GovReady-Q server container
- 4. Destroying the GovReady-Q server container
- 5. Viewing the GovReady-Q server logs in the container
- Advanced configuration options
- Advanced Container Configuration Examples
- Example 1 - Basic Container Deployment with HTTPS, Persistent Database
- Example 2 - Enterprise Container Deployment with SSO, HTTPS, Persistent Database
- Advanced Container Configuration Options
- The docker_container_run.sh script
- Changing the hostname and port
- Persistent database
- Configuring email
- Container management and other options
- Adding and developing compliance apps
- Logs for Debugging
- Production deployment of the Docker container
- Secure deployments
- Other management commands
- Updating to a new release of GovReady-Q
- Environment variables for launching the container without our run script
- Running tests
- Populating sample data for manual testing and verification
- Advanced Container Configuration Options
- Advanced Container Configuration Options
- The docker_container_run.sh script
- Changing the hostname and port
- Persistent database
- Configuring email
- Container management and other options
- Adding and developing compliance apps
- Logs for Debugging
- Production deployment of the Docker container
- Secure deployments
- Other management commands
- Updating to a new release of GovReady-Q
- Environment variables for launching the container without our run script
- Running tests
- Populating sample data for manual testing and verification
- Advanced Container Configuration Examples
- Advanced Container Configuration Examples
- Example 1 - Basic Container Deployment with HTTPS, Persistent Database
- Example 2 - Enterprise Container Deployment with SSO, HTTPS, Persistent Database
- Advanced Container Configuration Options
- The docker_container_run.sh script
- Changing the hostname and port
- Persistent database
- Configuring email
- Container management and other options
- Adding and developing compliance apps
- Logs for Debugging
- Production deployment of the Docker container
- Secure deployments
- Other management commands
- Updating to a new release of GovReady-Q
- Environment variables for launching the container without our run script
- Running tests
- Populating sample data for manual testing and verification
- Advanced Container Configuration Options
- Advanced Container Configuration Options
- The docker_container_run.sh script
- Changing the hostname and port
- Persistent database
- Configuring email
- Container management and other options
- Adding and developing compliance apps
- Logs for Debugging
- Production deployment of the Docker container
- Secure deployments
- Other management commands
- Updating to a new release of GovReady-Q
- Environment variables for launching the container without our run script
- Running tests
- Populating sample data for manual testing and verification
- Docker Cloud
- Docker Cloud
- 1. Installing Docker
- 2. Running GovReady-Q server container
- 3. Stopping, starting GovReady-Q server container
- 4. Destroying the GovReady-Q server container
- 5. Viewing the GovReady-Q server logs in the container
- Advanced configuration options
- Advanced Container Configuration Examples
- Example 1 - Basic Container Deployment with HTTPS, Persistent Database
- Example 2 - Enterprise Container Deployment with SSO, HTTPS, Persistent Database
- Advanced Container Configuration Options
- The docker_container_run.sh script
- Changing the hostname and port
- Persistent database
- Configuring email
- Container management and other options
- Adding and developing compliance apps
- Logs for Debugging
- Production deployment of the Docker container
- Secure deployments
- Other management commands
- Updating to a new release of GovReady-Q
- Environment variables for launching the container without our run script
- Running tests
- Populating sample data for manual testing and verification
- Advanced Container Configuration Options
- Advanced Container Configuration Options
- The docker_container_run.sh script
- Changing the hostname and port
- Persistent database
- Configuring email
- Container management and other options
- Adding and developing compliance apps
- Logs for Debugging
- Production deployment of the Docker container
- Secure deployments
- Other management commands
- Updating to a new release of GovReady-Q
- Environment variables for launching the container without our run script
- Running tests
- Populating sample data for manual testing and verification
- Advanced Container Configuration Examples
- Advanced Container Configuration Examples
- Example 1 - Basic Container Deployment with HTTPS, Persistent Database
- Example 2 - Enterprise Container Deployment with SSO, HTTPS, Persistent Database
- Advanced Container Configuration Options
- The docker_container_run.sh script
- Changing the hostname and port
- Persistent database
- Configuring email
- Container management and other options
- Adding and developing compliance apps
- Logs for Debugging
- Production deployment of the Docker container
- Secure deployments
- Other management commands
- Updating to a new release of GovReady-Q
- Environment variables for launching the container without our run script
- Running tests
- Populating sample data for manual testing and verification
- Advanced Container Configuration Options
- Advanced Container Configuration Options
- The docker_container_run.sh script
- Changing the hostname and port
- Persistent database
- Configuring email
- Container management and other options
- Adding and developing compliance apps
- Logs for Debugging
- Production deployment of the Docker container
- Secure deployments
- Other management commands
- Updating to a new release of GovReady-Q
- Environment variables for launching the container without our run script
- Running tests
- Populating sample data for manual testing and verification
- Docker Local
- GovReady-Q and Wazuh via Docker Compose
- CentOS / RHEL 7 from sources
- Deploying GovReady-Q for Development
- Deploying GovReady-Q in Production environments
- Setting up a Database for Production Workloads
- Configuring a Reverse Proxy Webserver for Production Use
- Environment Settings
- Enterprise Single-Sign On / Login
- Applying Custom Organization Branding
- Multi-Container GovReady-Q and NGINX via Docker Compose