Installation
Last updated
Was this helpful?
Last updated
Was this helpful?
The dms+ application can be installed in two different ways. Please refer to the respective chapters for further details:
You can install the dms+ application in a docker container network. This section describes how to do that.
You must have administrator privileges on the machine where you want to execute the application
You need to have an installation of the docker engine and docker compose (see ) on the machine where you want to execute the application
Download the latest release and put all files and subfolders from the _environment directory to a location of your choice on your hard drive.
Rename the file dms.env.example to dms.env and adjust the included environment variables for the MySQL connection:
Start the docker containers via a terminal window with the following script that automatically handles all necessary docker commands for you:
sh ./dms-restart.sh
After a while, you should see the following output in the terminal:
If you don't want to use the pre-configured docker compose files to run your installation of dms+, then you can also install application as standalone version. This section describes how to do that.
You must have administrator privileges on your machine
You need to make sure that the following packages are installed on your machine: build-essential, gd, libpng-dev, libjpeg62-turbo-dev, libfreetype6-dev, locales, libzip-dev, zip, jpegoptim, optipng, pngquant, gifsicle, vim, unzip, git, curl, netcat, pdo_mysql, mbstring, exif and pcntl
install composer - on linux based machines you can simply run this command:
Copy the laravel directory to the webserver's root directory (usually /var/www/html). In the remaining bits of this wiki this location is referred to as LARAVEL_HOME.
Run the command composer install in the LARAVEL_HOME directory.
Copy the scanner directory to a directory of your choice. In the remaining bits of this wiki this location is referred to as SCANNER_HOME.
create the following sub directories in the LARAVEL_HOME directory:
LARAVEL_HOME/storage/logs
LARAVEL_HOME/storage/search
LARAVEL_HOME/storage/app/documents
create a symbolic link from LARAVEL_HOME/public/files to /var/www/storage/app/documents
The following steps need to be carried out (in order) to configure the application appropriately: 1. Create a new user for a new database on your mysql server 2. Take over the settings from the LARAVEL_HOME/config/php/local.ini into the php configuration file of your web server 3. Configure a virtual host for port 9000 on your web server pointing to the LARAVEL_HOME directory 4. Set the following environment variables in your .profile file according to the settings made in steps 1 and 2:
WEB_HOST (e. g. localhost:9000)
DB_HOST (e. g. localhost)
MYSQL_DATABASE (e. g. myDatabase)
MYSQL_USER (e. g. dmsAdmin)
MYSQL_PASSWORD (e. g. aHard2GuessPwd)
Generate a Laravel application key with php artisan generate:key
Populate the database by running php artisan migrate and php artisan db:seed in the LARAVEL_HOME directory
Setup a cronjob that runs the shell script watch.sh in SCANNER_HOME directory periodically (e. g. every hour)
This indicates that the start up was successful. Please continue with the section in order to check if everything went well.
You need a running server version 8.0 or higher
You need a running server version 7.3 or higher with Apache (alternatively you can use a corresponding version fronted by version 1.17 or higher)
You need an installation of version 9.7 or higher
Download the latest release from the and unzip or untar it on the server you want to run the application. The unzipped folder contains the directories laravel and scanner. Carry out the following steps in order to install the application:
Simply startup your web server. Please continue with the section in order to continue.
When you open the dms+ web application via you should see the following landing page:
Please refer to the for further information on how to navigate the application.