Merge branch 'v1.2-dev' of https://github.com/humhub/humhub into v1.2-dev

protected/humhub/docs/guide/README.md

@@ -1,52 +1,25 @@
-HumHub Guide 
+Welcome 
-============
+=======
 
-Introduction
+Here you will find helpful information on how to create, maintain, and make the most of an social network built using the HumHub solution.
-------------
-* [About HumHub](intro-index.md)
-* [Licence](intro-licence.md)
-* [Bundled Software](intro-bundled_software.md)
 
-Getting Started
+All documentations located on docs.humhub.org refers to the latest version of HumHub. If you're using an older version, you can find the related documentation in the 
----------------
+folder /protected/humhub/docs.
 
-* [Requirements](admin-requirements.md)
+Documentations
-* [Installation](admin-installation.md)
+--------------
-* [Updating](admin-updating.md)
+- [Installation and Administration](admin/README.md)
+- [Theming](theme/README.md)
+- [Core and Module Development](developer/README.md)
 
-Administration
----------------------
-* [Advanced Configuration](admin-adv-config.md)
-* [Authentication](admin-authentication.md)
-* [Console](admin-adv-console.md)
-* [Search](admin-adv-search.md)
-* [XSendFile](admin-adv-xsendfile.md)
-* [Logging](admin-adv-logging.md)
 
-Development
+Appendix
----------------------
+--------
+- [About HumHub](about.md)
+- [Licences](licences.md)
+- [Bundled Software](bundled-software.md)
+
 
-* [Getting Started](dev-index.md)
-* [Update / Migration](dev-migrate.md)
-* [Content](dev-content.md)
-* [Permissions](dev-permissions.md)
-* [Notifications](dev-notifications.md)
-* [Activities](dev-activities.md)
-* [Streams](dev-stream.md)
-* [Events](dev-events.md)
-* [Widgets](dev-widgets.md)
-* [Internationalization](dev-i18n.md)
-* [Authentication](dev-authentication.md)
-* [Models / Database](dev-db.md)
-* [Search](dev-search.md)
-* [CronJobs](dev-cron.md)
-* [Settings and Configuration](dev-settings.md)
-* [Console Application](dev-console.md)
-* [Module Development](dev-module.md)
 
-Theming
--------
 
-* [Getting Started](theming-index.md)
-* [Update / Migrate](theming-migrate.md)
 

protected/humhub/docs/guide/admin-adv-config.md

@@ -1,71 +0,0 @@
-Advanced Configuration
-======================
-
-You can overwrite the default HumHub / Yii configuration in the folder `/protected/config`. 
-
-## File Overview
-
-- **common.php**  - Configuration used in Console & Web Application
-- **web.php** - Configuration used in Web Application only
-- **console.log** - Configuration used in Console Application only
-- **dynamic.php** - Dynamic generated configuration - do not edit manually!
-
-## Loading Order
-
-### Web Application
-
-1. humhub/config/common.php
-2. humhub/config/web.php
-3. config/dynamic.php
-4. **config/common.php**
-5. **config/web.php**
-
-
-### Console Application
-
-1. humhub/config/common.php
-2. humhub/config/console.php
-3. config/dynamic.php
-4. **config/common.php**
-5. **config/console.php**
-
-## Configurations
-
-### Language
-
-
-**Restrict Languages:**
-
-The allowed languages of your project can be configured within the **humhub/config/common.php** configuration. 
-It is possible to restrict the allowed languages of your HumHub installation by means of the following configuration:
-
-```php
-return [
-    'params' => [
-        'allowedLanguages' => ['de', 'fr']
-    ]
-];
-```
-
-**Overwrite Default Texts:**
-
-To overwrite the default text for a language, you have to define a new message file with the following path pattern:
-
-```
-config/messages/<language>/<Module_ID>.<messagefile>.php
-``` 
-
-To overwrite the post placeholder for the german language, for example, you have to create the following file:
-
-```
-config/messages/de/PostModule.widgets_views_postForm.php
-```
-
-with the content:
-
-```php
-<?php
-return array (
-  'What\'s on your mind?' => 'Wie geht es dir heute?',
-);
-```

protected/humhub/docs/guide/admin-adv-ldap.md

