mexon/friendica
1
0
Fork 0
Code Pull requests Activity

Merge pull request #1971 from tobiasd/20151019-docs

Browse source 
Updates to the documentations
This commit is contained in:
Michael Vogel 2015-10-19 10:10:24 +02:00
parent 5317c0b28f c652aec970
commit 59559e7452
5 changed files with 71 additions and 55 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

3
doc/Chats.md
View file

@ -41,7 +41,7 @@ You can use several servers to create an account:
At first you have to get the current version. You can either pull it from [Github](https://github.com) like so: At first you have to get the current version. You can either pull it from [Github](https://github.com) like so:
$> cd /var/www/virtual/YOURSPACE/html/addon; git pull $> cd /var/www/virtual/YOURSPACE/html/addon; git pull
Or you can download a tar archive here: [jappixmini.tgz](https://github.com/friendica/friendica-addons/blob/master/jappixmini.tgz) (click at „view raw“). Or you can download a tar archive here: [jappixmini.tgz](https://github.com/friendica/friendica-addons/blob/master/jappixmini.tgz) (click at „view raw“).
@ -63,6 +63,7 @@ At first you have to activate the addon.
Now add your Jabber/XMPP name, the domain/server (without "http"; just "jappix.com"). Now add your Jabber/XMPP name, the domain/server (without "http"; just "jappix.com").
For „Jabber BOSH Host“ you could use "https://bind.jappix.com/". For „Jabber BOSH Host“ you could use "https://bind.jappix.com/".
Note that you need another BOSH server if you do not use jappix.com for your XMPP account.
You can find further information in the „Configuration Help“-section below this fields. You can find further information in the „Configuration Help“-section below this fields.
At last you have enter your password (there are some more optional options, you can choose). At last you have enter your password (there are some more optional options, you can choose).
Finish these steps with "send" to save the entries. Finish these steps with "send" to save the entries.

2
doc/Developers-Intro.md
View file

@ -54,6 +54,8 @@ Have a look at our [issue tracker](https://github.com/friendica/friendica) on gi
* Try to reproduce a bug that needs more inquries and write down what you find out. * Try to reproduce a bug that needs more inquries and write down what you find out.
* If a bug looks fixed, ask the bug reporters for feedback to find out if the bug can be closed. * If a bug looks fixed, ask the bug reporters for feedback to find out if the bug can be closed.
* Fix a bug if you can. Please make the pull request against the *develop* branch of the repository. * Fix a bug if you can. Please make the pull request against the *develop* branch of the repository.
* There is a *Junior Job* label for issues we think might be a good point to start with.
But you don't have to limit yourself to those issues.
###Web interface ###Web interface

38
doc/Install.md
View file

@ -10,9 +10,11 @@ Not every PHP/MySQL hosting provider will be able to support Friendica.
Many will. Many will.
But **please** review the requirements and confirm these with your hosting provider prior to installation. But **please** review the requirements and confirm these with your hosting provider prior to installation.
Also if you encounter installation issues, please let us know via the [helper]() or the [developer]() forum or [file an issue](https://github.com/friendica/friendica/issues). Also if you encounter installation issues, please let us know via the [helper](http://helpers.pyxis.uberspace.de/profile/helpers) or the [developer](https://friendika.openmindspace.org/profile/friendicadevelopers) forum or [file an issue](https://github.com/friendica/friendica/issues).
Please be as clear as you can about your operating environment and provide as much detail as possible about any error messages you may see, so that we can prevent it from happening in the future. Please be as clear as you can about your operating environment and provide as much detail as possible about any error messages you may see, so that we can prevent it from happening in the future.
Due to the large variety of operating systems and PHP platforms in existence we may have only limited ability to debug your PHP installation or acquire any missing modules - but we will do our best to solve any general code issues. Due to the large variety of operating systems and PHP platforms in existence we may have only limited ability to debug your PHP installation or acquire any missing modules - but we will do our best to solve any general code issues.
If you do not have a Friendica account yet, you can register a temporary one at [tryfriendica.de](https://tryfriendica.de) and join the forums mentioned above from there.
The account will expire after 7 days, but you can ask the server admin to keep your account longer, should the problem not be resolved after that.
Before you begin: Choose a domain name or subdomain name for your server. Before you begin: Choose a domain name or subdomain name for your server.
Put some thought into this. Changing it after installation is currently not supported. Put some thought into this. Changing it after installation is currently not supported.
@ -29,7 +31,7 @@ Requirements
* curl, gd, mysql, hash and openssl extensions * curl, gd, mysql, hash and openssl extensions
* some form of email server or email gateway such that PHP mail() works * some form of email server or email gateway such that PHP mail() works
* mcrypt (optional; used for server-to-server message encryption) * mcrypt (optional; used for server-to-server message encryption)
* Mysql 5.x * Mysql 5.x or an equivalant alternative for MySQL (MariaDB etc.)
* the ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks (Windows) (Note: other options are presented in Section 7 of this document.) * the ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks (Windows) (Note: other options are presented in Section 7 of this document.)
* Installation into a top-level domain or sub-domain (without a directory/path component in the URL) is preferred. Directory paths will not be as convenient to use and have not been thoroughly tested. * Installation into a top-level domain or sub-domain (without a directory/path component in the URL) is preferred. Directory paths will not be as convenient to use and have not been thoroughly tested.
* If your hosting provider doesn't allow Unix shell access, you might have trouble getting everything to work. * If your hosting provider doesn't allow Unix shell access, you might have trouble getting everything to work.
@ -44,20 +46,20 @@ If you are able to do so, we recommend using git to clone the source repository
This makes the software much easier to update. This makes the software much easier to update.
The Linux command to clone the repository into a directory "mywebsite" would be The Linux command to clone the repository into a directory "mywebsite" would be
git clone https://github.com/friendica/friendica.git mywebsite git clone https://github.com/friendica/friendica.git mywebsite
Make sure the folder *view/smarty3* exists and is writable by the webserver user Make sure the folder *view/smarty3* exists and is writable by the webserver user
mkdir view/smarty3 mkdir view/smarty3
chmod 777 view/smarty3 chmod 777 view/smarty3
Get the addons by going into your website folder. Get the addons by going into your website folder.
cd mywebsite cd mywebsite
Clone the addon repository (separately): Clone the addon repository (separately):
git clone https://github.com/friendica/friendica-addons.git addon git clone https://github.com/friendica/friendica-addons.git addon
If you copy the directory tree to your webserver, make sure that you also copy .htaccess - as "dot" files are often hidden and aren't normally copied. If you copy the directory tree to your webserver, make sure that you also copy .htaccess - as "dot" files are often hidden and aren't normally copied.
@ -87,14 +89,14 @@ You might wish to move/rename .htconfig.php to another name and empty (called 'd
Set up a cron job or scheduled task to run the poller once every 5-10 minutes in order to perform background processing. Set up a cron job or scheduled task to run the poller once every 5-10 minutes in order to perform background processing.
Example: Example:
cd /base/directory; /path/to/php include/poller.php cd /base/directory; /path/to/php include/poller.php
Change "/base/directory", and "/path/to/php" as appropriate for your situation. Change "/base/directory", and "/path/to/php" as appropriate for your situation.
If you are using a Linux server, run "crontab -e" and add a line like the If you are using a Linux server, run "crontab -e" and add a line like the
one shown, substituting for your unique paths and settings: one shown, substituting for your unique paths and settings:
*/10 * * * * cd /home/myname/mywebsite; /usr/bin/php include/poller.php */10 * * * * cd /home/myname/mywebsite; /usr/bin/php include/poller.php
You can generally find the location of PHP by executing "which php". You can generally find the location of PHP by executing "which php".
If you run into trouble with this section please contact your hosting provider for assistance. If you run into trouble with this section please contact your hosting provider for assistance.
@ -104,25 +106,31 @@ Alternative: You may be able to use the 'poormancron' plugin to perform this ste
To do this, edit the file ".htconfig.php" and look for a line describing your plugins. To do this, edit the file ".htconfig.php" and look for a line describing your plugins.
On a fresh installation, it will look like this: On a fresh installation, it will look like this:
$a->config['system']['addon'] = 'js_upload'; $a->config['system']['addon'] = 'js_upload';
It indicates the "js_upload" addon module is enabled. It indicates the "js_upload" addon module is enabled.
You may add additional addons/plugins using this same line in the configuration file. You may add additional addons/plugins using this same line in the configuration file.
Change it to read Change it to read
$a->config['system']['addon'] = 'js_upload,poormancron'; $a->config['system']['addon'] = 'js_upload,poormancron';
and save your changes. and save your changes.
Once you have installed Friendica and created an admin account as part of the process, you can access the admin panel of your installation and do most of the server wide configuration from there
Updating your installation with git Updating your installation with git
--- ---
You can get the latest changes at any time with You can get the latest changes at any time with
cd mywebsite cd mywebsite
git pull git pull
The default branch to use it the ``master`` branch, which is the stable version of Friendica.
If you want to use and test bleeding edge code please checkout the ``develop`` branch.
The new features and fixes will be merged from ``develop`` into ``master`` when they are stable approx four times a year.
The addon tree has to be updated separately like so: The addon tree has to be updated separately like so:
cd mywebsite/addon cd mywebsite/addon
git pull git pull

2
doc/de/Chats.md
View file

@ -70,7 +70,7 @@ Trage nun Deinen Jabber/XMPP Namen ein, ebenfalls die entsprechende Domain bzw.
Um das JavaScript Applet zum Chatten im Browser verwenden zu können, benötigst du einen BOSH Proxy. Um das JavaScript Applet zum Chatten im Browser verwenden zu können, benötigst du einen BOSH Proxy.
Entweder betreibst du deinen eigenen (s. Dokumentation deines XMPP Servers) oder du verwendest einen öffentlichen BOSH Proxy. Entweder betreibst du deinen eigenen (s. Dokumentation deines XMPP Servers) oder du verwendest einen öffentlichen BOSH Proxy.
Beachte aber, dass der Betreiber dieses Proxies den kompletten Datenverkehr über den Proxy mitlesen kann. Beachte aber, dass der Betreiber dieses Proxies den kompletten Datenverkehr über den Proxy mitlesen kann.
Siehe dazu auch die „Configuration Help“ weiter unten. Siehe dazu auch die „Configuration Help“ unter den Eingabefeldern.
Gebe danach noch Dein Passwort an, und damit ist eigentlich schon fast alles geschafft. Gebe danach noch Dein Passwort an, und damit ist eigentlich schon fast alles geschafft.
Die weiteren Einstellmöglichkeiten bleiben Dir überlassen, sind also optional. Die weiteren Einstellmöglichkeiten bleiben Dir überlassen, sind also optional.
Jetzt noch auf „senden“ klicken und fertig. Jetzt noch auf „senden“ klicken und fertig.

5
doc/de/Developers.md
View file

@ -13,6 +13,11 @@ Die Anleitung unter [http://help.github.com/fork-a-repo/](http://help.github.com
Gehe dann nach getaner Arbeit zu Deiner Github-Seite und erstelle eine "Pull request", um Deine Änderungen in das Hauptprojekt einzugliedern (merge). Gehe dann nach getaner Arbeit zu Deiner Github-Seite und erstelle eine "Pull request", um Deine Änderungen in das Hauptprojekt einzugliedern (merge).
Solltest du keine Idee haben, an welcher Stelle du einsteigen könntest.
Wir haben einige Aufgaben auf github mit dem Schlagwort *Junior Job* versehen.
Bei diesen Aufgaben gehen wir davon aus, dass sie geeignete Einstiegsstellen sind.
Du musst dich aber natürlich nicht mit diesen Aufgaben beschäftigen um den Friendica Code zu verbeesern.
**Wichtig** **Wichtig**
Bitte hole Dir alle Änderungen aus dem Projektverzeichnis und führe sie mit Deiner Arbeit zusammen, **bevor** Du Deine "pull request" erstellst. Wir behalten es uns vor, Patches abzulehnen, die eine große Anzahl an Fehlern hervorrufen. Bitte hole Dir alle Änderungen aus dem Projektverzeichnis und führe sie mit Deiner Arbeit zusammen, **bevor** Du Deine "pull request" erstellst. Wir behalten es uns vor, Patches abzulehnen, die eine große Anzahl an Fehlern hervorrufen.