|
1 | 1 | # Netwrix Product Documentation
|
| 2 | + |
| 3 | +This repository contains the complete documentation site for all Netwrix products, built with [Docusaurus](https://docusaurus.io/). The site provides comprehensive user guides, configuration instructions, API documentation, and release notes for the entire Netwrix product suite. |
| 4 | + |
| 5 | +## What's Included |
| 6 | + |
| 7 | +This documentation covers the following Netwrix products: |
| 8 | + |
| 9 | +### Security & Compliance |
| 10 | +- **1Secure** - Cloud security posture management |
| 11 | +- **Access Analyzer** - File access permissions and data governance |
| 12 | +- **Auditor** - IT infrastructure auditing and compliance |
| 13 | +- **Threat Manager/Prevention** - Security threat detection and response |
| 14 | + |
| 15 | +### Identity & Access Management |
| 16 | +- **UserCube** (both on-premises and SaaS) - Identity governance and administration |
| 17 | +- **Password Policy Enforcer** - Active Directory password policy management |
| 18 | +- **Password Reset** - Self-service password reset solution |
| 19 | +- **Password Secure** - Privileged access management |
| 20 | +- **Privilege Secure** - Privileged account management |
| 21 | + |
| 22 | +### Change Management & Governance |
| 23 | +- **StrongPoint for NetSuite** - Change management and compliance for NetSuite |
| 24 | +- **StrongPoint for Salesforce** - Change management for Salesforce environments |
| 25 | +- **StrongPoint NetSuite Flashlight** - NetSuite documentation and analysis |
| 26 | +- **StrongPoint Salesforce Flashlight** - Salesforce documentation and analysis |
| 27 | + |
| 28 | +### IT Management |
| 29 | +- **Activity Monitor** - Real-time activity monitoring and alerting |
| 30 | +- **Change Tracker** - Infrastructure change tracking |
| 31 | +- **Data Classification** - Automated data discovery and classification |
| 32 | +- **Endpoint Protector** - Data loss prevention and device control |
| 33 | +- **Group ID** - Active Directory group management |
| 34 | +- **PolicyPak** - Group Policy management and enforcement |
| 35 | +- **Recovery for Active Directory** - AD backup and recovery |
| 36 | + |
| 37 | +### Additional Tools |
| 38 | +- **Access Information Center** - Centralized access reporting |
| 39 | +- Various configuration guides and API documentation |
| 40 | + |
| 41 | +## Prerequisites |
| 42 | + |
| 43 | +- **Node.js**: Version 18.0 or higher |
| 44 | +- **npm**: Comes with Node.js |
| 45 | + |
| 46 | +## Quick Start |
| 47 | + |
| 48 | +1. **Install dependencies:** |
| 49 | + ```bash |
| 50 | + npm install |
| 51 | + ``` |
| 52 | + |
| 53 | +2. **Start development server:** |
| 54 | + ```bash |
| 55 | + npm start |
| 56 | + ``` |
| 57 | + This starts a local development server and opens the site in your browser. Most changes are reflected live without requiring a restart. |
| 58 | + |
| 59 | +3. **Build for production:** |
| 60 | + ```bash |
| 61 | + npm run build |
| 62 | + ``` |
| 63 | + This generates static content into the `build` directory that can be served by any static hosting service. |
| 64 | + |
| 65 | +## Available Scripts |
| 66 | + |
| 67 | +- `npm start` - Start local development server |
| 68 | +- `npm run build` - Build the site for production |
| 69 | +- `npm run serve` - Serve the production build locally |
| 70 | +- `npm run clear` - Clear Docusaurus cache |
| 71 | +- `npm run typecheck` - Run TypeScript type checking |
| 72 | +- `npm run swizzle` - Eject and customize Docusaurus components |
| 73 | + |
| 74 | +## Project Structure |
| 75 | + |
| 76 | +``` |
| 77 | +docs/ |
| 78 | +├── docs/ # Documentation content |
| 79 | +│ ├── 1secure/ # 1Secure product docs |
| 80 | +│ ├── usercube/ # UserCube on-premises docs |
| 81 | +│ ├── usercube_saas/ # UserCube SaaS docs |
| 82 | +│ ├── strongpoint*/ # StrongPoint product variants |
| 83 | +│ └── [other-products]/ # Other product documentation |
| 84 | +├── static/ # Static assets (images, files) |
| 85 | +├── src/ # Custom React components and CSS |
| 86 | +├── sidebars/ # Navigation configuration per product |
| 87 | +├── versioned_docs/ # Versioned documentation |
| 88 | +├── docusaurus.config.js # Main Docusaurus configuration |
| 89 | +└── package.json # Dependencies and scripts |
| 90 | +``` |
| 91 | + |
| 92 | +## Deployment |
| 93 | + |
| 94 | +This project uses automatic deployment via Render: |
| 95 | + |
| 96 | +- **Production**: Automatically deploys when changes are pushed to the `main` branch |
| 97 | +- **Development**: Automatically deploys when changes are pushed to the `dev` branch |
| 98 | + |
| 99 | +The deployment process runs `npm run build` and serves the generated static files. |
| 100 | + |
| 101 | +## Writing Documentation |
| 102 | + |
| 103 | +- Documentation is written in **Markdown** with optional **MDX** support for React components |
| 104 | +- Each product has its own folder under `docs/` |
| 105 | +- Navigation is configured in the corresponding sidebar file in `sidebars/` |
| 106 | +- Images and downloadable files go in the `static/` directory |
| 107 | +- Use relative links between documentation pages |
| 108 | + |
| 109 | +## Configuration |
| 110 | + |
| 111 | +- **Main config**: `docusaurus.config.js` |
| 112 | +- **Product-specific builds**: `docusaurus.config.products.js` |
| 113 | +- **Sidebars**: Individual files in `sidebars/` directory |
| 114 | +- **Styling**: Custom CSS in `src/css/custom.css` |
| 115 | + |
| 116 | +## Technical Details |
| 117 | + |
| 118 | +- **Framework**: Docusaurus 3.8.1 |
| 119 | +- **React**: 18.3.1 |
| 120 | +- **Build tool**: Built-in Docusaurus build system |
| 121 | +- **Memory allocation**: Increased to 8GB for large documentation builds |
| 122 | +- **Browser support**: Modern browsers (see `browserslist` in package.json) |
| 123 | + |
| 124 | +## Contributing |
| 125 | + |
| 126 | +1. Make changes to the appropriate documentation files |
| 127 | +2. Test locally with `npm start` |
| 128 | +3. Ensure the build succeeds with `npm run build` |
| 129 | +4. Commit and push to the appropriate branch (`dev` for testing, `main` for production) |
| 130 | + |
| 131 | +## Support |
| 132 | + |
| 133 | +For technical issues with the documentation site, please check: |
| 134 | +1. The Docusaurus documentation: https://docusaurus.io/docs |
| 135 | +2. Build logs in the deployment system |
| 136 | +3. Browser console for client-side issues |
| 137 | + |
| 138 | +For product-specific documentation questions, refer to the respective product documentation or contact the product teams. |
0 commit comments