initial import from dokuwiki

Author: kevinpapst

bigace/admin_themes.md

@@ -0,0 +1,11 @@
+# Admin Themes
+
+Admin Themes customize the Look and Feel of the Administration the way you like it.
+It is possible to change Images, Stylesheet and even the Templates.
+
+
+*  Here is a [HOWTO for creating own Administration Themes](bigace/developer/admintheme).
+
+*  Here is a [list of all available Administration Themes](bigace/extensions/admintheme).
+
+

bigace/administration.md

@@ -0,0 +1,41 @@
+# Admin Handbook
+
+Please choose any article of interest.
+
+# User
+
+ 1.  Configuration of [available User attributes](bigace/administration/userattributes)
+
+# Languages
+
+ 1.  Creating new [Languages](bigace/administration/languages)
+ 2.  Migrating to [UTF8](bigace/administration/utf8)
+
+# Updates
+
+ 1.  Creating a new [Update/Extension](bigace/update)
+ 2.  Available [Extensions](bigace/extensions)
+ 3.  Administration of [Updates](bigace/manual/updates)
+
+# Search
+
+ 1.  Integration of [Search](bigace/administration/search) into your Website design
+
+# Editors
+
+ 1.  Configuration and updating of [FCKeditor](bigace/administration/fckeditor)
+
+# Security
+
+ 1.  [.htaccess Security](bigace/administration/htaccess) of your files
+ 2.  [Password salting](bigace/administration/salting)
+ 3.  Using [SSL](bigace/administration/ssl) for authentication and administration
+
+# Mixed up
+
+ 1.  The most important [configuration files](bigace/administration/configfiles) at a glance
+ 2.  BIGACE [URL Rewriting](bigace/administration/urlrewriting) features
+ 3.  [Database tuning](bigace/administration/databasetuning) can increase the speed of item calls
+
+
+

bigace/administration/bigace3setup.md

@@ -0,0 +1,94 @@
+# Bigace 3 - a secure Apache setup
+
+The best way to install Bigace 3 is by installing it with the Apaches DocumentRoot pointing to the public/ folder.
+
+This describes the config files and the required settings for a proper and secure setup.
+
+We use www.example.com as domain and /var/www/bigace/ as home directory of this example installation.
+
+## Apache VHost
+
+First the config file for your Apache Virtual-Host in the most simpe way:
+
+	:::ini
+	`<VirtualHost *:80>`
+	    ServerAdmin [email protected]
+	    ServerName www.example.com
+	    DocumentRoot /var/www/bigace/public/
+	`</VirtualHost>`
+
+
+Or a bit more complex and improved setup:
+
+
+	:::ini
+	`<VirtualHost *:80>`
+	    ServerAdmin [email protected]
+	    ServerName www.example.com
+	    ServerSignature Off
+	
+	    DocumentRoot /var/www/bigace/public/
+	    php_admin_value open_basedir /var/www/bigace:/tmp/:/usr/share/php/
+	    php_admin_value memory_limit 64M
+	
+	    RewriteEngine On
+	    RewriteCond %{HTTP_HOST} !^www.example.com$ [NC]
+	    RewriteRule (.*) http://www.example.com$1 [R=301,L]
+	`</VirtualHost>`
+
+
+## Apache Rewrite
+
+The file /public/.htaccess needs these entries:
+
+	:::ini
+	RewriteEngine On
+	RewriteCond %{REQUEST_FILENAME} -s [OR]
+	RewriteCond %{REQUEST_FILENAME} -l [OR]
+	RewriteCond %{REQUEST_FILENAME} -d
+	RewriteRule ^.*$ - [NC,L]
+	RewriteRule ^.*$ index.php [NC,L]
+
+
+## Bigace configuration
+
+Check that /application/bigace/configs/bigace.php contains the 'rewrite' setting 'true' ...
+
+	:::php
+	return array (
+	  ...
+	  'rewrite' => true
+	);
+
+
+... and your Community setting in /application/bigace/configs/consumer.ini is correct:
+
+	:::ini
+	[www.example.com]
+	id = 1
+
+
+
+## Error search
+
+If you experience errors, try to add the following line to /public/.htaccess
+
+	:::ini
+	SetEnv APPLICATION_ENV development
+
+
+... that it looks like this:
+
+	:::ini
+	SetEnv APPLICATION_ENV development
+	
+	RewriteEngine On
+	RewriteCond %{REQUEST_FILENAME} -s [OR]
+	RewriteCond %{REQUEST_FILENAME} -l [OR]
+	RewriteCond %{REQUEST_FILENAME} -d
+	RewriteRule ^.*$ - [NC,L]
+	RewriteRule ^.*$ index.php [NC,L]
+
+
+Now Bigace error pages will display more information.
+

