Skip to main content

Install on QNAP

QNAP is a global producer of powerful yet affordable Network-Attached Storages (NAS). LogicalDOC is the perfect companion for your QNAP device. Find more information about QNAP here: https://www.qnap.com.

Warning

Before installing LogicalDOC inside your device, you should be aware of the hardware requirements and limitations. Click here to find out more.

Install the Container Station package

In QNAP, LogicalDOC will run as a Docker container. Docker is a virtualization environment available on all QNAP devices, so open the App Center and install the Container Station package.

Set up the Database container

We will set up a MariaDB container that will be used by LogicalDOC, so enter the Images tab of the Container Station interface, here click on the Pull button and download the latest mariadb image from Docker Hub.

Search for MariaDB

MariaDB image

Once the image gets downloaded, click on the icon Create container to create the container, the wizard will ask you the parameters, be sure to give the container name's logicaldoc-db:

MariaDB container creation

MariaDB container name

Configure the working parameters

Open the Advanced Settings and with the Add button set the following parameters:

ParameterSuggested valueDescription
MARIADB_ROOT_PASSWORDmypasswordthe password of the root user, LogicalDOC will not use it but you may use to manage your database
MARIADB_DATABASElogicaldocname of the database where LogicalDOC will store the data
MARIADB_USERldocusername used by LogicalDOC to connect to the database
MARIADB_PASSWORDchangemepassword used by LogicalDOC to connect to the database

MariaDB advanced settings

Map the ports

Open the Network tab and map the Container Port 3306 to the Host Port 3386.

MariaDB ports

Check the running container

At the end, you should see the logicaldoc-db container up and running in the Container area:

MariaDB container running

Set up the LogicalDOC container

After setting up the database, you proceed now to set up the container of the LogicalDOC application.

Open the Images tab of the Container Station interface, here click on the Pull button and download the latest logicaldoc/logicaldoc image from Docker Hub.

Search for LogicalDOC

LogicalDOC image

Once the image gets downloaded, click on the icon Create container to create the container, the wizard will ask you the parameters, be sure to give the container name's logicaldoc:

LogicalDOC container creation

LogicalDOC container name

Configure the working parameters

Open the Advanced Settings and set the following parameters:

ParameterSuggested valueDescription
LDOC_USERNOyour own license codeyou can get a trial license here: https://www.logicaldoc.com/try
LDOC_MEMORY3000memory allocated for LogicalDOC expressed in MB
DB_ENGINEmariadbthe database type, possible vaues are: mariadb, mysql, mssql, oracle, postgres
DB_HOSTthe IP of your QNAPthe database server host
DB_PORT3386the database communication port, use the same port used for the logicaldoc-db contain
DB_NAMElogicaldocthe database name, use the same db name used for the logicaldoc-db container
DB_INSTANCElogicaldocsome databases require the instance specification
DB_USERldocthe database username, use the same username used for the logicaldoc-db container
DB_PASSWORDchangemethe database password, use the same password used for the logicaldoc-db container
DB_MANUALURLfalsenot used, leave it false
DB_URLlogicaldocnot used, leave it logicaldoc
SSH_USERlogicaldocthe username to connect via SSH
SSH_PASSWORDchangemethe password to connect via SSH

LogicalDOC advanced settings

Map the ports

Open the Network tab and map the Container Port 8080 to the Host Port 1280 and the 22 to 1222:

LogicalDOC ports

Map the volumes

We suggest creating a dedicated folder called logicaldoc somewhere in your NAS and then the subfolders logicaldoc/conf and logicaldoc/repository

Then open the Shared Folders tab and map those folders to the LogicalDOC's volumes /LogicalDOC/conf and /LogicalDOC/repository:

LogicalDOC volumes

The volume /LogicalDOC/conf is where LogicalDOC saves the main configuration files, while the /LogicalDOC/repository is where your documents files are stored.

Check the running container

At the end, you should see the logicaldoc container up and running in the Container area:

LogicalDOC container running

At this point you should be able to enter LogicalDOC at http://IP_OF_YOUR_QNAP:1280  with admin as username and password