mirror of
https://github.com/humhub/humhub.git
synced 2025-01-18 06:38:14 +01:00
Administration documentation improvements
This commit is contained in:
Lucas Bartholemy
parent
80f0a4fe85
commit
00c56585de
@ -25,5 +25,4 @@ Administration Topics
|
||||
* [Authentication and LDAP](authentication.md)
|
||||
* [Search System](search.md)
|
||||
* [Translations](translations.md)
|
||||
* [Logging](logging.md)
|
||||
* [Troubleshooting and Help](troubleshooting.md)
|
||||
|
||||
@ -1,15 +1,28 @@
|
||||
Backup and Restore
|
||||
==================
|
||||
|
||||
|
||||
Backup HumHub Data
|
||||
------------------
|
||||
|
||||
TBD
|
||||
Whether you are upgrading your installation of HumHub using the updater module or the manual, you must make sure you have your own set of backup data, one you can rely on and to which you can get back on your own terms.
|
||||
|
||||
|
||||
|
||||
Restore HumHub from Backup
|
||||
---------------------------
|
||||
Create a Backup of HumHub Data
|
||||
------------------------------
|
||||
|
||||
TBD
|
||||
* Create a full backup of the HumHub database
|
||||
* Backup installation files
|
||||
- /protected/modules
|
||||
- /protected/config
|
||||
- /uploads
|
||||
- /themes/yourtheme (if you're running an own theme)
|
||||
|
||||
|
||||
Restore HumHub from Backup Data
|
||||
--------------------------------
|
||||
|
||||
* Restore and import backup database
|
||||
* Restore installation files
|
||||
- /protected/modules
|
||||
- /protected/config
|
||||
- /uploads
|
||||
- /themes/yourtheme (if you're running an own theme)
|
||||
* Rebuild the search index, see [Search chapter](search.md)
|
||||
@ -2,7 +2,7 @@ Installation
|
||||
============
|
||||
|
||||
> Note: It's also possible to install and build HumHub directly from our **Git Repository**.
|
||||
Please see [Developer Installation](../dev/git-installation.md) for more details.
|
||||
Please see [Developer Installation](../developer/git-installation.md) for more details.
|
||||
|
||||
|
||||
|
||||
@ -50,6 +50,6 @@ Web Installer
|
||||
|
||||
Open the installation guide in your browser (e.g. [http://localhost/humhub](http://localhost/humhub))
|
||||
|
||||
> Warning: Don't forget to proceed with the [Configuration](configuration.md) chapter after the installation.
|
||||
> Warning: Don't forget to proceed with the [Configuration](installation-configuration.md) chapter after the installation.
|
||||
|
||||
|
||||
|
||||
@ -5,13 +5,61 @@ Performance Tuning
|
||||
Caching
|
||||
-------
|
||||
|
||||
TBD
|
||||
HumHub supports different caching systems which can be configured at: `Administration -> Settings -> Advanced -> Caching`.
|
||||
|
||||
In addition to those listed caching systems, you can use any Yii2 compatible caching driver.
|
||||
|
||||
**[Configuration file](advanced-configuration.md) examples:**
|
||||
|
||||
Redis Cache Example:
|
||||
|
||||
```php
|
||||
[
|
||||
'components' => [
|
||||
'cache' => [
|
||||
'class' => 'yii\redis\Cache',
|
||||
'redis' => [
|
||||
'hostname' => 'localhost',
|
||||
'port' => 6379,
|
||||
'database' => 0,
|
||||
]
|
||||
],
|
||||
],
|
||||
]
|
||||
```
|
||||
|
||||
Memcached Configuration Example:
|
||||
|
||||
```php
|
||||
[
|
||||
'components' => [
|
||||
'cache' => [
|
||||
'class' => 'yii\caching\MemCache',
|
||||
'servers' => [
|
||||
[
|
||||
'host' => 'server1',
|
||||
'port' => 11211,
|
||||
'weight' => 60,
|
||||
],
|
||||
[
|
||||
'host' => 'server2',
|
||||
'port' => 11211,
|
||||
'weight' => 40,
|
||||
],
|
||||
],
|
||||
],
|
||||
],
|
||||
]
|
||||
```
|
||||
|
||||
|
||||
|
||||
Image Processing
|
||||
----------------
|
||||
|
||||
TBD
|
||||
We recommend using the `imagemagick` commandline tool for faster image processing (resizing, file format conversions).
|
||||
|
||||
You can activate imagemagick at: `Administration -> Settings -> Advanced -> Files` by entering the location of the `convert` command (e.g. /usr/bin/convert).
|
||||
|
||||
|
||||
Job Scheduling
|
||||
@ -26,17 +74,17 @@ X-Sendfile
|
||||
X-Sendfile is a feature that allows us to pass file download requests directly by the webserver.
|
||||
This improves the application performance.
|
||||
|
||||
### Installation
|
||||
**Installation**
|
||||
Administration -> Settings -> Files -> Enable X-Sendfile Support.
|
||||
|
||||
Apache Config Example
|
||||
Apache Config Example:
|
||||
|
||||
```
|
||||
XSendFile On
|
||||
XSendFilePath /path/to/humhub/uploads
|
||||
```
|
||||
|
||||
### More Information
|
||||
**More Information:**
|
||||
|
||||
- Apache: [X-Sendfile](http://tn123.org/mod_xsendfile)
|
||||
- Lighttpd v1.4: [X-LIGHTTPD-send-file](http://redmine.lighttpd.net/projects/lighttpd/wiki/X-LIGHTTPD-send-file)
|
||||
@ -44,6 +92,6 @@ XSendFilePath /path/to/humhub/uploads
|
||||
- Nginx: [X-Accel-Redirect](http://wiki.nginx.org/XSendfile)
|
||||
- Cherokee: [X-Sendfile and X-Accel-Redirect](http://www.cherokee-project.com/doc/other_goodies.html#x-sendfile)
|
||||
|
||||
Requires package ``libapache2-mod-xsendfile``
|
||||
Requires package `libapache2-mod-xsendfile`
|
||||
|
||||
|
||||
@ -1,11 +1,21 @@
|
||||
Requirements
|
||||
============
|
||||
|
||||
### General Requirements:
|
||||
* PHP 5.6+
|
||||
* MySQL
|
||||
> Note: All vital requirements will be also checked during the web installer.
|
||||
|
||||
Server Requirements
|
||||
-------------------
|
||||
|
||||
* Shell access (e.g. ssh) to server
|
||||
* Apache 2.x
|
||||
* PHP 5.6 or later
|
||||
* MySQL (5.1 or later) or MariaDB with InnoDB storage engine installed
|
||||
* A minimum 500 MB of free disk space
|
||||
* A minimum 64 MB of memory allocated to PHP
|
||||
* A minimum of 50 MB of database space
|
||||
|
||||
|
||||
Required PHP Extensions
|
||||
-----------------------
|
||||
* PHP CUrl Extension (w/ SSL Support) <http://de1.php.net/manual/en/curl.setup.php>
|
||||
* PHP Multibyte String Support <http://php.net/manual/en/mbstring.setup.php>
|
||||
* PHP PDO MySQL Extension (http://www.php.net/manual/en/ref.pdo-mysql.php)
|
||||
@ -14,39 +24,26 @@ Requirements
|
||||
* PHP INTL Extension (http://php.net/manual/en/intro.intl.php)
|
||||
* PHP FileInfo Extension (http://php.net/manual/en/fileinfo.installation.php)
|
||||
|
||||
### Optional:
|
||||
|
||||
Optional PHP Extensions
|
||||
-----------------------
|
||||
|
||||
* ImageMagick
|
||||
* PHP LDAP Support
|
||||
* PHP APC
|
||||
* PHP Memcached
|
||||
* Apache XSendfile
|
||||
|
||||
### Packages for Debian/Ubuntu users
|
||||
|
||||
#### For PHP 5.x
|
||||
|
||||
* imagemagick
|
||||
* php5-curl
|
||||
* php5-mysql
|
||||
* php5-gd
|
||||
* php5-cli
|
||||
* php5-intl
|
||||
* php5-ldap (optional)
|
||||
* php-apc (optional)
|
||||
* php5-memcached (optional)
|
||||
* libapache2-mod-xsendfile (optional)
|
||||
|
||||
#### For PHP 7.0 on Ubuntu
|
||||
|
||||
* imagemagick
|
||||
* php7.0-curl
|
||||
* php7.0-mbstring
|
||||
* php7.0-mysql
|
||||
* php7.0-gd
|
||||
* php7.0-cli
|
||||
* php7.0-intl
|
||||
* php7.0-ldap (optional)
|
||||
* php7.0-opcache (optional)
|
||||
* php-memcache (optional)
|
||||
* libapache2-mod-xsendfile (optional)
|
||||
Database
|
||||
--------
|
||||
The database user you tell HumHub to connect with must have the following privileges:
|
||||
|
||||
- SELECT
|
||||
- INSERT
|
||||
- DELETE
|
||||
- UPDATE
|
||||
- CREATE
|
||||
- ALTER
|
||||
- INDEX
|
||||
- DROP
|
||||
- REFERENCES
|
||||
|
||||
@ -1,8 +1,15 @@
|
||||
Search
|
||||
======
|
||||
Search System
|
||||
=============
|
||||
|
||||
**The built in search system is used for:**
|
||||
- Directory
|
||||
- People/Space Search
|
||||
- Content Search
|
||||
- User/Space Picker Widgets
|
||||
|
||||
|
||||
### Search Index Rebuilding
|
||||
Index Rebuilding
|
||||
----------------
|
||||
|
||||
If you need to rebuild the search index (e.g. after updating) you need to run following command:
|
||||
|
||||
@ -11,7 +18,23 @@ cd /path/to/humhub/protected
|
||||
php yii search/rebuild
|
||||
```
|
||||
|
||||
### Zend Lucence
|
||||
Zend Lucence Engine
|
||||
--------------------
|
||||
|
||||
By default HumHub is using a *Lucence* Index (Zend Lucence) to store search data.
|
||||
Folder: */protected/runtime/searchdb/*
|
||||
|
||||
Default database folder: `/protected/runtime/searchdb/`
|
||||
|
||||
You can modify the default search directory in the [configuration](advanced-configuration.md):
|
||||
|
||||
```php
|
||||
return [
|
||||
// ...
|
||||
'params' => [
|
||||
'search' => [
|
||||
'zendLucenceDataDir' => '/some/other/path',
|
||||
]
|
||||
]
|
||||
// ...
|
||||
];
|
||||
```
|
||||
@ -30,11 +30,18 @@ By default these folders are protected with a ".htaccess" file.
|
||||
Limit User Access
|
||||
-----------------
|
||||
|
||||
TBD
|
||||
If you're running a private social network, make sure the user registration is disabled or the approval system for new users is enabled.
|
||||
|
||||
- Disable user registration: `Administration -> Users -> Settings -> Anonymous users can register`
|
||||
- Enable user approvals: `Administration -> Users -> Settings -> Require group admin approval after registration`
|
||||
- Make sure guest access is disabled: `Administration -> Users -> Settings -> Allow limited access for non-authenticated users (guests)`
|
||||
|
||||
Keep up with the latest HumHub version
|
||||
---------------------------------------
|
||||
|
||||
TBD
|
||||
As admin you'll receive a notification when a new HumHub version is released. We recommend to always use the latest stable version.
|
||||
|
||||
We take security very seriously and continuously improving the security features of HumHub.
|
||||
|
||||
|
||||
|
||||
|
||||
@ -13,6 +13,7 @@ return [
|
||||
'allowedLanguages' => ['de', 'fr']
|
||||
]
|
||||
];
|
||||
```
|
||||
|
||||
Overwrite translation messages
|
||||
------------------------------
|
||||
|
||||
@ -1,5 +1,38 @@
|
||||
Troubleshooting and Help
|
||||
========================
|
||||
|
||||
TBD
|
||||
Support Community
|
||||
-----------------
|
||||
|
||||
There is also an active support community at: http://community.humhub.com
|
||||
|
||||
|
||||
Github - Bugtracker
|
||||
-------------------
|
||||
|
||||
**How to file a bug**
|
||||
- Go to our issue tracker on GitHub: https://github.com/humhub/humhub/issues
|
||||
- Search for existing issues using the search field at the top of the page
|
||||
- File a new issue including the info listed below
|
||||
- Thanks a ton for helping make Brackets higher quality!
|
||||
|
||||
**When filing a new bug, please include:**
|
||||
|
||||
- Descriptive title - use keywords so others can find your bug (avoiding duplicates)
|
||||
- Steps to trigger the problem that are specific, and repeatable
|
||||
- What happens when you follow the steps, and what you expected to happen instead.
|
||||
- Include the exact text of any error messages if applicable (or upload screenshots).
|
||||
- HumHub version (or if you're pulling directly from Git, your current commit SHA - use git rev-parse HEAD)
|
||||
- Did this work in a previous version? If so, also provide the version that it worked in.
|
||||
- OS/PHP/MySQL version
|
||||
- Modules? Confirm that you've tested with Debug > Reload Without Extensions first (see below).
|
||||
- Any errors logged in Debug > Show Developer Tools - Console view
|
||||
|
||||
|
||||
Direct Support (Enterprise Edition only)
|
||||
----------------------------------------
|
||||
|
||||
As Enterprise Edition user you can create direct support inquiries at:
|
||||
`Administration -> Enterprise Edition -> Support`.
|
||||
|
||||
If you have problems related to the installation, please contact us at: info@humhub.com
|
||||
|
||||
@ -1,6 +1,11 @@
|
||||
Automatic Updating
|
||||
==================
|
||||
|
||||
|
||||
> Warning: Please check before you run an update, that your installed modules and themes are compatible with the new version. If not, you can follow the migration guides.
|
||||
- [Theme Migration Guide](theming-migrate.md)
|
||||
- [Module Migration Guide](dev-migrate.md)
|
||||
|
||||
> NOTE: Backup your data before updating! See: [Backup Chapter](backup.md)
|
||||
|
||||
The automatic upgrade module enables an update of the HumHub installation in a few clicks and without technical knowledge.
|
||||
|
||||
@ -1,7 +1,7 @@
|
||||
Updating
|
||||
========
|
||||
|
||||
> Warning: Before you run an update please check, if your installed modules and themes are compatible with your target version. If not, you can follow the migration guides.
|
||||
> Warning: Please check before you run an update, that your installed modules and themes are compatible with the new version. If not, you can follow the migration guides.
|
||||
- [Theme Migration Guide](theming-migrate.md)
|
||||
- [Module Migration Guide](dev-migrate.md)
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user