> For the complete documentation index, see [llms.txt](https://docs.tivity.one/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.tivity.one/platform-features/document-management-system-dms/dms-setup.md).

# DMS Setup

Tivity DMS Setup command-line interface provides a tool to install or uninstall the TIVITY DMS which handles document related actions.

### Install

The install verb is used to install TIVITY DMS.

#### Options

* path: The absolute path of the instance to setup.
* dms-version (cached): The version of the installation.
* dms-logs-directory (cached): The absolute path of the logs. Default: \[path]\Logs.
* dms-db-host (cached): The SQL host of the SQL server to connect to.
* dms-db-port (cached): The SQL port of the SQL server to connect to.
* dms-db-database (cached): The SQL database to create or use.
* dms-db-username (cached): The SQL username to use to connect to the SQL server.
* dms-db-password: The SQL password to use to connect to the SQL server.
* dms-db-setupsame (cached): Use the same username and password during the setup \[true|false].
* dms-db-setupusername (cached): The SQL username to use to connect to the SQL server during the setup only.
* dms-db-setuppassword: The SQL password to use to connect to the SQL server during the setup only.
* dms-iis-site (cached): The IIS site to use.
* dms-iis-applicationpool (cached): The IIS application pool to use.
* dms-iis-application (cached): The IIS application of the site to create or use.
* dms-iis-applicationpath (cached): The absolute path of the IIS application. Default: \[path]\Web.
* dms-storage-directory (cached): The absolute path of the storage.
* dms-storage-tempdirectory (cached): The absolute path of the temp storage. Default: \[dms-storage-directory]\Temp.
* dms-storage-domain (cached): The Windows domain to use to access the storage.
* dms-storage-username (cached): The Windows username to use to access the storage.
* dms-storage-password: The Windows password to use to access the storage.
* dms-application-domain (cached): The DMS domain to use to connect to the REST-API.
* dms-application-username (cached): The DMS username to use to connect to the REST-API.
* dms-application-password: The DMS password to use to connect to the REST-API.
* dms-services-independent (cached): Run the services independent \[true|false].
* dms-services-storage-directory (cached): The relative path of the storage files. Default: \[dms-storage-directory]\Storage
* dms-services-indexing-path (cached): The absolute path of the indexing service. Default: \[path]\Indexing.
* dms-services-indexing-name (cached): The name of the indexing service (do not change). Default: DMS-Indexing-Service.
* dms-services-indexing-port (cached): The port of the indexing service (do not change). Default: 50515.
* dms-services-indexing-directory (cached): The relative directory of the indexing files. Default: Indexing.
* dms-services-thumbnail-path (cached): The absolute path of the thumbnail service. Default: \[path]\Thumbnails.
* dms-services-thumbnail-name (cached): The name of the thumbnail service (do not change). Default: DMS-Thumbnail-Service.
* dms-services-thumbnail-port (cached): The port of the thumbnail service (do not change). Default: 50525.
* dms-services-thumbnail-directory (cached): The relative directory of the thumbnail files. Default: Thumbnails.
* dms-services-preview-path (cached): The absolute path of the preview service. Default: \[path]\Previews.
* dms-services-preview-name (cached): The name of the preview service (do not change). Default: DMS-Preview-Service.
* dms-services-preview-port (cached): The port of the preview service (do not change). Default: 50505.
* dms-services-preview-directory (cached): The relative directory of the preview files. Default: Previews.
* dms-services-watcher-path (cached): The absolute path of the watcher service. Default: \[path]\Watcher.
* dms-services-watcher-name (cached): The name of the watcher service (do not change). Default: DMS-Watcher-Service.
* dms-services-watcher-port (cached): The port of the watcher service (do not change). Default: 50535.
* tika-path (cached): The absolute path of the Tika service. Default: \[path]\Tika.
* tika-name (cached): The name of the Tika service (do not change). Default: DMS-Tika-Service.
* tika-port (cached): The port of the Tika service (do not change). Default: 50545.

### Uninstall

The uninstall verb is used to uninstall the TIVITY DMS.

#### Options

See install options.

#### Version

The version verb will output the version of the setup (no options are supported).