@@ -1,39 +0,0 @@
-LDAP
-=======
-
-Basic configuration
--------------------
-
-- Define server settings at: Administration -> Users -> Settings -> LDAP 
-- Attribute mapping: Administration -> Users -> Profile -> Select profile field -> LDAP Attribute
-
-
-User Mapping (Enterprise Edition)
----------------------------------
-
-The Enterprise Edition provides additional LDAP capabilities like automatic User to Space or User to Group mapping.
-
-**Space Mapping**
-As administrative user you can setup a ldap group dn at: Space -> Members -> LDAP.
-
-**Group Mapping**
-Administration -> Users -> Groups -> Edit -> LDAP Mapping
-
-
-Date fields
------------
-
-If you're using custom date formats in our ldap backend, you can specify different formats
-in the configuration file.
-
-```php
-    'params' => [
-        'ldap' => [
-            'dateFields' => [
-                'somedatefield' => 'Y.m.d'
-            ],
-        ],
-    ],
-```
-
-Note: Make sure to use lower case in the field.

protected/humhub/docs/guide/admin-installation.md

@@ -1,128 +0,0 @@
-Installation
-============
-
-## Preparation
-
-Create a MySQL Database, e.g.:
-
-```sql
-CREATE DATABASE `humhub` CHARACTER SET utf8 COLLATE utf8_general_ci;
-GRANT ALL ON `humhub`.* TO `humhub_dbuser`@localhost IDENTIFIED BY 'password_changeme';
-FLUSH PRIVILEGES;
-```
-
-> Note: Do not forget to change the `humhub_dbuser` and `password_changeme` placeholders!
-
-## Get HumHub
-
-### Via: Download Package
-
-The easiest way to get HumHub, is the direct download of the complete package under [http://www.humhub.org/downloads](http://www.humhub.org/downloads).
-This package already includes all external dependencies and doesn't require a composer update.
-After the download completed, just extract the package into the htdocs folder of your webserver.
-
-### Via: Git/Composer
-
-In order to be able to install a branch fetched by git, you'll have to run a composer update to download external dependencies.
-
- - Clone Git Repository:
-
-```
-git clone https://github.com/humhub/humhub.git
-```
-
- - Switch to stable branch (recommended):
-
-```
-git checkout stable
-```
-
- - Install composer ([https://getcomposer.org/doc/00-intro.md](https://getcomposer.org/doc/00-intro.md))
- - Navigate to your HumHub webroot and fetch dependencies:
-
-```
-php composer.phar global require "fxp/composer-asset-plugin:~1.1.1"
-php composer.phar update
-```
-
-> Note: The composer update may have to be executed again after an update of your local repository by a git pull. Read more about updating ([Update Guide](admin-updating.html#gitcomposer-based-installations))
-
-## Setting up
-
-### File Modes / Permissions
-
-Make the following directories/files writable by the webserver
-- /assets
-- /protected/config/
-- /protected/modules
-- /protected/runtime
-- /uploads/*
-
-Make the following files executable:
- - /protected/yii
- - /protected/yii.bat
-
-**Make sure the following directories are not accessible through the webserver!**
-
-(These folders are protected by default with ".htaccess")
-
-- protected
-- uploads/file
-
-### Start Installer
-
-Open the installation guide in your browser (e.g. [http://localhost/humhub](http://localhost/humhub))
-
-
-## Fine Tuning
-
-### E-Mail Configuration
-
-Depending on your environment you are using, you may want to specify a local or remote SMTP Server.
-You can change the mail-server settings under `Administration -> Mailing -> Server Settings`.
-
-By default the PHP Mail Transport is used. <http://php.net/manual/en/mail.setup.php>
-
-
-### Enable Url Rewriting (Optional)
-
-Rename **.htaccess.dist ** to **.htaccess**
-Modify the local configuration (protected/config/common.php):
-
-```php
-<?php
-
-return [
-    'components' => [
-        'urlManager' => [
-            'showScriptName' => false,
-            'enablePrettyUrl' => true,
-        ],
-    ]
-];
-
-```  
-
-### Enable Cron Jobs
-
- - Daily cron command: `> yii cron/daily`
- - Hourly cron command: `> yii cron/hourly`
-
-Example Tab:
-
-```
-30 * * * * /path/to/humhub/protected/yii cron/hourly >/dev/null 2>&1
-00 18 * * * /path/to/humhub/protected/yii cron/daily >/dev/null 2>&1
-```
-
-### Disable Errors / Debugging
-
- - Modify *index.php* in your humhub root directory
-     
-```php
-// comment out the following two lines when deployed to production
-// defined('YII_DEBUG') or define('YII_DEBUG', true);
-// defined('YII_ENV') or define('YII_ENV', 'dev');
-```
-
- - Delete *index-test.php* in your humhub root directory if exists

protected/humhub/docs/guide/admin/README.md

@@ -0,0 +1,29 @@
+Installation & Administration
+=============================
+
+Getting Started
+---------------
+* [Requirements](requirements.md)
+* [Installation](installation.md)
+* [Configuration](installation-configuration.md)
+
+Updating HumHub
+---------------
+
+New versions come every few months, sometimes even weeks apart. Some are major, most are minor, but they all bring a slew of innovations, improvements and bug fixes. It is therefore highly advised to keep up with the latest version.
+
+* [Automatic update](updating-automatic.md)
+* [Manual update](updating.md)
+
+
+Administration Topics
+---------------------
+* [Security](security.md)
+* [Backup HumHub](backup.md)
+* [Performance Tuning](performance.md)
+* [Custom Configurations](advanced-configuration.md)
+* [Authentication and LDAP](authentication.md)
+* [Search System](search.md)
+* [Translations](translations.md)
+* [Logging](logging.md)
+* [Troubleshooting and Help](troubleshooting.md)

protected/humhub/docs/guide/admin/advanced-configuration.md

@@ -0,0 +1,35 @@
+Advanced Configuration
+======================
+
+You can overwrite the default HumHub / Yii configuration in the folder `/protected/config`. 
+
+File Overview
+-------------
+
+- **common.php**  - Configuration used in Console & Web Application
+- **web.php** - Configuration used in Web Application only
+- **console.log** - Configuration used in Console Application only
+- **dynamic.php** - Dynamic generated configuration - do not edit manually!
+
+
+
+Configuration file loading order
+---------------------------------
+
+**Web Application**
+
+1. humhub/config/common.php
+2. humhub/config/web.php
+3. config/dynamic.php
+4. **config/common.php**
+5. **config/web.php**
+
+
+**Console Application**
+
+1. humhub/config/common.php
+2. humhub/config/console.php
+3. config/dynamic.php
+4. **config/common.php**
+5. **config/console.php**
+

protected/humhub/docs/guide/admin/authentication.md

@@ -4,8 +4,27 @@ Authentication
 LDAP
 ----
 
-You can enable authentication against LDAP (e.g. against Active Directory or OpenLDAP) via
+You can enable authentication against LDAP (e.g. against Active Directory or OpenLDAP) at: `Administration -> Users -> Settings-> LDAP`.
-`Administration -> Settings -> User -> LDAP`.
+The profile field attribute mapping can be defined at `Administration -> Users -> Profile -> Select profile field -> LDAP Attribute`.
+
+### Date field synchronisation
+
+If you're using custom date formats in our ldap backend, you can specify different formats
+in the [configuration file](advanced-configuration.md).
+
+```php
+    'params' => [
+        'ldap' => [
+            'dateFields' => [
+                'somedatefield' => 'Y.m.d'
+            ],
+        ],
+    ],
+```
+
+Note: Make sure to use lower case in the field.
+
+
 
 Facebook
 --------

protected/humhub/docs/guide/admin/backup.md

@@ -0,0 +1,15 @@
+Backup and Restore
+==================
+
+
+Backup HumHub Data
+------------------
+
+TBD
+
+
+
+Restore HumHub from Backup
+---------------------------
+
+TBD

protected/humhub/docs/guide/admin/installation-configuration.md

@@ -0,0 +1,55 @@
+Configuration
+=============
+
+> NOTE: Before going to production, see also the [Security Chapter](security.md)
+
+
+E-Mails
+-------
+
+Depending on your environment you are using, you may want to specify a local or remote SMTP Server.
+You can change the mail-server settings under `Administration -> Mailing -> Server Settings`.
+
+By default the PHP Mail Transport is used. <http://php.net/manual/en/mail.setup.php>
+
+
+
+CronJobs
+--------
+
+ - Daily cron command: `> yii cron/daily`
+ - Hourly cron command: `> yii cron/hourly`
+
+Example Tab:
+
+```
+30 * * * * /path/to/humhub/protected/yii cron/hourly >/dev/null 2>&1
+00 18 * * * /path/to/humhub/protected/yii cron/daily >/dev/null 2>&1
+```
+
+
+Url Rewriting (Optional)
+------------------------
+
+Rename **.htaccess.dist ** to **.htaccess**
+Modify the local configuration (protected/config/common.php):
+
+```php
+<?php
+
+return [
+    'components' => [
+        'urlManager' => [
+            'showScriptName' => false,
+            'enablePrettyUrl' => true,
+        ],
+    ]
+];
+
+```  
+
+
+Job Scheduling
+--------------
+
+TBD

protected/humhub/docs/guide/admin/installation.md

@@ -0,0 +1,55 @@
+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.
+
+
+
+Database
+--------
+
+Create a MySQL Database, e.g.:
+
+```sql
+CREATE DATABASE `humhub` CHARACTER SET utf8 COLLATE utf8_general_ci;
+GRANT ALL ON `humhub`.* TO `humhub_dbuser`@localhost IDENTIFIED BY 'password_changeme';
+FLUSH PRIVILEGES;
+```
+
+> Note: Do not forget to change the `humhub_dbuser` and `password_changeme` placeholders!
+
+> Warning: Make sure to use the **utf8_general_ci** database collation!
+
+
+Download HumHub Core Files
+---------------------------
+
+The easiest way to get HumHub, is the direct download of the complete package under [http://www.humhub.org/downloads](http://www.humhub.org/downloads).
+
+After the download completed, just extract the package into the htdocs folder of your webserver.
+
+
+File Permissions
+----------------------------
+
+Make the following directories/files writable by the webserver
+- /assets
+- /protected/config/
+- /protected/modules
+- /protected/runtime
+- /uploads/*
+
+Make the following files executable:
+ - /protected/yii
+ - /protected/yii.bat
+
+
+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.
+
+

protected/humhub/docs/guide/admin/performance.md

@@ -1,25 +1,42 @@
+Performance Tuning
+==================
+
+
+Caching
+-------
+
+TBD
+
+
+Image Processing
+----------------
+
+TBD
+
+
+Job Scheduling
+--------------
+
+TBD
+
+
 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
-------------------------
 
 ```        
-        XSendFile On
+XSendFile On
-        XSendFilePath /path/to/humhub/uploads
+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)
@@ -27,10 +44,6 @@ More Information
 - 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)
 
-
-
-Debian / Ubuntu
----------------
 Requires package ``libapache2-mod-xsendfile``
 
- 
+ 

protected/humhub/docs/guide/admin/security.md

@@ -0,0 +1,40 @@
+Security
+========
+
+Disable Errors / Debugging
+--------------------------
+
+ - Modify *index.php* in your humhub root directory
+     
+```php
+[...]
+// comment out the following two lines when deployed to production
+// defined('YII_DEBUG') or define('YII_DEBUG', true);
+// defined('YII_ENV') or define('YII_ENV', 'dev');
+[...]
+```
+
+ - Delete *index-test.php* in your humhub root directory if exists
+
+
+Protected Directories
+---------------------
+
+Make sure following directories are not accessible by web:
+- protected
+- uploads/file
+
+By default these folders are protected with a ".htaccess" file.
+
+
+Limit User Access
+-----------------
+
+TBD
+
+Keep up with the latest HumHub version
+---------------------------------------
+
+TBD
+
+

protected/humhub/docs/guide/admin/translations.md

@@ -0,0 +1,40 @@
+Translations
+============
+
+Limit available languages
+-------------------------
+
+The allowed languages of your project can be configured within the **humhub/config/common.php** configuration. 
+It is possible to restrict the allowed languages of your HumHub installation by means of the following configuration:
+
+```php
+return [
+    'params' => [
+        'allowedLanguages' => ['de', 'fr']
+    ]
+];
+
+Overwrite translation messages
+------------------------------
+
+To overwrite the default text for a language, you have to define a new message file with the following path pattern:
+
+```
+config/messages/<language>/<Module_ID>.<messagefile>.php
+``` 
+
+To overwrite the post placeholder for the german language, for example, you have to create the following file:
+
+```
+config/messages/de/PostModule.widgets_views_postForm.php
+```
+
+with the content:
+
+```php
+<?php
+return array (
+  'What\'s on your mind?' => 'Wie geht es dir heute?',
+);
+```
+

protected/humhub/docs/guide/admin/troubleshooting.md

@@ -0,0 +1,5 @@
+Troubleshooting and Help
+========================
+
+TBD
+

protected/humhub/docs/guide/admin/updating-automatic.md

@@ -0,0 +1,23 @@
+Automatic Updating
+==================
+
+> 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.
+
+
+Updater Module Installation
+---------------------------
+
+1. Administration -> Modules -> Browse online
+2. Choose **HumHub Updater** and click 'Install'
+3. Switch to 'Installed' Tab
+4. Choose **HumHub Updater** and click 'Enable'
+5. Select in left navigation: Administration -> Update HumHub
+6. Follow the updater steps
+
+
+Troubleshooting
+---------------
+
+TBD

protected/humhub/docs/guide/admin/updating.md

@@ -8,23 +8,7 @@ Updating
 > NOTE: Only use this guide if you want to update from HumHub 0.20 or higher!
 > If you want to update from an older version (e.g. 0.11.2 or lower) to HumHub 0.20+, you have to use this guide: **[Upgrade to 0.20 and above](admin-updating-020.md "Guide: Upgrade to 0.20 and above")**
 
-> NOTE: Backup your data:
+> NOTE: Backup your data before updating! See: [Backup Chapter](backup.md)
-- Backup the whole HumHub installation folder from your webroot
-- Make a complete MySQL Backup from your HumHub database
-
-
-## Download Package installations
-
-### Option 1: Updater Module
-
-1. Administration -> Modules -> Browse online
-2. Choose **HumHub Updater** and click 'Install'
-3. Switch to 'Installed' Tab
-4. Choose **HumHub Updater** and click 'Enable'
-5. Select in left navigation: Administration -> Update HumHub
-6. Follow the updater steps
-
-### Option 2: Manual Update
 
 1. Delete your current HumHub installation (Don't forget to make a backup as mentioned above, you will need these files later!)
 2. Download the latest HumHub package from [http://www.humhub.org/downloads](http://www.humhub.org/downloads) and extract the package to your webroot
@@ -43,25 +27,3 @@ php yii migrate/up --includeModuleMigrations=1
 
 
 
-
-## Git/Composer based installations
-
-- Pull latest Git version
-
-```
-git pull
-```
-- Update composer dependencies
-
-```
-composer update
-```
-
-- Run database migration tool
-
-```
-cd protected
-php yii migrate/up --includeModuleMigrations=1
-```
-
-

protected/humhub/docs/guide/developer/README.md

@@ -0,0 +1,23 @@
+Developement Guide
+==================
+
+Development
+---------------------
+
+* [Getting Started](dev-index.md)
+* [Update / Migration](dev-migrate.md)
+* [Content](dev-content.md)
+* [Permissions](dev-permissions.md)
+* [Notifications](dev-notifications.md)
+* [Activities](dev-activities.md)
+* [Streams](dev-stream.md)
+* [Events](dev-events.md)
+* [Widgets](dev-widgets.md)
+* [Internationalization](dev-i18n.md)
+* [Authentication](dev-authentication.md)
+* [Models / Database](dev-db.md)
+* [Search](dev-search.md)
+* [CronJobs](dev-cron.md)
+* [Settings and Configuration](dev-settings.md)
+* [Console Application](dev-console.md)
+* [Module Development](dev-module.md)

protected/humhub/docs/guide/developer/git-installation.md

@@ -0,0 +1,74 @@
+Installation (Developers)
+=========================
+
+> Warning: This installation method allows you to easily fetch the latest version from our 
+
+Preparation
+-----------
+
+Create a MySQL Database, e.g.:
+
+```sql
+CREATE DATABASE `humhub` CHARACTER SET utf8 COLLATE utf8_general_ci;
+GRANT ALL ON `humhub`.* TO `humhub_dbuser`@localhost IDENTIFIED BY 'password_changeme';
+FLUSH PRIVILEGES;
+```
+
+> Note: Do not forget to change the `humhub_dbuser` and `password_changeme` placeholders!
+
+
+Get HumHub
+----------
+
+In order to be able to install a branch fetched by git, you'll have to run a composer update to download external dependencies.
+
+ - Clone Git Repository:
+
+```
+git clone https://github.com/humhub/humhub.git
+```
+
+ - Switch to stable branch (recommended):
+
+```
+git checkout stable
+```
+
+ - Install composer ([https://getcomposer.org/doc/00-intro.md](https://getcomposer.org/doc/00-intro.md))
+ - Navigate to your HumHub webroot and fetch dependencies:
+
+```
+php composer.phar global require "fxp/composer-asset-plugin:~1.1.1"
+php composer.phar update
+```
+
+> Note: The composer update may have to be executed again after an update of your local repository by a git pull. Read more about updating ([Update Guide](admin-updating.html#gitcomposer-based-installations))
+
+
+
+File Settings & Permissions
+---------------------------
+
+
+Make the following directories/files writable by the webserver
+- /assets
+- /protected/config/
+- /protected/modules
+- /protected/runtime
+- /uploads/*
+
+Make the following files executable:
+ - /protected/yii
+ - /protected/yii.bat
+
+**Make sure the following directories are not accessible through the webserver!**
+
+
+Start Web Installer
+---------------
+
+Open the installation guide in your browser (e.g. [http://localhost/humhub](http://localhost/humhub))
+
+
+
+

protected/humhub/docs/guide/special-translations.md

@@ -1,4 +0,0 @@
-Translations
-============
-
-TBD

protected/humhub/docs/guide/theme/README.md

@@ -0,0 +1,11 @@
+Theming
+=======
+
+Getting started
+---------------
+* [Getting Started](theming-index.md)
+
+
+Migrate to newer version
+------------------------
+* [Update / Migrate](theming-migrate.md)