bigace/administration/bigaceconfig.md

@@ -0,0 +1,33 @@
+# Bigace configuration file
+
+The main configuration file for Bigace that configures the following server settings:
+
+*  Database connection
+
+*  SSL Support
+
+*  URL Rewriting
+
+is located at ''application/bigace/config/bigace.php''.
+
+If you accidentally deleted it, you can recreate by pasting the following code inside the file and change the settings to your server environment:
+
+	:::php
+	<?php
+	return array (
+	  'database' => 
+	  array (
+	    'type' => 'Mysqli',
+	    'host' => 'localhost',
+	    'name' => 'bigace',
+	    'user' => 'username',
+	    'pass' => 'password',
+	    'prefix' => 'cms_',
+	    'charset' => 'utf8',
+	  ),
+	  'ssl' => false,
+	  'rewrite' => true,
+	);
+
+
+Note: It is correct that there is no closing PHP Tag ?> - read [bigace:developer:codeconventions](bigace/developer/codeconventions).

bigace/administration/change-server.md

@@ -0,0 +1,60 @@
+# Transfer / Move BIGACE to a new Server
+
+If you move to a new hoster, you need to transfer BIGACE installation and database there.
+As BIGACE comes __not__ with a built-in backup system, you need to copy and download the data manually.
+
+## Filesystem backup
+
+You need the complete BIGACE root folder including ALL files and the subfolders.
+
+Good hoster have a solution for filesystem backup, to create ZIP or TAR archives of the directory structure. 
+In most cases you might need to download all files with FTP. Just choose your BIGACE folder and get a coffe ;) while downloading.
+
+If you have terminal access like SSH or Windows Remote Desktop you can easily create the archive using zip/tar or any other tool of your choice. If there is no tool available you can ask your provider to create the archive for you.
+
+## Database backup
+
+Using phpMyAdmin will be the solution for most of the people hosting on shared systems. Just select your BIGACE database, switch to Export, select to export:
+
+*  Structure
+
+*  Content
+
+*  all BIGACE tables (using the BIGACE Database Prefix)
+
+*  into a (zipped) file
+and GO.
+
+If you have shell access, use mysqlexport or mysqladmin if you have GUI access, what is the best way to transfer mysql data from one machine to another.
+
+If the backup fails, because of too much data, truncate (empty) the "logging" and "session" tables. With activated statistics, you might create a single backup from the "statistics" data, truncate it afterwards and recreate the full backup.
+
+## Reimport Database
+
+Using phpMyAmin, simply create a new database on your new server. Select import and choose the exported file created in the step before. Upload and wait, everything should be fine.
+
+Using a MySQL Tool you can choose between shell with mysqlimport and GUI with mysqladmin.
+
+## Re-upload file structure
+
+Using FTP upload the BIGACE folder into your webroot.
+
+If you have shell access, upload the archive and extract it.
+
+## Reconfigure BIGACE on the new host
+
+After you moved database and filesystem to the new machine, you can now change the BIGACE config, according to your new environment.
+
+ 1.  Edit **/system/config/consumer.ini** and replace the old domain with the new one (for example [www.example.com] with [www.mynewhost.com])
+ 2.  Edit **/system/config/config.system.php** and change the database connecting parameter
+
+## Environment changed
+
+If your new webhost does not support URL Rewriting and you want to turn it off, or you want to activate it because your new hoster supports .htaccess files, please read the [URL Rewriting](bigace/administration/urlrewriting) Guide.
+
+If you now run in a subfolder of your domain, read how to change that in the config file [consumer.ini](bigace/manual/community#consumer.ini).
+
+# SEO
+
+Moving BIGACE to a new host is often connected with a domain change. In this case, think about keeping the old domain and activating a 301 .htaccess redirects to the new site for at least several weeks.
+

bigace/administration/configfiles.md

@@ -0,0 +1,45 @@
+# Configuration Files
+
+There are two types of configuration Files, the first one are valid for the entire System, the othe ones are Community dependend.
+
+## System Configurations
+
+System wide configurations can be found in Config Files within the directory **/system/config/**.
+
+**config.system.php**
+In dieser Datei finden sich die wichtigsten Einstellungen, z.B. die Verbindungsdaten zur Datenbank. Diese Datei ist interessant für Systemadministratoren, hier können unter anderem Session Einstellungen verändert werden.
+
+**[consumer.ini](bigace/manual/community#consumer.ini)**
+Hier finden Sie die Verknüpfungen zwischen Domain Namen zu Consumer ID, Wartungsarbeiten und Default Consumer. Zum Editieren dieser Datei stehen mehrere Administratrationsmasken zur Verfügung. Es wird dringend davon abgeraten diese Datei manuell anzupassen!
+
+**mimetypes.ini**
+Diee Datei enthält die Konfiguration für die Zuordnung zwischen Dateitypen und Itemtypes. Sollten Sie nicht in der Lage sein bestimmte Dateitypen hochzuladen, ist hier der richtige Ansatzpunkt.
+
+**services.ini**
+Diese Datei ist ein elementarer Bestandteil des Core Systems, hier werden die Implementationen der API Interfaces konfiguriert. Seien Sie vorsischtig wenn Sie hier Änderungen vornehmen. Hier können Sie z.B. das Loglevel anpassen.
+
+
+## Community Configurations
+
+Community dependend configurations can be found in your Community Directory [/consumer/cid{CID}/config/](bigace/cid_cid).
+
+**config.system.cid{CID}.inc.php** 	
+Alle hier aufgeführten Werte überschreiben die Einstellungen der Datei config.system.php (siehe auch the section called “System Configurations”). Die so überschriebenen Einstellungen gelten dann nur für den jeweiligen Consumer.
+
+Kopieren Sie die entsprechenden Einstellungen einfach von den System Dateien in die Community Konfiguration und passen sie dort entsprechend an.
+
+Zum Beispiel wäre es möglich eigene Datenbanken für bestimmte Communitys zu verwenden. Häufiger wird man aber das Loglevel für einzelne Communitys anpassen wollen...
+
+**config.statistic.cid{CID}.inc.php**
+Hier ist die Datenbankverbindung für die Statistik Tabellen eingetragen. Da bei eingeschalteten Statistiken eine große Menge an schreibenden Zugriffen stattfindet, sollten diese - aus Performancegründen - in eine andere Datenbank ausgelagert werden.
+
+**config.email.cid{CID}.inc.php**
+Hier finden Sie die Einstellungen, welche benutzt werden um Emails zu versenden (z.B. über das "Nachrichten versenden" Modul). Die wichtigsten dieser Einstellungen werden von Ihnen während der Installation eingetragen.
+
+**config.select.inc.php**
+In dieser Datei können die Spalten konfiguriert werden, welche von bei Datenbank Abfragen selektiert werden. Dies kann die Performance der Abfragen erhöhen. Sie sollten diese Einstellungen jedoch nur unter Vorsicht ändern, da hierdurch auch einiges "kaputt" konfiguriert werden kann (siehe auch the section called “Database Tuning”).
+
+**user_attributes.ini**
+In dieser Datei konfigurieren Sie, welche Felder in der Benutzeradministration für einen Benutzer angezeigt werden sollen. Sie können diese Werte bedenkenlos anpassen, vorhandene Werte werden in der Datenbank nicht verändert oder gelöscht, sie werden schlimmstenfalls nicht mehr angezeigt. Sollte sich in den Übersetzungsdateien (/system/language/XX/userAdmin.lang.php) kein Schlüssel für den jeweiligen Wert finden, wird der Wert zweite Wert als Bezeichnung angezeigt.
+
+

bigace/administration/databasetuning.md

@@ -0,0 +1,9 @@
+# Database Tuning
+
+You have the abbility to define which columns may be fetched from the Database for Item calls. 
+
+A configuration holds all columns for the several Itemtypes. 
+
+Look at the File [/consumer/cid{CID}/config/config.select.inc.php](bigace/cid_cid) for further information. Tuning these select columns may result in better performance.
+
+**Tip:** If the system might not be running after modifing the configuration, use the backup file from **/consumer/cid{CID}/config/config.select.inc.php**.

bigace/administration/fckeditor.md

@@ -0,0 +1,34 @@
+# Updating the FCKeditor
+
+This page describes how to configure and update the FCKeditor.
+
+
+## Updating
+
+If you do not want to wait for the next BIGACE release (where the newest Editor will be shipped with) you can manually update the Editor in your Installation. It is quite simple and no system files need to be touched at all!
+
+ 1.  Download the latest version
+ 2.  Delete all files and directorys from **/addon/fckeditor/**
+ 3.  Extract all files from the download archive to **/addon/fckeditor/**
+ 4.  If you like, remove unused files like the test directory
+
+If the new version brings improvements, that require new configuration settings, you should NOT edit the editors configuration file, but add those entrys in the BIGACE configuration for the FCKeditor...
+
+## Configuration File
+
+The FCKeditor specific configurations are saved in the file **/system/editor/fckeditor/javascript.php**.
+
+If you want to add new settings or edit the existing configuration, scroll down to the end of the file and search backward through the javascript entrys.
+
+
+## Dynamic configurations
+
+**Toolbar:** You can (Community-wide) change which toolbar is used by the FCKeditor. Therefor edit the [Configuration](bigace/manual/configurations) entry **editor** -> **fckeditor.toolbar**.
+
+Possible values are:
+
+*  **full** (default - for all available buttons) 
+
+*  ... FIXME ... add all config names
+
+

bigace/administration/filelogger.md

@@ -0,0 +1,34 @@
+# File Logger
+
+This short tutorial will tell you how to activate File logging in BIGACE. Logging to a file  instead of database logging has the big advantage that it works even when no database connection could be established (usefull for debugging).
+
+Please note, that the admin pnael at System/Logging will not work in combination with the FileLogger, you need to read the log files with a text editor!
+
+Two simple steps are required:
+
+## Activate File Logger
+
+Read how to [configure the logger class](bigace/developer/logger).
+
+## Reload the page
+
+After you activated the logger, all new log entries will be written to files instead of the database. These files can be locate at **/misc/logging/**.
+
+Take the last changed/created file and open it in a text editor to see the last written log entries.
+
+You can delete the file, it will be recreated the next time you load the page and log entries are written.
+
+## Logfile format
+
+ 
+Logfiles have the format "system_log_" + YEAR + "_" + MONTH + "_" + DAY + ".txt"
+
+## More about logging
+
+
+*  [bigace:manual:configurations:system:logger.loglevel](bigace/manual/configurations/system/logger.loglevel)
+
+*  [bigace:developer:logger](bigace/developer/logger)
+
+*  [bigace:extensions:development:firephp](bigace/extensions/development/firephp)
+