How to install dbForge Documenter
dbForge tools can be installed using the installation wizard or from the command line. To learn how to install the tool on Linux or macOS, refer to How to Install dbForge Documenter on Linux & macOS.
This topic describes how to install dbForge Documenter for SQL Server on Windows OS.
Install dbForge Documenter for SQL Server using the installation wizard
Note
Before starting the installation process, make sure all the running instances of the product and SSMS are closed.
1. Download the product from the Devart website.
2. Run documentersql.exe to begin installation.
3. On the Welcome to the dbForge Documenter for SQL Server page, click Install.
4. On the Select Destination page, select the directory where dbForge Documenter for SQL Server will be installed. To change the default directory, click Browse. To restore the default directory, click Restore default location. If you don’t need a desktop shortcut, clear the Create a desktop shortcut check box, which is selected by default. Optionally, click the License Agreement link to check the end-user license agreement for dbForge Documenter for SQL Server. If you agree to the Devart dbForge Documenter for SQL Server License Terms, click Next.
5. On the Add-In page, select a product/products, which must include dbForge Documenter for SQL Server as an add-in. Click Next.
6. On the File Associations page, select the document types and file extensions that will be associated with this application when it is installed on your computer. Click Next.
7. On the Startup Optimization page, select the option that fits your needs best. Click Next.
8. Optionally, on the Installing page, you can interrupt the installation by clicking the Cancel button.
9. On the final page, click Finish to exit Setup wizard. Optionally, you can select the Launch dbForge Documenter for SQL Server option to start the application immediately after installation.
Install dbForge Documenter using Chocolatey
You can download and install dbForge Documenter using Chocolatey, which is a package manager for Windows. Before you start, ensure you have Chocolatey installed on your machine. If not, you can download it from the official website.
Once you have Chocolatey installed, you can follow these steps to install dbForge Documenter:
1. Open PowerShell as Administrator. For this, right-click the Windows PowerShell app, and select Run as administrator.
2. Ensure that the Get-ExecutionPolicy is not restricted. For this, run
Get-ExecutionPolicy
If it returns Restricted, then run
Set-ExecutionPolicy AllSigned
or
Set-ExecutionPolicy Bypass -Scope Process
This will allow PowerShell to run scripts for the current session.
3. Initiate the installation of dbForge Documenter. For this, enter the following command in the PowerShell window and press Enter:
choco install dbforge-sql-doc
Note
dbForge Documenter for SQL Server can be also downloaded and installed as part of the dbForge SQL Tools bundle, which includes 15 tools that extend Microsoft SSMS with multiple essential features. To download and install dbForge SQL Tools, run
choco install dbforge-sql-tools
4. Agree to run the script by pressing Y or A.
5. Wait for installation to complete. Chocolatey will download the dbForge Documenter for SQL Server package and install it on your computer.
6. Confirm the installation. Once the installation is complete, you can confirm it by running:
choco list --local-only
This command will list all the packages installed on your computer through Chocolatey. If the installation was successful, you should see dbforge-sql-doc or dbforge-sql-tools in this list, depending which product you chose to install.
Using Chocolatey, you can download and install all dbForge SQL tools at once. For more information, refer to How to Install 15 dbForge SQL Tools in 15 Minutes Using Chocolatey article.