From 02cabef99d9fabcfbc7e6cd7653503d381b6f259 Mon Sep 17 00:00:00 2001 From: Hypolite Petovan Date: Wed, 27 Jun 2018 23:07:38 -0400 Subject: [PATCH] Move doc/htconfig.md to doc/Config.md - Updated all .htconfig.php references in other documentation pages - Added migration part --- doc/{htconfig.md => Config.md} | 227 ++++++++++++++++++++++++++++---- doc/FAQ.md | 4 +- doc/Home.md | 2 +- doc/Install.md | 10 +- doc/Installing-Connectors.md | 17 +-- doc/Settings.md | 17 ++- doc/Update.md | 2 +- doc/Vagrant.md | 4 +- doc/de/FAQ.md | 14 +- doc/de/Home.md | 2 +- doc/de/Install.md | 16 +-- doc/de/Installing-Connectors.md | 33 ++--- doc/de/Settings.md | 95 ++++++------- 13 files changed, 315 insertions(+), 128 deletions(-) rename doc/{htconfig.md => Config.md} (72%) diff --git a/doc/htconfig.md b/doc/Config.md similarity index 72% rename from doc/htconfig.md rename to doc/Config.md index a2ce91d4d..2ffc0bf7e 100644 --- a/doc/htconfig.md +++ b/doc/Config.md @@ -1,8 +1,198 @@ -Config values that can only be set in .htconfig.php -=================================================== +Friendica Configuration +======================= * [Home](help) +Friendica's configuration is done in two places: in INI configuration files and in the `config` database table. +Database config values overwrite the same file config values. + +# File configuration + +The configuration format for file configuration is an INI string returned from a PHP file. +This prevents your webserver from displaying your private configuration it interprets the configuration files and displays nothing. + +A typical configuration file looks like this: + +```php + +table.config { + margin: 1em 0; + background-color: #f9f9f9; + border: 1px solid #aaa; + border-collapse: collapse; + color: #000; + width: 100%; +} + +table.config > tr > th, +table.config > tr > td, +table.config > * > tr > th, +table.config > * > tr > td { + border: 1px solid #aaa; + padding: 0.2em 0.4em +} + +table.config > tr > th, +table.config > * > tr > th { + background-color: #f2f2f2; + text-align: center; + width: 50% +} + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
.htconfig.phpconfig/local.ini.php
+$db_host = 'localhost';
+$db_user = 'mysqlusername';
+$db_pass = 'mysqlpassword';
+$db_data = 'mysqldatabasename';
+$a->config["system"]["db_charset"] = 'utf8mb4';
+
+[database]
+hostname = localhost
+username = mysqlusername
+password = mysqlpassword
+database = mysqldatabasename
+charset = utf8mb4
+
+$a->config["section"]["key"] = "value";
+
+[section]
+key = value
+
+$a->config["section"]["key"] = array(
+	"value1",
+	"value2",
+	"value3"
+);
+
+[section]
+key[] = value1
+key[] = value2
+key[] = value3
+
+$a->config["key"] = "value";
+
+[config]
+key = value
+
+$a->path = "value";
+
+[system]
+urlpath = value
+
+$default_timezone = "value";
+
+[system]
+default_timezone = value
+
+$pidfile = "value";
+
+[system]
+pidfile = value
+
+$lang = "value";
+
+No equivalent (yet)
+
+ + +## Database Settings + +The configuration variables database.hostname, database.username, database.password, database.database and database.charset are holding your credentials for the database connection. +If you need to specify a port to access the database, you can do so by appending ":portnumber" to the database.hostname variable. + + [database] + hostname = your.mysqlhost.com:123456 + +If all of the following environment variables are set, Friendica will use them instead of the previously configured variables for the db: + + MYSQL_HOST + MYSQL_PORT + MYSQL_USERNAME + MYSQL_PASSWORD + MYSQL_DATABASE + + + +# Config values that can only be set in config/local.ini.php + There are some config values that haven't found their way into the administration page. This has several reasons. Maybe they are part of a current development that isn't considered stable and will be added later in the administration page when it is considered safe. @@ -13,9 +203,10 @@ Or it is for testing purposes only. Especially don't do that with undocumented values. The header of the section describes the category, the value is the parameter. -Example: To set the automatic database cleanup process add this line to your .htconfig.php: +Example: To set the automatic database cleanup process add this line to your config/local.ini.php: - $a->config['system']['always_show_preview'] = true; + [system] + always_show_preview = true ## jabber ## * **debug** (Boolean) - Enable debug level for the jabber account synchronisation. @@ -111,28 +302,16 @@ Example: To set the automatic database cleanup process add this line to your .ht Enabling the admin panel for an account, and thus making the account holder admin of the node, is done by setting the variable - $a->config['admin_email'] = "someone@example.com"; + [config] + admin_email = someone@example.com -Where you have to match the email address used for the account with the one you enter to the .htconfig file. -If more then one account should be able to access the admin panel, seperate the email addresses with a comma. +Where you have to match the email address used for the account with the one you enter to the config/local.ini.php file. +If more then one account should be able to access the admin panel, separate the email addresses with a comma. - $a->config['admin_email'] = "someone@example.com,someonelese@example.com"; + [config] + admin_email = someone@example.com,someoneelse@example.com If you want to have a more personalized closing line for the notification emails you can set a variable for the admin_name. - $a->config['admin_name'] = "Marvin"; - -## Database Settings - -The configuration variables db_host, db_user, db_pass and db_data are holding your credentials for the database connection. -If you need to specify a port to access the database, you can do so by appending ":portnumber" to the db_host variable. - - $db_host = 'your.mysqlhost.com:123456'; - -If all of the following environment variables are set, Friendica will use them instead of the previously configured variables for the db: - - MYSQL_HOST - MYSQL_PORT - MYSQL_USERNAME - MYSQL_PASSWORD - MYSQL_DATABASE + [config] + admin_name = Marvin diff --git a/doc/FAQ.md b/doc/FAQ.md index 31d980a9a..1b84b5cd8 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -197,14 +197,14 @@ If you are searching for new themes, you can find them at [Friendica-Themes.com] ### I've changed my email address now the admin panel is gone? -Have a look into your .htconfig.php and fix your email address there. +Have a look into your config/local.ini.php and fix your email address there. ### Can there be more then one admin for a node? Yes. You just have to list more then one email address in the -.htconfig.php file. +config/local.ini.php file. The listed emails need to be separated by a comma. diff --git a/doc/Home.md b/doc/Home.md index 0a41a4614..a353bab0d 100644 --- a/doc/Home.md +++ b/doc/Home.md @@ -32,7 +32,7 @@ Friendica Documentation and Resources * [Installing Connectors (Twitter/GNU Social)](help/Installing-Connectors) * [Install an ejabberd server (XMPP chat) with synchronized credentials](help/install-ejabberd) * [Using SSL with Friendica](help/SSL) -* [Config values that can only be set in .htconfig.php](help/htconfig) +* [Config values that can only be set in config/local.ini.php](help/Config) * [Improve Performance](help/Improve-Performance) * [Administration Tools](help/tools) diff --git a/doc/Install.md b/doc/Install.md index 357478096..154a32117 100644 --- a/doc/Install.md +++ b/doc/Install.md @@ -100,19 +100,19 @@ If you need to specify a port for the connection to the database, you can do so *If* the manual installation fails for any reason, check the following: -* Does ".htconfig.php" exist? If not, edit htconfig.php and change the system settings. Rename to .htconfig.php +* Does "config/local.ini.php" exist? If not, edit config/local-sample.ini.php and change the system settings. Rename to config/local.ini.php * Is the database is populated? If not, import the contents of "database.sql" with phpmyadmin or the mysql command line. At this point visit your website again, and register your personal account. Registration errors should all be recoverable automatically. If you get any *critical* failure at this point, it generally indicates the database was not installed correctly. -You might wish to move/rename .htconfig.php to another name and empty (called 'dropping') the database tables, so that you can start fresh. +You might wish to move/rename config/local.ini.php to another name and empty (called 'dropping') the database tables, so that you can start fresh. ### Option B: Run the automatic install script Open the file htconfig.php in the main Friendica directory with a text editor. Remove the `die('...');` line and edit the lines to suit your installation (MySQL, language, theme etc.). -Then save the file (do not rename it). +Then save the file (do not rename it). Navigate to the main Friendica directory and execute the following command: @@ -126,7 +126,7 @@ At this point visit your website again, and register your personal account. *If* the automatic installation fails for any reason, check the following: -* Does ".htconfig.php" already exist? If yes, the automatic installation won't start +* Does "config/local.ini.php" already exist? If yes, the automatic installation won't start * Are the settings inside "htconfig.php" correct? If not, edit the file again. * Is the empty MySQL-database created? If not, create it. @@ -162,5 +162,5 @@ Bad things will happen. Let there be a hardware failure, a corrupted database or whatever you can think of. So once the installation of your Friendica node is done, you should make yourself a backup plan. -The most important file is the `.htconfig.php` file in the base directory. +The most important file is the `config/local.ini.php` file in the base directory. As it stores all your data, you should also have a recent dump of your Friendica database at hand, should you have to recover your node. diff --git a/doc/Installing-Connectors.md b/doc/Installing-Connectors.md index 5ea34d473..6ad140fa9 100644 --- a/doc/Installing-Connectors.md +++ b/doc/Installing-Connectors.md @@ -4,7 +4,7 @@ Installing Connectors (Twitter/GNU Social) * [Home](help) -Friendica uses addons to provide connectivity to some networks, such as Twitter or App.net. +Friendica uses addons to provide connectivity to some networks, such as Twitter or App.net. There is also a addon to post through to an existing account on a GNU Social service. You only need this to post to an already existing GNU Social account, but not to communicate with GNU Social members in general. @@ -19,7 +19,7 @@ Addons must be installed by the site administrator before they can be used. This is accomplished through the site administration panel. Each of the connectors also requires an "API key" from the service you wish to connect with. -Some addons allow you to enter this information in the site administration pages, while others may require you to edit your configuration file (.htconfig.php). +Some addons allow you to enter this information in the site administration pages, while others may require you to edit your configuration file (config/local.ini.php). The ways to obtain these keys vary between the services, but they all require an existing account on the target service. Once installed, these API keys can usually be shared by all site members. @@ -39,10 +39,11 @@ You can get it from [Twitter](https://twitter.com/apps). Register your Friendica site as "Client" application with "Read & Write" access. We do not need "Twitter as login". When you've registered the app you get a key pair with an OAuth Consumer key and a secret key for your application/site. -Add this key pair to your global .htconfig.php: +Add this key pair to your config/local.ini.php: - $a->config['twitter']['consumerkey'] = 'your consumer_key here'; - $a->config['twitter']['consumersecret'] = 'your consumer_secret here'; + [twitter] + consumerkey = your consumer_key here + consumersecret = your consumer_secret here After this, your users can configure their Twitter account settings from "Settings -> Connector Settings". @@ -67,8 +68,8 @@ When the addon is activated the user has to acquire the following in order to co To get the OAuth Consumer key pair the user has to -1 ask her Friendica admin if a pair already exists or -2 has to register the Friendica server as a client application on the GNU Social server. +1 ask her Friendica admin if a pair already exists or +2 has to register the Friendica server as a client application on the GNU Social server. This can be done from the account settings under "Settings -> Connections -> Register an OAuth client application -> Register a new application" on the GNU Social server. @@ -83,6 +84,6 @@ During the registration of the OAuth client remember the following: After the required credentials for the application are stored in the configuration you have to actually connect your Friendica account with GNU Social. This is done from the Settings -> Connector Settings page. Follow the Sign in with GNU Social button, allow access and then copy the security code into the box provided. -Friendica will then try to acquire the final OAuth credentials from the API. +Friendica will then try to acquire the final OAuth credentials from the API. If successful, the addon settings will allow you to select to post your public messages to your GNU Social account (have a look behind the little lock symbol beneath the status "editor" on your Home or Network pages). diff --git a/doc/Settings.md b/doc/Settings.md index 04a9b9699..dda2a9a58 100644 --- a/doc/Settings.md +++ b/doc/Settings.md @@ -69,7 +69,7 @@ You can chose between the following modes: ##### Invitation based registry Additionally to the setting in the admin panel, you can devide if registrations are only possible using an invitation code or not. -To enable invitation based registration, you have to set the `invitation_only` setting in the [.htconfig.php](/help/htconfig) file. +To enable invitation based registration, you have to set the `invitation_only` setting in the [config/local.ini.php](/help/Config) file. If you want to use this method, the registration policy has to be set to either *open* or *requires approval*. #### Check Full Names @@ -325,7 +325,7 @@ You should set up some kind of [log rotation](https://en.wikipedia.org/wiki/Log_ **Known Issues**: The filename ``friendica.log`` can cause problems depending on your server configuration (see [issue 2209](https://github.com/friendica/friendica/issues/2209)). By default PHP warnings and error messages are supressed. -If you want to enable those, you have to activate them in the ``.htconfig.php`` file. +If you want to enable those, you have to activate them in the ``config/local.ini.php`` file. Use the following settings to redirect PHP errors to a file. Config: @@ -373,24 +373,27 @@ By default this will be the one account you create during the installation proce But you can expand the list of email addresses by any used email address you want. Registration of new accounts with a listed email address is not possible. - $a->config['admin_email'] = 'you@example.com, buddy@example.com'; + [config] + admin_email = you@example.com, buddy@example.com ## PHP Path Some of Friendicas processes are running in the background. For this you need to specify the path to the PHP binary to be used. - $a->config['php_path'] = '{{$phpath}}'; + [config] + php_path = {{$phpath}} ## Subdirectory configuration It is possible to install Friendica into a subdirectory of your webserver. -We strongly discurage you from doing so, as this will break federation to other networks (e.g. Diaspora, GNU Socia, Hubzilla) +We strongly discourage you from doing so, as this will break federation to other networks (e.g. Diaspora, GNU Socia, Hubzilla) Say you have a subdirectory for tests and put Friendica into a further subdirectory, the config would be: - $a->path = 'tests/friendica'; + [system] + urlpath = tests/friendica ## Other exceptions -Furthermore there are some experimental settings, you can read-up in the [Config values that can only be set in .htconfig.php](help/htconfig) section of the documentation. +Furthermore there are some experimental settings, you can read-up in the [Config values that can only be set in config/local.ini.php](help/Config) section of the documentation. diff --git a/doc/Update.md b/doc/Update.md index 9e9324da9..835dd3375 100644 --- a/doc/Update.md +++ b/doc/Update.md @@ -7,7 +7,7 @@ Updating Friendica If you installed Friendica in the ``path/to/friendica`` folder: 1. Unpack the new Friendica archive in ``path/to/friendica_new``. -2. Copy ``.htconfig.php``, ``photo/`` and ``proxy/`` from ``path/to/friendica`` to ``path/to/friendica_new``. +2. Copy ``config/local.ini.php``, ``photo/`` and ``proxy/`` from ``path/to/friendica`` to ``path/to/friendica_new``. 3. Rename the ``path/to/friendica`` folder to ``path/to/friendica_old``. 4. Rename the ``path/to/friendica_new`` folder to ``path/to/friendica``. 5. Check your site. Note: it may go into maintenance mode to update the database schema. diff --git a/doc/Vagrant.md b/doc/Vagrant.md index a224ebafc..6fd74240d 100644 --- a/doc/Vagrant.md +++ b/doc/Vagrant.md @@ -42,7 +42,7 @@ This will not delete the virtual machine. 9. To ultimately delete the virtual machine run $> vagrant destroy - $> rm /vagrant/.htconfig.php + $> rm /vagrant/config/local.ini.php to make sure that you can start from scratch with another "vagrant up". @@ -53,6 +53,6 @@ You will then have the following accounts to login: * friendica1, password friendica1 * friendica2, password friendica2 and so on until friendica5 * friendica1 is connected to all others. friendica1 has two groups: group1 with friendica2 and friendica4, group2 with friendica3 and friendica5. - * friendica2 and friendica3 are conntected. friendica4 and friendica5 are connected. + * friendica2 and friendica3 are conntected. friendica4 and friendica5 are connected. For further documentation of vagrant, please see [the vagrant*docs*](https://docs.vagrantup.com/v2/). diff --git a/doc/de/FAQ.md b/doc/de/FAQ.md index b52aa3d39..6baa5c5f5 100644 --- a/doc/de/FAQ.md +++ b/doc/de/FAQ.md @@ -85,9 +85,9 @@ Zum Konvertieren von Videos in das lizenfreie Videoformat WebM gibt es unter Win ### Ist es möglich, bei mehreren Profilen verschiedene Avatare (Nutzerbilder) zu haben? Ja. -Auf Deiner ["Profile verwalten/editieren"-Seite](../profiles) wählst Du zunächst das gewünschte Profil aus. -Anschließend siehst Du eine Seite mit allen Infos zu diesem Profil. -Klicke nun oben auf den Link "Profilbild ändern" und lade im nächsten Fenster ein Bild von Deinem PC hoch. +Auf Deiner ["Profile verwalten/editieren"-Seite](../profiles) wählst Du zunächst das gewünschte Profil aus. +Anschließend siehst Du eine Seite mit allen Infos zu diesem Profil. +Klicke nun oben auf den Link "Profilbild ändern" und lade im nächsten Fenster ein Bild von Deinem PC hoch. Um Deine privaten Daten zu schützen, wird in Beiträgen nur das Bild aus Deinem öffentlichen Profil angezeigt. @@ -180,7 +180,7 @@ Hier ist eine Liste von Clients bei denen dies möglich ist, bzw. die speziell f ### Wo finde ich Hilfe? -Wenn Du Probleme mit Deiner Friendica-Seite hast, dann kannst Du die Community in der [Friendica-Support-Gruppe](https://forum.friendi.ca/profile/helpers) oder im [deutschen Friendica-Support-Forum](http://toktan.org/profile/wiki) fragen oder Dir das [deutsche Wiki](http://wiki.toktan.org/doku.php) anschauen. +Wenn Du Probleme mit Deiner Friendica-Seite hast, dann kannst Du die Community in der [Friendica-Support-Gruppe](https://forum.friendi.ca/profile/helpers) oder im [deutschen Friendica-Support-Forum](http://toktan.org/profile/wiki) fragen oder Dir das [deutsche Wiki](http://wiki.toktan.org/doku.php) anschauen. Wenn Du Deinen Account nicht nutzen kannst, kannst Du entweder einen [Testaccount](https://tryfriendica.de) bzw. einen Account auf einer öffentlichen Seite ([Liste](https://dir.friendica.social/servers)) nutzen. Wenn du dir keinen weiteren Friendica Account einrichten willst, kannst du auch gerne über einen der folgenden alternativen Kanäle Hilfe suchen: @@ -199,7 +199,7 @@ Admin Ja, das ist möglich. Es ist allerdings nicht möglich, eine Datenbank durch zwei Domains zu nutzen. -Solange Du Deine .htconfig.php allerdings so einrichtest, dass das System nicht versucht, eine Installation durchzuführen, kannst Du die richtige Config-Datei in include/$hostname/.htconfig.php hinterlegen. +Solange Du Deine config/local.ini.php allerdings so einrichtest, dass das System nicht versucht, eine Installation durchzuführen, kannst Du die richtige Config-Datei in include/$hostname/config/local.ini.php hinterlegen. Alle Cache-Aspekte und der Zugriffsschutz können pro Instanz konfiguriert werden. @@ -216,13 +216,13 @@ Wenn Du neue Themen suchst, findest Du sie auf [Friendica-Themes.com](http://fri ### Ich habe meine E-Mail Adresse geändern und jetzt ist das Admin Panel verschwunden? -Bitte aktualisiere deine E-Mail Adresse in der .htconfig.php Datei. +Bitte aktualisiere deine E-Mail Adresse in der config/local.ini.php Datei. ### Kann es mehr als einen Admin auf einer Friendica Instanz geben? Ja. -Du kannst in der .htconfig.php Datei mehrere E-Mail Adressen auflisten. +Du kannst in der config/local.ini.php Datei mehrere E-Mail Adressen auflisten. Die aufgelisteten Adressen werden mit Kommata von einander getrennt. diff --git a/doc/de/Home.md b/doc/de/Home.md index 31cce7aea..b6a07cc09 100644 --- a/doc/de/Home.md +++ b/doc/de/Home.md @@ -34,7 +34,7 @@ Friendica - Dokumentation und Ressourcen * [Konnektoren (Connectors) installieren (Twitter/GNU Social)](help/Installing-Connectors) * [Installation eines ejabberd Servers (XMPP-Chat) mit synchronisierten Anmeldedaten](help/install-ejabberd) (EN) * [Betreibe deine Seite mit einem SSL-Zertifikat](help/SSL) -* [Konfigurationswerte, die nur in der .htconfig.php gesetzt werden können](help/htconfig) (EN) +* [Konfigurationswerte, die nur in der config/local.ini.php gesetzt werden können](help/Config) (EN) * [Performance verbessern](help/Improve-Performance) * [Administration Werkzeuge](help/tools) (EN) diff --git a/doc/de/Install.md b/doc/de/Install.md index f324da68e..ef4ef8aad 100644 --- a/doc/de/Install.md +++ b/doc/de/Install.md @@ -56,7 +56,7 @@ Stelle sicher, dass der Ordner *view/smarty3* existiert and von dem Webserver-Be mkdir view/smarty3 chmod 775 view/smarty3 -Falls Addons installiert werden sollen: Gehe in den Friendica-Ordner +Falls Addons installiert werden sollen: Gehe in den Friendica-Ordner cd mywebsite @@ -98,19 +98,19 @@ Starte MySQL dann neu und es sollte klappen. ### Option A: Der manuelle Installer -Besuche deine Webseite mit deinem Browser und befolge die Anleitung. +Besuche deine Webseite mit deinem Browser und befolge die Anleitung. Bitte beachte jeden Fehler und korrigiere diese, bevor du fortfährst. Falls du einen Port für die Datenbankverbindung angeben musst, kannst du diesen in der Host-Eingabe Zeile angeben. *Wenn* die manuelle Installation aus irgendeinem Grund fehlschlägt, dann prüfe das Folgende: -* ".htconfig.php" existiert ... wenn nicht, bearbeite die „htconfig.php“ und ändere die Systemeinstellungen. Benenne sie um in „.htconfig.php". +* "config/local.ini.php" existiert ... wenn nicht, bearbeite die „config/local-sample.ini.php“ und ändere die Systemeinstellungen. Benenne sie um in „config/local.ini.php". * die Datenbank beinhaltet Daten. ... wenn nicht, importiere den Inhalt der Datei "database.sql" mit phpmyadmin oder per mysql-Kommandozeile. Besuche deine Seite an diesem Punkt wieder und registriere deinen persönlichen Account. Alle Registrierungsprobleme sollten automatisch behebbar sein. Wenn du irgendwelche **kritischen** Fehler zu diesen Zeitpunkt erhalten solltest, deutet das darauf hin, dass die Datenbank nicht korrekt installiert wurde. -Du kannst bei Bedarf die Datei .htconfig.php verschieben/umbenennen und die Datenbank leeren (als „Dropping“ bezeichnet), so dass du mit einem sauberen System neu starten kannst. +Du kannst bei Bedarf die Datei config/local.ini.php verschieben/umbenennen und die Datenbank leeren (als „Dropping“ bezeichnet), so dass du mit einem sauberen System neu starten kannst. ### Option B: Starte das manuelle Installationsscript @@ -127,8 +127,8 @@ Oder falls du alle optionalen Checks ausfürehn lassen möchtest, benutze diese bin/console autoinstall -a *Wenn* die automatisierte Installation aus irgendeinem Grund fehlschlägt, dann prüfe das Folgende: -* Existiert die `.htconfig.php`? Falls ja, wird die automatisierte Installation nicht gestartet. -* Sind Einstellungen in der `.htconfig.php` korrekt? Falls nicht, bitte bearbeite diese Datei erneut. +* Existiert die `config/local.ini.php`? Falls ja, wird die automatisierte Installation nicht gestartet. +* Sind Einstellungen in der `config/local.ini.php` korrekt? Falls nicht, bitte bearbeite diese Datei erneut. * Ist die leere MySQL-Datenbank erstellt? Falls nicht, erstelle diese. Für mehr Informationen kannst du diese Option verwenden: @@ -137,7 +137,7 @@ Für mehr Informationen kannst du diese Option verwenden: ### Einen Worker einrichten -Erstelle einen Cron job oder einen regelmäßigen Task, um den Poller alle 5-10 Minuten im Hintergrund ablaufen zu lassen. +Erstelle einen Cron job oder einen regelmäßigen Task, um den Poller alle 5-10 Minuten im Hintergrund ablaufen zu lassen. Beispiel: cd /base/directory; /path/to/php bin/worker.php @@ -160,5 +160,5 @@ Es werden schlimme Dinge geschehen. Sei es nun ein Hardwareversagen oder eine kaputte Datenbank. Deshalb solltest du dir, nachdem die Installation deines Friendica Knotens abgeschlossen ist, einen Backup Plan erstellen. -Die wichtigste Datei ist die `.htconfig.php` im Stammverzeichnis deiner Friendica Installation. +Die wichtigste Datei ist die `config/local.ini.php` im Stammverzeichnis deiner Friendica Installation. Und da alle Daten in der Datenbank gespeichert werden, solltest du einen nicht all zu alten Dump der Friendica Datenbank zur Hand haben, solltest du deinen Knoten wieder herstellen müssen. diff --git a/doc/de/Installing-Connectors.md b/doc/de/Installing-Connectors.md index f9fe5b0f7..3fa46ab5a 100644 --- a/doc/de/Installing-Connectors.md +++ b/doc/de/Installing-Connectors.md @@ -1,25 +1,25 @@ -Konnektoren installieren (Twitter/GNU Social) +Konnektoren installieren (Twitter/GNU Social) ================================================== * [Zur Startseite der Hilfe](help) Friendica nutzt Erweiterung, um die Verbindung zu anderen Netzwerken wie Twitter oder App.net zu gewährleisten. -Es gibt außerdem ein Erweiterung, um über einen bestehenden GNU Social-Account diesen Service zu nutzen. -Du brauchst dieses Erweiterung aber nicht, um mit GNU Social-Mitgliedern von Friendica aus zu kommunizieren - es sei denn, du wünschst es, über einen existierenden Account einen Beitrag zu schreiben. +Es gibt außerdem ein Erweiterung, um über einen bestehenden GNU Social-Account diesen Service zu nutzen. +Du brauchst dieses Erweiterung aber nicht, um mit GNU Social-Mitgliedern von Friendica aus zu kommunizieren - es sei denn, du wünschst es, über einen existierenden Account einen Beitrag zu schreiben. -Alle drei Erweiterung benötigen einen Account im gewünschten Netzwerk. +Alle drei Erweiterung benötigen einen Account im gewünschten Netzwerk. Zusätzlich musst du (bzw. der Administrator der Seite) einen API-Schlüssel holen, um einen authentifizierten Zugriff zu deinem Friendica-Server herstellen zu lassen. **Seitenkonfiguration** -Erweiterung müssen vom Administrator installiert werden, bevor sie genutzt werden können. +Erweiterung müssen vom Administrator installiert werden, bevor sie genutzt werden können. Dieses kann über das Administrationsmenü erstellt werden. -Jeder der Konnektoren benötigt zudem einen API-Schlüssel vom Service, der verbunden werden soll. -Einige Erweiterung erlaube es, diese Informationen auf den Administrationsseiten einzustellen, wohingegen andere eine direkte Bearbeitung der Konfigurationsdatei ".htconfig.php" erfordern. -Der Weg, um diese Schlüssel zu erhalten, variiert stark, jedoch brauchen fast alle einen bestehenden Account im gewünschten Service. +Jeder der Konnektoren benötigt zudem einen API-Schlüssel vom Service, der verbunden werden soll. +Einige Erweiterung erlaube es, diese Informationen auf den Administrationsseiten einzustellen, wohingegen andere eine direkte Bearbeitung der Konfigurationsdatei "config/local.ini.php" erfordern. +Der Weg, um diese Schlüssel zu erhalten, variiert stark, jedoch brauchen fast alle einen bestehenden Account im gewünschten Service. Einmal installiert, können diese Schlüssel von allen Seitennutzern genutzt werden. Im Folgenden findest du die Einstellungen für die verschiedenen Services (viele dieser Informationen kommen direkt aus den Quelldateien der Erweiterung): @@ -37,11 +37,12 @@ Um dieses Erweiterung zu nutzen, benötigst du einen OAuth Consumer-Schlüsselpa Registriere deine Friendica-Seite als "Client"-Anwendung mit "Read&Write"-Zugriff. Wir benötigen "Twitter als Login" nicht. Sobald du deine Anwendung installiert hast, erhältst du das Schlüsselpaar für deine Seite. -Trage dieses Schlüsselpaar in deine globale ".htconfig.php"-Datei ein. +Trage dieses Schlüsselpaar in deine globale "config/local.ini.php"-Datei ein. ``` -$a->config['twitter']['consumerkey'] = 'your consumer_key here'; -$a->config['twitter']['consumersecret'] = 'your consumer_secret here'; +[twitter] +consumerkey = your consumer_key here +consumersecret = your consumer_secret here ``` Anschließend kann der Nutzer deiner Seite die Twitter-Einstellungen selbst eintragen: "Einstellungen -> Connector Einstellungen". @@ -63,10 +64,10 @@ Wenn das Addon aktiv ist, muss der Nutzer die folgenden Einstellungen vornehmen, Um das OAuth-Schlüsselpaar zu erhalten, muss der Nutzer -(a) seinen Friendica-Admin fragen, ob bereits ein Schlüsselpaar existiert oder +(a) seinen Friendica-Admin fragen, ob bereits ein Schlüsselpaar existiert oder (b) einen Friendica-Server als Anwendung auf dem GNU Social-Server anmelden. -Dies kann über Einstellungen --> Connections --> "Register an OAuth client application" -> "Register a new application" auf dem GNU Social-Server durchgeführt werden. +Dies kann über Einstellungen --> Connections --> "Register an OAuth client application" -> "Register a new application" auf dem GNU Social-Server durchgeführt werden. Während der Registrierung des OAuth-Clients ist Folgendes zu beachten: @@ -76,9 +77,9 @@ Während der Registrierung des OAuth-Clients ist Folgendes zu beachten: * stelle Lese- und Schreibrechte ein * die Quell-URL sollte die URL deines Friendica-Servers sein -Sobald die benötigten Daten gespeichert sind, musst du deinen Friendica-Account mit GNU Social verbinden. -Das kannst du über Einstellungen --> Connector-Einstellungen durchführen. -Folge dem "Einloggen mit GNU Social"-Button, erlaube den Zugriff und kopiere den Sicherheitscode in die entsprechende Box. +Sobald die benötigten Daten gespeichert sind, musst du deinen Friendica-Account mit GNU Social verbinden. +Das kannst du über Einstellungen --> Connector-Einstellungen durchführen. +Folge dem "Einloggen mit GNU Social"-Button, erlaube den Zugriff und kopiere den Sicherheitscode in die entsprechende Box. Friendica wird dann versuchen, die abschließende OAuth-Einstellungen über die API zu beziehen. Wenn es geklappt hat, kannst du in den Einstellungen festlegen, ob deine öffentlichen Nachrichten automatisch in deinem GNU Social-Account erscheinen soll (achte hierbei auf das kleine Schloss-Symbol im Status-Editor) diff --git a/doc/de/Settings.md b/doc/de/Settings.md index 636566872..4d84f873f 100644 --- a/doc/de/Settings.md +++ b/doc/de/Settings.md @@ -8,8 +8,8 @@ Auf der Startseite des Admin Panels werden die Informationen zu der Instanz zusa Die erste Zahl gibt die Anzahl von Nachrichten an, die nicht zugestellt werden konnten. Die Zustellung wird zu einem späteren Zeitpunkt noch einmal versucht. Unter dem Punkt "Warteschlange Inspizieren" kannst du einen schnellen Blick auf die zweite Warteschlange werfen. -Die zweite Zahl steht für die Anzahl der Aufgaben, die die Worker noch vor sich haben. -Die Worker arbeiten Hintergrundprozesse ab. +Die zweite Zahl steht für die Anzahl der Aufgaben, die die Worker noch vor sich haben. +Die Worker arbeiten Hintergrundprozesse ab. Die Aufgaben der Worker sind priorisiert und werden anhand dieser Prioritäten abgearbeitet. Desweiteren findest du eine Übersicht über die Accounts auf dem Friendica Knoten, die unter dem Punkt "Nutzer" moderiert werden können. @@ -31,7 +31,7 @@ Da die meisten Konfigurationsoptionen einen Hilfstext im Admin Panel haben, kann #### Banner/Logo -Hiermit legst du das Banner der Seite fest. Standardmäßig ist das Friendica-Logo und der Name festgelegt. +Hiermit legst du das Banner der Seite fest. Standardmäßig ist das Friendica-Logo und der Name festgelegt. Du kannst hierfür HTML/CSS nutzen, um den Inhalt zu gestalten und/oder die Position zu ändern, wenn es nicht bereits voreingestellt ist. #### Systensprache @@ -63,33 +63,33 @@ Dabei kannst du zwischen den folgenden Optionen wählen: * **Bedarf der Zustimmung**: Jeder kann ein Nutzerkonto anlegen. Dieses muss allerdings durch den Admin freigeschaltet werden, bevor es verwendet werden kann. * **Geschlossen**: Es können keine weiteren Nutzerkonten angelegt werden. -##### Einladungen +##### Einladungen Zusätzlich zu den oben genannten Möglichkeiten, kann die Registrierung eines neuen Nutzerkontos an eine Einladung durch einen bestehenden Nutzer gekoppelt werden. -Hierzu muss in der [.htconfig.php](/help/htconfig) Datei die Option `invitation_only` aktiviert und als Registrierungsmethode entweder *Offen* oder *Bedarf der Zustimmung* gewählt werden. +Hierzu muss in der [config/local.ini.php](/help/Config) Datei die Option `invitation_only` aktiviert und als Registrierungsmethode entweder *Offen* oder *Bedarf der Zustimmung* gewählt werden. #### Namen auf Vollständigkeit überprüfen -Es kann vorkommen, dass viele Spammer versuchen, sich auf deiner Seite zu registrieren. -In Testphasen haben wir festgestellt, dass diese automatischen Registrierungen das Feld "Vollständiger Name" oft nur mit Namen ausfüllen, die kein Leerzeichen beinhalten. -Wenn du Leuten erlauben willst, sich nur mit einem Namen anzumelden, dann setze die Einstellung auf "true". +Es kann vorkommen, dass viele Spammer versuchen, sich auf deiner Seite zu registrieren. +In Testphasen haben wir festgestellt, dass diese automatischen Registrierungen das Feld "Vollständiger Name" oft nur mit Namen ausfüllen, die kein Leerzeichen beinhalten. +Wenn du Leuten erlauben willst, sich nur mit einem Namen anzumelden, dann setze die Einstellung auf "true". Die Standardeinstellung ist auf "false" gesetzt. - + #### OpenID Unterstützung -Standardmäßig wird OpenID für die Registrierung und für Logins genutzt. +Standardmäßig wird OpenID für die Registrierung und für Logins genutzt. Wenn du nicht willst, dass OpenID-Strukturen für dein System übernommen werden, dann setze "no_openid" auf "true". Standardmäßig ist hier "false" gesetzt. #### Unterbinde Mehrfachregistrierung -Um mehrfache Seiten zu erstellen, muss sich eine Person mehrfach registrieren können. -Deine Seiteneinstellung kann Registrierungen komplett blockieren oder an Bedingungen knüpfen. -Standardmäßig können eingeloggte Nutzer weitere Accounts für die Seitenerstellung registrieren. -Hier ist weiterhin eine Bestätigung notwendig, wenn "REGISTER_APPROVE" ausgewählt ist. -Wenn du die Erstellung weiterer Accounts blockieren willst, dann setze die Einstellung "block_extended_register" auf "true". +Um mehrfache Seiten zu erstellen, muss sich eine Person mehrfach registrieren können. +Deine Seiteneinstellung kann Registrierungen komplett blockieren oder an Bedingungen knüpfen. +Standardmäßig können eingeloggte Nutzer weitere Accounts für die Seitenerstellung registrieren. +Hier ist weiterhin eine Bestätigung notwendig, wenn "REGISTER_APPROVE" ausgewählt ist. +Wenn du die Erstellung weiterer Accounts blockieren willst, dann setze die Einstellung "block_extended_register" auf "true". Standardmäßig ist hier "false" gesetzt. - + ### Datei hochladen #### Maximale Bildgröße @@ -100,26 +100,26 @@ Maximale Bild-Dateigröße in Byte. Standardmäßig ist 0 gesetzt, was bedeutet, #### URL des weltweiten Verzeichnisses -Mit diesem Befehl wird die URL eingestellt, die zum Update des globalen Verzeichnisses genutzt wird. -Dieser Befehl ist in der Standardkonfiguration enthalten. -Der nicht dokumentierte Teil dieser Einstellung ist, dass das globale Verzeichnis gar nicht verfügbar ist, wenn diese Einstellung nicht gesetzt wird. +Mit diesem Befehl wird die URL eingestellt, die zum Update des globalen Verzeichnisses genutzt wird. +Dieser Befehl ist in der Standardkonfiguration enthalten. +Der nicht dokumentierte Teil dieser Einstellung ist, dass das globale Verzeichnis gar nicht verfügbar ist, wenn diese Einstellung nicht gesetzt wird. Dies erlaubt eine private Kommunikation, die komplett vom globalen Verzeichnis isoliert ist. #### Erzwinge Veröffentlichung -Standardmäßig können Nutzer selbst auswählen, ob ihr Profil im Seitenverzeichnis erscheint. -Diese Einstellung zwingt alle Nutzer dazu, im Verzeichnis zu erscheinen. +Standardmäßig können Nutzer selbst auswählen, ob ihr Profil im Seitenverzeichnis erscheint. +Diese Einstellung zwingt alle Nutzer dazu, im Verzeichnis zu erscheinen. Diese Einstellung kann vom Nutzer nicht deaktiviert werden. Die Standardeinstellung steht auf "false". #### Öffentlichen Zugriff blockieren -Aktiviere diese Einstellung um den öffentlichen Zugriff auf alle Seiten zu sperren, solange man nicht eingeloggt ist. -Das blockiert die Ansicht von Profilen, Freunden, Fotos, vom Verzeichnis und den Suchseiten. -Ein Nebeneffekt ist, dass Einträge dieser Seite nicht im globalen Verzeichnis erscheinen. -Wir empfehlen, speziell diese Einstellung auszuschalten (die Einstellung ist an anderer Stelle auf dieser Seite erklärt). -Beachte: das ist speziell für Seiten, die beabsichtigen, von anderen Friendica-Netzwerken abgeschottet zu sein. -Unautorisierte Personen haben ebenfalls nicht die Möglichkeit, Freundschaftsanfragen von Seitennutzern zu beantworten. -Die Standardeinstellung ist deaktiviert. +Aktiviere diese Einstellung um den öffentlichen Zugriff auf alle Seiten zu sperren, solange man nicht eingeloggt ist. +Das blockiert die Ansicht von Profilen, Freunden, Fotos, vom Verzeichnis und den Suchseiten. +Ein Nebeneffekt ist, dass Einträge dieser Seite nicht im globalen Verzeichnis erscheinen. +Wir empfehlen, speziell diese Einstellung auszuschalten (die Einstellung ist an anderer Stelle auf dieser Seite erklärt). +Beachte: das ist speziell für Seiten, die beabsichtigen, von anderen Friendica-Netzwerken abgeschottet zu sein. +Unautorisierte Personen haben ebenfalls nicht die Möglichkeit, Freundschaftsanfragen von Seitennutzern zu beantworten. +Die Standardeinstellung ist deaktiviert. Verfügbar in Version 2.2 und höher. #### Für Besucher verfügbare Gemeinschaftsseiten @@ -133,15 +133,15 @@ Angemeldete Nutzer des Knotens können grundsätzlich beide Seiten verwenden. #### Erlaubte Domains für Kontakte -Kommagetrennte Liste von Domains, welche eine Freundschaft mit dieser Seite eingehen dürfen. +Kommagetrennte Liste von Domains, welche eine Freundschaft mit dieser Seite eingehen dürfen. Wildcards werden akzeptiert (Wildcard-Unterstützung unter Windows benötigt PHP5.3) Standardmäßig sind alle gültigen Domains erlaubt. Mit dieser Option kann man einfach geschlossene Netzwerke, z.B. im schulischen Bereich aufbauen, aus denen nicht mit dem Rest des Netzwerks kommuniziert werden soll. #### Erlaubte Domains für E-Mails -Kommagetrennte Liste von Domains, welche bei der Registrierung als Part der Email-Adresse erlaubt sind. -Das grenzt Leute aus, die nicht Teil der Gruppe oder Organisation sind. +Kommagetrennte Liste von Domains, welche bei der Registrierung als Part der Email-Adresse erlaubt sind. +Das grenzt Leute aus, die nicht Teil der Gruppe oder Organisation sind. Wildcards werden akzeptiert (Wildcard-Unterstützung unter Windows benötigt PHP5.3) Standardmäßig sind alle gültigen Email-Adressen erlaubt. #### Nutzern erlauben das remote_self Flag zu setzen @@ -172,23 +172,23 @@ Wenn deine Seite eine Proxy-Einstellung nutzt, musst du diese Einstellungen vorn #### Netzwerk Wartezeit -Legt fest, wie lange das Netzwerk warten soll, bevor ein Timeout eintritt. +Legt fest, wie lange das Netzwerk warten soll, bevor ein Timeout eintritt. Der Wert wird in Sekunden angegeben. Standardmäßig ist 60 eingestellt; 0 steht für "unbegrenzt" (nicht empfohlen). #### UTF-8 Reguläre Ausdrücke -Während der Registrierung werden die Namen daraufhin geprüft, ob sie reguläre UTF-8-Ausdrücke nutzen. -Hierfür wird PHP benötigt, um mit einer speziellen Einstellung kompiliert zu werden, die UTF-8-Ausdrücke benutzt. +Während der Registrierung werden die Namen daraufhin geprüft, ob sie reguläre UTF-8-Ausdrücke nutzen. +Hierfür wird PHP benötigt, um mit einer speziellen Einstellung kompiliert zu werden, die UTF-8-Ausdrücke benutzt. Wenn du absolut keine Möglichkeit hast, Accounts zu registrieren, setze diesen Wert auf ja. #### SSL Überprüfen -Standardmäßig erlaubt Friendica SSL-Kommunikation von Seiten, die "selbst unterzeichnete" SSL-Zertifikate nutzen. -Um eine weitreichende Kompatibilität mit anderen Netzwerken und Browsern zu gewährleisten, empfehlen wir, selbst unterzeichnete Zertifikate **nicht** zu nutzen. -Aber wir halten dich nicht davon ab, solche zu nutzen. SSL verschlüsselt alle Daten zwischen den Webseiten (und für deinen Browser), was dir eine komplett verschlüsselte Kommunikation erlaubt. -Auch schützt es deine Login-Daten vor Datendiebstahl. Selbst unterzeichnete Zertifikate können kostenlos erstellt werden. -Diese Zertifikate können allerdings Opfer eines sogenannten ["man-in-the-middle"-Angriffs](http://de.wikipedia.org/wiki/Man-in-the-middle-Angriff) werden, und sind daher weniger bevorzugt. -Wenn du es wünscht, kannst du eine strikte Zertifikatabfrage einstellen. +Standardmäßig erlaubt Friendica SSL-Kommunikation von Seiten, die "selbst unterzeichnete" SSL-Zertifikate nutzen. +Um eine weitreichende Kompatibilität mit anderen Netzwerken und Browsern zu gewährleisten, empfehlen wir, selbst unterzeichnete Zertifikate **nicht** zu nutzen. +Aber wir halten dich nicht davon ab, solche zu nutzen. SSL verschlüsselt alle Daten zwischen den Webseiten (und für deinen Browser), was dir eine komplett verschlüsselte Kommunikation erlaubt. +Auch schützt es deine Login-Daten vor Datendiebstahl. Selbst unterzeichnete Zertifikate können kostenlos erstellt werden. +Diese Zertifikate können allerdings Opfer eines sogenannten ["man-in-the-middle"-Angriffs](http://de.wikipedia.org/wiki/Man-in-the-middle-Angriff) werden, und sind daher weniger bevorzugt. +Wenn du es wünscht, kannst du eine strikte Zertifikatabfrage einstellen. Das führt dazu, dass du keinerlei Verbindung zu einer selbst unterzeichneten SSL-Seite erstellen kannst ### Automatisch ein Kontaktverzeichnis erstellen @@ -313,7 +313,7 @@ Du solltest deshalb einen Dienst zur [log rotation](https://en.wikipedia.org/wik **Bekannte Probleme**: Der Dateiname `friendica.log` kann bei speziellen Server Konfigurationen zu Problemen führen (siehe [issue 2209](https://github.com/friendica/friendica/issues/2209)). Normalerweise werden Fehler- und Warnmeldungen von PHP unterdrückt. -Wenn du sie aktivieren willst, musst du folgendes in der `.htconfig.php` Datei eintragen um die Meldungen in die Datei `php.out` zu speichern +Wenn du sie aktivieren willst, musst du folgendes in der `config/local.ini.php` Datei eintragen um die Meldungen in die Datei `php.out` zu speichern error_reporting(E_ERROR | E_WARNING | E_PARSE ); ini_set('error_log','php.out'); @@ -367,14 +367,16 @@ Normalerweise trifft dies auf den ersten Account zu, der nach der Installation a Die Liste der E-Mail Adressen kann aber einfach erweitert werden. Mit keiner der angegebenen E-Mail Adressen können weitere Accounts registriert werden. - $a->config['admin_email'] = 'you@example.com, buddy@example.com'; + [config] + admin_email = you@example.com, buddy@example.com ## PHP Pfad Einige Prozesse von Friendica laufen im Hintergrund. Für diese Prozesse muss der Pfad zu der PHP Version gesetzt sein, die verwendet werden soll. - $a->config['php_path'] = '/pfad/zur/php-version'; + [config] + php_path = {{$phpath}} ## Unterverzeichnis Konfiguration @@ -382,9 +384,10 @@ Man kann Friendica in ein Unterverzeichnis des Webservers installieren. Wir raten allerdings dringen davon ab, da es die Interoperabilität mit anderen Netzwerken (z.B. Diaspora, GNU Social, Hubzilla) verhindert. Mal angenommen, du hast ein Unterverzeichnis tests und willst Friendica in ein weiteres Unterverzeichnis installieren, dann lautet die Konfiguration hierfür: - $a->path = 'tests/friendica'; + [system] + urlpath = tests/friendica ## Weitere Ausnahmen -Es gibt noch einige experimentelle Einstellungen, die nur in der ``.htconfig.php`` Datei konfiguriert werden können. -Im [Konfigurationswerte, die nur in der .htconfig.php gesetzt werden können (EN)](help/htconfig) Artikel kannst du mehr darüber erfahren. +Es gibt noch einige experimentelle Einstellungen, die nur in der ``config/local.ini.php`` Datei konfiguriert werden können. +Im [Konfigurationswerte, die nur in der config/local.ini.php gesetzt werden können (EN)](help/Config) Artikel kannst du mehr darüber erfahren.