The following guide describes a git based installation of the HumHub platform. Please note that this is only recommended for developers and testers and should not be used in production environments. For production environments, please follow the Installation Guide for Administrators.
Crate a MySQL/MariaDB database:
CREATE DATABASE `humhub` CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;
Fore more infos check the Database Setup Section.
Clone the git repository into the
htdocs directory of your webserver:
git clone https://github.com/humhub/humhub.git
Navigate to your HumHub
web-root directory and fetch your composer dependencies:
Run web installer
- Make sure the
debugmode is enabled (default), see Enable Production Mode
- Disable caching under
Administration -> Settings -> Advanced -> Caching -> None
- Use file based mailing
Administration -> Settings -> Advanced -> E-Mail
Since HumHub makes heavy use of Queued Jobs you should configure the
Instant or Sync Queue for your developement environment or setup the
Cronjob for a production like environment. Otherwise you'll
have to run
queue/run command manually in order to execute queued tasks as notifications and summary mail.
Module Loader Path
The default path under which HumHub searches for installed modules is
@humhub/protected/modules. Additional search paths
can be configured within
@humhub/protected/config/common.php as follows:
// @humhub/protected/config/common.phpreturn ['params' => ['moduleAutoloadPaths' => ['/some/folder/modules'],],]
This separation can be useful in your development environment in order to define a central module directory for different test installations and prevent interference with marketplace modules.
Yii Debug Module
You may want to enable the Yii Debug Module for detailed
request and query debugging. Just add the following block to your local web configuration
return ['bootstrap' => ['debug'],'modules' => ['debug' => ['class' => 'yii\debug\Module','allowedIPs' => ['127.0.0.1', '::1'],],]];
Update your installation
Git based installations can be updated manually as follows:
- Pull updates from git:
git pull origin master
- Run database migrations within your HumHub
php yii migrate/up --includeModuleMigrations=1
- You may also need to also run a
composer installafter an update in order to update third party dependencies.
⚠️ Note that the HumHub Updater module won't work on git based installations, therefore you'll have to update and migrate your HumHub manually.
Please refer to the Testing Guide for information about setting up a test environment and running tests on core custom modules.