From 6dfb1c00128d72fca1fdefc63e68e7db12f9f25b Mon Sep 17 00:00:00 2001 From: Odinaka Elias Obioha <149073751+OdinakaDico@users.noreply.github.com> Date: Wed, 3 Jun 2026 18:16:22 +0200 Subject: [PATCH 1/2] docs: clarify Apache document root for installation --- docs/admin/installation.md | 216 +++++++++++++++++++++++++++++++++++++ 1 file changed, 216 insertions(+) diff --git a/docs/admin/installation.md b/docs/admin/installation.md index bc217ae..e999664 100644 --- a/docs/admin/installation.md +++ b/docs/admin/installation.md @@ -84,6 +84,222 @@ Instead of the `queue/run` Cron Job you can also setup permanent worker processe ::: +## Configuration + +The following configuration settings can be made directly in HumHub via the browser. + +### E-Mails + +HumHub sends emails to the users e.g. during the registration, password recovery, notifications or for daily summaries. + +A valid transport and a sender e-mail address must be provided for this purpose. This can be configured in the web interface under ``Administration > Settings > Advanced > E-Mail`. + +:::note +You should use a `noreply` sender e-mail address since replying by mail is currently not supported. +::: + +If you installed a local SMTP server e.g. [Postfix](server-setup.md#postfix), you can use ``PHP`` as ``Mail Transport Type`` option. + +You can use external SMTP services like SendGrid, Postmark, Amazon SES, Mailgun or any other SMTP server with the ``SMTP`` as ``Mail Transport Type`` option. + +## Pretty URLs + +By default, the HumHub URL includes a index.php file part and looks like https://example.com/index.php?r=dashboard%2Fdashboard. +Using the Pretty URL or URL Rewriting feature, shorter and more meaningful URLs can be created such as https://example.com/dashboard. + +To enable this feature, both the HumHub configuration and, possibly, the WebServer configuration must be modified. + +Modify the HumHub [Configuration File](advanced-configuration.md) file `protected/config/common.php` and add following block: + +```php + 'components' => [ + 'urlManager' => [ + 'showScriptName' => false, + 'enablePrettyUrl' => true, + ], + ] +``` + +Full example of the configuration file: ``/protected/config/common.php`` + +```php + [ + 'urlManager' => [ + 'showScriptName' => false, + 'enablePrettyUrl' => true, + ], + ] +]; +``` + +### Apache + +:::warning +For the packaged HumHub installation, point your web server document root to the HumHub root directory that contains `index.php`. + +Do not use a generic Yii-style `/web` document root unless that directory exists in your actual HumHub package. +::: + +To enable URL Rewriting in Apache 2.4 based installations it is usually sufficient to copy the supplied file ``.htaccess.dist`` in the root directory of the HumHub installation to ``.htaccess``. + +```bash +cd /var/www/humhub +cp .htaccess.dist .htaccess +``` + +Sometimes it is necessary to enable support for ``.htaccess`` files in the [Apache VirtualHost](server-setup.md#apache) via the ``AllowOverride all`` directive. + + +Example VirtualHost configuration: + +``` + + + # ... + + + Options -Indexes -FollowSymLinks + AllowOverride All + + + # ... + + +``` + +### NGINX + +The [virtual server](server-setup.md#nginx) configuration for NGINX is already prepared for Pretty URLs and there are no further changes required. + +## Enable production mode + +By default, HumHub is shipped in debug mode. After a successful installation, it automatically switches to production mode. + +You can see the current mode at ``Administration > Information``. + + +## Verify + +- **Cronjobs** + + You can find the last execution and number of open background jobs at: ``Administration > Information > Background jobs`` + +- **Error log** + + Check the log for error messages and warnings. These can be viewed directly in Humhub under ``Administration > Information > Logging``. + +- **Protected folders** + + Please make sure that the following directory is **not** publicly accessible via the web server. + + - /protected + - /uploads/file + - /themes/*/views + + The file `/protected/config/dynamic.php` contains the database credentials and should only be readable by the HumHub user (e.g. ``www-data``). + +- **Production Mode** + + Make sure that no warning about the ``Debug mode`` appears under ``Administration > Information > About HumHub``. + + ## Staging/Test Environment + +:::tip + You can find a guide to setup an additional staging environment in our [Community Wiki](https://community.humhub.com/s/installation-and-setup/wiki/page/view?title=Staging+Environment). +::: +--- +id: installation +title: HumHub Setup +--- + +:::tip +Check out our [Community Wiki](https://community.humhub.com/s/installation-and-setup/wiki/overview/list-categories) for many more guides and tips on installing and running HumHub! +::: + +## Download and extract + + +This guide describes the installation of the packaged version of HumHub. The packaged version of HumHub includes a +production ready version of HumHub with all required third party dependencies and production assets. +Make sure your server meets the [System Requirements](requirements.md) before you install HumHub. + +If you intend to setup a development environment for HumHub, follow the [Development Environment](https://github.com/humhub/humhub/blob/develop/docs/develop/intro-environment.md) +guide instead. + +The packaged version of HumHub is available at [https://download.humhub.com](https://download.humhub.com). +After the download, just place the package into the `htdocs` folder of your web server. + +Example + +``` +cd /tmp +wget https://download.humhub.com/downloads/install/humhub-.tar.gz +tar xvfz humhub-.tar.gz +mv /tmp/humhub- /var/www/humhub +``` +> Please replace `` with the desired HumHub version e.g. `1.13.0`. + +## File permissions + +At least following directories and files needs to be **writable** by the PHP process: + +- `/assets` +- `/protected/config/` +- `/protected/modules` +- `/protected/runtime` +- `/uploads/*` + +If you want to use the HumHub automatic updater, all files must be writable. + +``` +chown -R www-data:www-data /var/www/humhub +``` + +## Start installer + +Open your browser and open the URL e.g. [https://temp.humhub.dev](https://temp.humhub.dev). + +The HumHub installer will now start and will guide you through the initial setup process. + +For the first two steps [System Check](server-setup.md) and [Database Configuration](server-setup.md#create-database-schema) there is a detailed introduction in the [Server Setup](server-setup.md) document. + + +## CronJobs + +In the section below, only the most common method (also based on the installation structure of [Server Setup](server-setup.md)) is described. + +On the page [Cron Jobs](cron-jobs.md) we will go into this topic in more detail. + +** Cron job setup steps: ** + +Open the crontab of HumHub/PHP process user e.g. ``www-data``. + +``` +crontab -e -u www-data +``` + +Add following line to the crontab: + +``` +* * * * * /usr/bin/php /var/www/humhub/protected/yii queue/run >/dev/null 2>&1 +* * * * * /usr/bin/php /var/www/humhub/protected/yii cron/run >/dev/null 2>&1 +``` + +Make sure to replace ``/var/www/humhub`` with the path of your HumHub installation. + + +:::tip +Instead of the `queue/run` Cron Job you can also setup permanent worker processes. With these, background tasks have a shorter delay and a better performance. More information can be found in the [Community Wiki](https://community.humhub.com/s/installation-and-setup/wiki/page/view?title=Queue+Worker). +::: + + ## Configuration The following configuration settings can be made directly in HumHub via the browser. From 47afa17de8580b6e229a5fdd0ab8381e81cedd0f Mon Sep 17 00:00:00 2001 From: Odinaka Elias Obioha <149073751+OdinakaDico@users.noreply.github.com> Date: Wed, 3 Jun 2026 18:27:05 +0200 Subject: [PATCH 2/2] docs: repair installation page edit --- docs/admin/installation.md | 210 ------------------------------------- 1 file changed, 210 deletions(-) diff --git a/docs/admin/installation.md b/docs/admin/installation.md index e999664..7afa0ee 100644 --- a/docs/admin/installation.md +++ b/docs/admin/installation.md @@ -185,216 +185,6 @@ By default, HumHub is shipped in debug mode. After a successful installation, it You can see the current mode at ``Administration > Information``. -## Verify - -- **Cronjobs** - - You can find the last execution and number of open background jobs at: ``Administration > Information > Background jobs`` - -- **Error log** - - Check the log for error messages and warnings. These can be viewed directly in Humhub under ``Administration > Information > Logging``. - -- **Protected folders** - - Please make sure that the following directory is **not** publicly accessible via the web server. - - - /protected - - /uploads/file - - /themes/*/views - - The file `/protected/config/dynamic.php` contains the database credentials and should only be readable by the HumHub user (e.g. ``www-data``). - -- **Production Mode** - - Make sure that no warning about the ``Debug mode`` appears under ``Administration > Information > About HumHub``. - - ## Staging/Test Environment - -:::tip - You can find a guide to setup an additional staging environment in our [Community Wiki](https://community.humhub.com/s/installation-and-setup/wiki/page/view?title=Staging+Environment). -::: ---- -id: installation -title: HumHub Setup ---- - -:::tip -Check out our [Community Wiki](https://community.humhub.com/s/installation-and-setup/wiki/overview/list-categories) for many more guides and tips on installing and running HumHub! -::: - -## Download and extract - - -This guide describes the installation of the packaged version of HumHub. The packaged version of HumHub includes a -production ready version of HumHub with all required third party dependencies and production assets. -Make sure your server meets the [System Requirements](requirements.md) before you install HumHub. - -If you intend to setup a development environment for HumHub, follow the [Development Environment](https://github.com/humhub/humhub/blob/develop/docs/develop/intro-environment.md) -guide instead. - -The packaged version of HumHub is available at [https://download.humhub.com](https://download.humhub.com). -After the download, just place the package into the `htdocs` folder of your web server. - -Example - -``` -cd /tmp -wget https://download.humhub.com/downloads/install/humhub-.tar.gz -tar xvfz humhub-.tar.gz -mv /tmp/humhub- /var/www/humhub -``` -> Please replace `` with the desired HumHub version e.g. `1.13.0`. - -## File permissions - -At least following directories and files needs to be **writable** by the PHP process: - -- `/assets` -- `/protected/config/` -- `/protected/modules` -- `/protected/runtime` -- `/uploads/*` - -If you want to use the HumHub automatic updater, all files must be writable. - -``` -chown -R www-data:www-data /var/www/humhub -``` - -## Start installer - -Open your browser and open the URL e.g. [https://temp.humhub.dev](https://temp.humhub.dev). - -The HumHub installer will now start and will guide you through the initial setup process. - -For the first two steps [System Check](server-setup.md) and [Database Configuration](server-setup.md#create-database-schema) there is a detailed introduction in the [Server Setup](server-setup.md) document. - - -## CronJobs - -In the section below, only the most common method (also based on the installation structure of [Server Setup](server-setup.md)) is described. - -On the page [Cron Jobs](cron-jobs.md) we will go into this topic in more detail. - -** Cron job setup steps: ** - -Open the crontab of HumHub/PHP process user e.g. ``www-data``. - -``` -crontab -e -u www-data -``` - -Add following line to the crontab: - -``` -* * * * * /usr/bin/php /var/www/humhub/protected/yii queue/run >/dev/null 2>&1 -* * * * * /usr/bin/php /var/www/humhub/protected/yii cron/run >/dev/null 2>&1 -``` - -Make sure to replace ``/var/www/humhub`` with the path of your HumHub installation. - - -:::tip -Instead of the `queue/run` Cron Job you can also setup permanent worker processes. With these, background tasks have a shorter delay and a better performance. More information can be found in the [Community Wiki](https://community.humhub.com/s/installation-and-setup/wiki/page/view?title=Queue+Worker). -::: - - -## Configuration - -The following configuration settings can be made directly in HumHub via the browser. - -### E-Mails - -HumHub sends emails to the users e.g. during the registration, password recovery, notifications or for daily summaries. - -A valid transport and a sender e-mail address must be provided for this purpose. This can be configured in the web interface under ``Administration > Settings > Advanced > E-Mail`. - -:::note -You should use a `noreply` sender e-mail address since replying by mail is currently not supported. -::: - -If you installed a local SMTP server e.g. [Postfix](server-setup.md#postfix), you can use ``PHP`` as ``Mail Transport Type`` option. - -You can use external SMTP services like SendGrid, Postmark, Amazon SES, Mailgun or any other SMTP server with the ``SMTP`` as ``Mail Transport Type`` option. - -## Pretty URLs - -By default, the HumHub URL includes a index.php file part and looks like https://example.com/index.php?r=dashboard%2Fdashboard. -Using the Pretty URL or URL Rewriting feature, shorter and more meaningful URLs can be created such as https://example.com/dashboard. - -To enable this feature, both the HumHub configuration and, possibly, the WebServer configuration must be modified. - -Modify the HumHub [Configuration File](advanced-configuration.md) file `protected/config/common.php` and add following block: - -```php - 'components' => [ - 'urlManager' => [ - 'showScriptName' => false, - 'enablePrettyUrl' => true, - ], - ] -``` - -Full example of the configuration file: ``/protected/config/common.php`` - -```php - [ - 'urlManager' => [ - 'showScriptName' => false, - 'enablePrettyUrl' => true, - ], - ] -]; -``` - -### Apache - -To enable URL Rewriting in Apache 2.4 based installations it is usually sufficient to copy the supplied file ``.htaccess.dist`` in the root directory of the HumHub installation to ``.htaccess``. - -```bash -cd /var/www/humhub -cp .htaccess.dist .htaccess -``` - -Sometimes it is necessary to enable support for ``.htaccess`` files in the [Apache VirtualHost](server-setup.md#apache) via the ``AllowOverride all`` directive. - - -Example VirtualHost configuration: - -``` - - - # ... - - - Options -Indexes -FollowSymLinks - AllowOverride All - - - # ... - - -``` - -### NGINX - -The [virtual server](server-setup.md#nginx) configuration for NGINX is already prepared for Pretty URLs and there are no further changes required. - -## Enable production mode - -By default, HumHub is shipped in debug mode. After a successful installation, it automatically switches to production mode. - -You can see the current mode at ``Administration > Information``. - - ## Verify - **Cronjobs**