Reviewed installation guide
This commit is contained in:
parent
bf48d8890d
commit
8133d7f116
6 changed files with 135 additions and 305 deletions
|
|
@ -27,7 +27,7 @@ See http://www.php.net and http://www.mysql.com for more information.
|
|||
INSTALLATION
|
||||
------------
|
||||
|
||||
### 1. Download SuiteDesk
|
||||
### 1. DOWNLOAD SUITEDESK
|
||||
|
||||
You can obtain the latest **SuiteDesk** release from:
|
||||
|
||||
|
|
@ -45,72 +45,12 @@ your web server's document root or your public HTML directory:
|
|||
|
||||
mv suitedesk-version/* suitedesk-version/.htaccess /var/www/html
|
||||
|
||||
### 2. Download PDF tools
|
||||
### 2. DOWNLOAD AND INSTALL LIBRARIES
|
||||
|
||||
**wkhtmltopdf support**
|
||||
Just follow the instructions provided in the `README.md` file available in the
|
||||
`libraries` directory to install the required libraries.
|
||||
|
||||
The print PDF module requires the use of an external PDF generation tool. The
|
||||
currently supported is *wkhtmltopdf*. To install follow the next steps:
|
||||
|
||||
1. Download *wkhtmltopdf* from https://wkhtmltopdf.org/downloads.html. You can
|
||||
choose to download the source and compile it or simply download the static
|
||||
binary, which doesn't require you to compile anything. Note that the compiled
|
||||
version may require a running X server (static uses patched libs that can
|
||||
work without one).
|
||||
2. Place the `wkhtmltopdf` executable into the `libraries` directory. You can
|
||||
also place a symbolic link to the executable.
|
||||
3. Check https://wkhtmltopdf.org/usage/wkhtmltopdf.txt for further information.
|
||||
|
||||
**TCPDF support**
|
||||
|
||||
Used by the invoices module. This module requires TCPDF >= 6.2.000.
|
||||
|
||||
1. Download TCPDF from http://sourceforge.net/projects/tcpdf.
|
||||
2. Extract the contents of the downloaded package into the `libraries`
|
||||
directory. There is no need to modify the `config/tcpdf_config.php` file, as
|
||||
the module self-configures TCPDF.
|
||||
3. Grant write access to the `cache` and `images` directories to your webserver
|
||||
user.
|
||||
4. Check http://tcpdf.sourceforge.net for further information.
|
||||
|
||||
### 3. Download HTML Purifier library
|
||||
|
||||
Make sure you check *HTML Purifier* and make sure that you have fulfilled all of
|
||||
its requirements before running this. Specifically, you'll need the PHP
|
||||
extension `ctype` (in almost all PHP distributions), and it's nice to have `dom`
|
||||
and `iconv`.
|
||||
|
||||
Download HTML Purifier from http://htmlpurifier.org. You will need 4.8.0 or
|
||||
later. Extract the `library` folder to `libraries` directory. The final setup
|
||||
should be:
|
||||
|
||||
libraries/htmlpurifier/
|
||||
HTMLPurifier
|
||||
HTMLPurifier.autoload.php
|
||||
HTMLPurifier.auto.php
|
||||
HTMLPurifier.func.php
|
||||
HTMLPurifier.includes.php
|
||||
HTMLPurifier.kses.php
|
||||
HTMLPurifier.path.php
|
||||
HTMLPurifier.php
|
||||
HTMLPurifier.safe-includes.php
|
||||
|
||||
### 4. Download dhtmlxGantt library
|
||||
|
||||
Download dhtmlxGantt from https://dhtmlx.com/docs/products/dhtmlxGantt/. You
|
||||
will need 3.2.0 or later. Extract the `codebase` folder and rename it to
|
||||
`dhtmlxgantt` in the `libraries` directory. The final setup should be:
|
||||
|
||||
libraries/dhtmlxGantt/
|
||||
connector
|
||||
ext
|
||||
locale
|
||||
skins
|
||||
sources
|
||||
dhtmlxgantt.css
|
||||
dhtmlxgantt.js
|
||||
|
||||
### 5. Create the configuration file and grant write permissions
|
||||
### 3. CREATE THE CONFIGURATION FILE AND GRANT WRITE PERMISSIONS
|
||||
|
||||
**SuiteDesk** comes with a `default.settings.php` file in the `config/default`
|
||||
directory. Use this file as a template to create your settings file. To avoid
|
||||
|
|
@ -131,7 +71,7 @@ write privileges to the `config/default` directory with the command (from the
|
|||
|
||||
chmod o+w config/default
|
||||
|
||||
### 6. Create the SuiteDesk database
|
||||
### 4. CREATE THE SUITEDESK DATABASE
|
||||
|
||||
**SuiteDesk** requires access to a database in order to be installed. Your
|
||||
database user will need sufficient privileges to run **SuiteDesk**.
|
||||
|
|
@ -226,7 +166,7 @@ collation in the `$db_collation` setting. Important:
|
|||
to use the 'utf8_unicode_ci' collation instead.
|
||||
- More information at http://drupal.org/node/772678
|
||||
|
||||
### 7. Populate the database
|
||||
### 5. POPULATE THE DATABASE
|
||||
|
||||
Run the next command to setup the database, create tables, populate them, set
|
||||
the first users accounts and provide basic web site settings. Remember, you will
|
||||
|
|
@ -258,7 +198,7 @@ security risk. Although the default location for the settings.php file is at
|
|||
config/default/settings.php, it may be in another location if you use the
|
||||
multi-site setup, as explained below.
|
||||
|
||||
### 8. Review file system storage settings and file permissions
|
||||
### 6. REVIEW FILE SYSTEM STORAGE SETTINGS AND FILE PERMISSIONS
|
||||
|
||||
The files directory created in previous step is the default file system path
|
||||
used to store all uploaded files, as well as some temporary files created by
|
||||
|
|
@ -316,7 +256,7 @@ documentation files from public view, repeat this command for each of the Drupal
|
|||
documentation files in the `config` directory, substituting the name of each
|
||||
file for CHANGELOG.md in the example.
|
||||
|
||||
### 9. Initial configuration and first access
|
||||
### 7. INITIAL CONFIGURATION AND FIRST ACCESS
|
||||
|
||||
When the install script succeeds, you will be directed to the "Welcome" page,
|
||||
and you will be logged in as the administrator already. Proceed with the initial
|
||||
|
|
@ -367,7 +307,7 @@ preferred and use one of the next pre-configured Drupal/**SuiteDesk** users:
|
|||
It's highly recommended to change the password of all these users before
|
||||
delivery the site in production.
|
||||
|
||||
### 10. Cron Maintenance tasks
|
||||
### 8. CRON MAINTENANCE TASKS
|
||||
|
||||
Many **SuiteDesk** modules have periodic tasks that must be triggered by a cron
|
||||
maintenance task, including search module (to build and update the index used
|
||||
|
|
|
|||
Reference in a new issue