mirror of
https://github.com/friendica/friendica
synced 2024-10-16 06:21:32 +02:00
Merge remote-tracking branch 'upstream/develop' into 1503-load-issues
This commit is contained in:
commit
0812b7a7ac
3
boot.php
3
boot.php
|
@ -18,7 +18,7 @@ define ( 'FRIENDICA_PLATFORM', 'Friendica');
|
|||
define ( 'FRIENDICA_CODENAME', 'Lily of the valley');
|
||||
define ( 'FRIENDICA_VERSION', '3.4.0' );
|
||||
define ( 'DFRN_PROTOCOL_VERSION', '2.23' );
|
||||
define ( 'DB_UPDATE_VERSION', 1182 );
|
||||
define ( 'DB_UPDATE_VERSION', 1184 );
|
||||
define ( 'EOL', "<br />\r\n" );
|
||||
define ( 'ATOM_TIME', 'Y-m-d\TH:i:s\Z' );
|
||||
|
||||
|
@ -1695,7 +1695,6 @@ if(! function_exists('profile_sidebar')) {
|
|||
if($a->theme['template_engine'] === 'internal')
|
||||
$location = template_escape($location);
|
||||
|
||||
|
||||
$tpl = get_markup_template('profile_vcard.tpl');
|
||||
$o .= replace_macros($tpl, array(
|
||||
'$profile' => $p,
|
||||
|
|
|
@ -1,6 +1,6 @@
|
|||
-- ------------------------------------------
|
||||
-- Friendica 3.4.0 (Ginger)
|
||||
-- DB_UPDATE_VERSION 1182
|
||||
-- Friendica 3.4.0 (Lily of the valley)
|
||||
-- DB_UPDATE_VERSION 1183
|
||||
-- ------------------------------------------
|
||||
|
||||
|
||||
|
@ -140,6 +140,7 @@ CREATE TABLE IF NOT EXISTS `contact` (
|
|||
`uri-date` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
|
||||
`avatar-date` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
|
||||
`term-date` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
|
||||
`last-item` datetime NOT NULL DEFAULT '0000-00-00 00:00:00',
|
||||
`priority` tinyint(3) NOT NULL DEFAULT 0,
|
||||
`blocked` tinyint(1) NOT NULL DEFAULT 1,
|
||||
`readonly` tinyint(1) NOT NULL DEFAULT 0,
|
||||
|
|
|
@ -3,71 +3,96 @@ Account Basics
|
|||
|
||||
* [Home](help)
|
||||
|
||||
Registration
|
||||
---
|
||||
|
||||
**Registration**
|
||||
Not all Friendica sites allow open registration.
|
||||
If registration is allowed, you will see a "Register" link immediately below the login prompt on the site home page.
|
||||
Following this link will take you to the site registration page.
|
||||
The strength of our network is that lots of different sites are all completely compatible with each other.
|
||||
If the site you're visting doesn't allow registration, or you think you might prefer another one, you can find a [list of public servers here](http://dir.friendica.com/siteinfo), and find one that meets your needs.
|
||||
|
||||
Not all Friendica sites allow open registration. If registration is allowed, you will see a "Register" link immediately below the login prompts on the site home page. Following this link will take you to the site registration page. The strength of our network is that lots of different sites are all completely compatible with each other. If the site you're visting doesn't allow registration, or you think you might prefer another one, you can find a <a href="http://dir.friendica.com/siteinfo">list of public servers here</a>, and find one that meets your needs.
|
||||
If you'd like to have your own server, you can do that too.
|
||||
Visit [the Friendica website](http://friendica.com/download) to download the code with setup instructions.
|
||||
It's a very simple installation process that anybody experienced in hosting websites, or with basic Linux experience can handle easily.
|
||||
|
||||
If you'd like to have your own server, you can do that too. Visit <a href="http://friendica.com/download">the Friendica website</a> to download the code with setup instructions. It's a very simple install process that anybody experienced in hosting websites, or with basic Linux experience can handle easily.
|
||||
###OpenID
|
||||
|
||||
The first field on the Registration page is for an OpenID address.
|
||||
If you do not have an OpenID address or do not wish to use OpenID, leave this field blank.
|
||||
If you have an OpenID account elsewhere and wish to use it, enter the address into this field and click 'Register'.
|
||||
Friendica will attempt to extract as much information as possible from your OpenID provider and return to this page with those items already filled in.
|
||||
|
||||
###Your Full Name
|
||||
|
||||
Please provide your full name **as you would like it to be displayed on this system**.
|
||||
Most people use their real name for this, but you're under no obligation to do so yourself.
|
||||
|
||||
###Email Address
|
||||
|
||||
Please provide a valid email address.
|
||||
Your email address is **never** published.
|
||||
We need this to send you account information and your login details.
|
||||
You may also occasionally receive notifications of incoming messages or items requiring your attention, but you have the possibility to completely disable these from your Settings page once you have logged in.
|
||||
This doesn't have to be your primary email address, but it does need to be a real email address.
|
||||
You can't get your initial password, or reset a lost password later without it.
|
||||
This is the only bit of personal information that has to be accurate.
|
||||
|
||||
###Nickname
|
||||
|
||||
A nickname is used to generate web addresses for many of your personal pages, and is also treated like an email address when establishing communications with others.
|
||||
Due to the way that the nickname is used, it has some limitations.
|
||||
It must contain only US-ASCII text characters and numbers, and must also start with a text character.
|
||||
It also must be unique on this system.
|
||||
This is used in many places to identify your account, and once set - cannot be changed.
|
||||
|
||||
|
||||
*OpenID*
|
||||
###Directory Publishing
|
||||
|
||||
The first field on the Registration page is for an OpenID address. If you do not have an OpenID address or do not wish to use OpenID, leave this field blank. If you have an OpenID account elsewhere and wish to use it, enter the address into this field and click 'Register'. Friendica will attempt to extract as much information as possible from your OpenID provider and return to this page with those items already filled in.
|
||||
The registration form also allows you to choose whether or not to list your account in the online directory.
|
||||
This is like a "phone book" and you may choose to be unlisted.
|
||||
We recommend that you select 'Yes' so that other people (friends, family, etc.) will be able to find you.
|
||||
If you choose 'No', you will essentially be invisible and have few opportunities for interaction.
|
||||
Whichever you choose, this can be changed any time from your Settings page after you login.
|
||||
|
||||
###Register
|
||||
|
||||
*Your Full Name*
|
||||
Once you have provided the necessary details, click the 'Register' button.
|
||||
An email will be sent to you providing your account login details.
|
||||
Please watch your email (including spam folders) for your registration details and initial password.
|
||||
|
||||
Please provide your full name **as you would like it to be displayed on this system**. Most people use their real name for this, but you're under no obligation to do so yourself.
|
||||
Login Page
|
||||
---
|
||||
|
||||
On the 'Login' page, please enter your login information that was provided during registration.
|
||||
You may use either your nickname or email address as a Login Name.
|
||||
|
||||
*Email Address*
|
||||
If you use your account to manage multiple '[Pages](help/Pages)' and these all have the same email address, please enter the nickname for the account you wish to manage.
|
||||
|
||||
Please provide a valid email address. Your email address is **never** published. We need this to send you account information and your login details. You may also occasionally receive notifications of incoming messages or items requiring your attention, but you have the ability to completely disable these from your Settings page once you have logged in. This doesn't have to be your primary email address, but it does need to be a real email address. You can't get your initial password, or reset a lost password later without it. This is the only bit of personal information that has to be accurate.
|
||||
*If* your account has been OpenID enabled, you may use your OpenID address as a login name and leave the password blank.
|
||||
You will be redirected to your OpenID provider to complete your authorisation.
|
||||
|
||||
Otherwise, enter your password.
|
||||
This will have been initially provided in your registration email message.
|
||||
Your password is case-sensitive, so please check your 'Caps Lock' key if you are having difficulty logging in.
|
||||
|
||||
*Nickname*
|
||||
|
||||
A nickname is used to generate web addresses for many of your personal pages, and is also treated like an email address when establishing communications with others. Due to the way that the nickname is used, it has some limitations. It must contain only US-ASCII text characters and numbers, and must also start with a text character. It also must be unique on this system. This is used in many places to identify your account, and once set - cannot be changed.
|
||||
|
||||
|
||||
*Directory Publishing*
|
||||
|
||||
The Registration form also allows you to choose whether or not to list your account in the online directory. This is like a "phone book" and you may choose to be unlisted. We recommend that you select 'Yes' so that other people (friends, family, etc.) will be able to find you. If you choose 'No', you will essentially be invisible and have few opportunities for interaction. Whichever you choose, this can be changed any time from your Settings page after you login.
|
||||
|
||||
|
||||
*Register*
|
||||
|
||||
Once you have provided the necessary details, click the 'Register' button. An email will be sent to you providing your account login details. Please watch your email (including spam folders) for your registration details and initial password.
|
||||
|
||||
|
||||
**Login Page**
|
||||
|
||||
On the 'Login' page, please enter your login information that was provided during registration. You may use either your nickname or email address as a Login Name.
|
||||
|
||||
If you use your account to manage multiple '[Pages](help/Pages)' and these all have the same email address, please enter the nickname for the account you wish to manage.
|
||||
|
||||
*If* your account has been OpenID enabled, you may use your OpenID address as a login name and leave the password blank. You will be redirected to your OpenID provider to complete your authorisation.
|
||||
|
||||
Otherwise, enter your password. This will have been initially provided in your registration email message. Your password is case-sensitive, so please check your 'Caps Lock' key if you are having difficulty logging in.
|
||||
|
||||
|
||||
**Changing Your Password**
|
||||
Changing Your Password
|
||||
---
|
||||
|
||||
After your first login, please visit the 'Settings' page from the top menu bar and change your password to something that you will remember.
|
||||
|
||||
|
||||
**Getting Started**
|
||||
Getting Started
|
||||
---
|
||||
|
||||
A ['Tips for New Members'](newmember) link will show up on your network and home pages for two weeks to provide some important Getting Started information.
|
||||
|
||||
Retrieving Personal Data
|
||||
---
|
||||
|
||||
**Retrieving Personal Data**
|
||||
You can export a copy of your personal data in XML format from the "Export personal data" link at the top of your settings page.
|
||||
|
||||
You can export a copy of your personal data in XML format from the "Export personal data" link at the top of your settings page.
|
||||
|
||||
|
||||
**See Also**
|
||||
See Also
|
||||
---
|
||||
|
||||
* [Profiles](help/Profiles)
|
||||
|
||||
|
|
|
@ -3,11 +3,16 @@ Bugs and Issues
|
|||
|
||||
* [Home](help)
|
||||
|
||||
If your server has a support page, you should report any bugs/issues you encounter there first.
|
||||
Reporting to your support page before reporting to the developers makes their job easier, as they don't have to deal with bug reports that might not have anything to do with them.
|
||||
This helps us get new features faster.
|
||||
|
||||
If your server has a support page, you should report any bugs/issues you encounter there first. Reporting to your support page before reporting to the developers makes their job easier, as they don't have to deal with bug reports that might not have anything to do with them, and that helps us get new features faster.
|
||||
If you're a technical user, or your site doesn't have a support page, you'll need to use the [Bug Tracker](http://bugs.friendica.com/).
|
||||
Please perform a search to see if there's already an open bug that matches yours before submitting anything.
|
||||
|
||||
If you're a technical user, or your site doesn't have a support page, you'll need to use the <a href="http://bugs.friendica.com/">Bug Tracker</a>. Please perform a search to see if there's already an open bug that matches yours before submitting anything.
|
||||
Try to provide as much information as you can about the bug, including the **full** text of any error messages or notices, and any steps required to replicate the problem in as much detail as possible.
|
||||
It's generally better to provide too much information than not enough.
|
||||
|
||||
Try to provide as much information as you can about the bug, including the **full** text of any error messages or notices, and any steps required to replicate the problem in as much detail as possible. It's generally better to provide too much information than not enough.
|
||||
See [this article](http://www.chiark.greenend.org.uk/~sgtatham/bugs.html) to learn more about submitting **good** bug reports.
|
||||
|
||||
<a href="http://www.chiark.greenend.org.uk/~sgtatham/bugs.html">See this article</a> to learn more about submitting **good** bug reports.
|
||||
And last but not least: Better report an issue you encountered even if you don't write the perfect bug report!
|
||||
|
|
59
doc/Chats.md
59
doc/Chats.md
|
@ -8,45 +8,64 @@ There are two possibilities to use a chat on your friendica site
|
|||
* IRC Chat
|
||||
* Jappix
|
||||
|
||||
##IRC-Chat Plugin
|
||||
IRC-Chat Plugin
|
||||
---
|
||||
|
||||
After activating the plugin, you can find the chat at [yoursite.com/irc](../irc). Note: you can use this chat without any login at your site so that everyone could use it.
|
||||
After activating the plugin, you can find the chat at [yoursite.com/irc](../irc).
|
||||
Note: you can use this chat without any login at your site so that everyone could use it.
|
||||
|
||||
If you follow the link, you will see the login page of the IR chat. Now choose a nickname and a chatroom. You can choose every name for the room, even something like #superchatwhosenameisonlyknownbyme. At last, solve the captchas and click the connect button.
|
||||
If you follow the link, you will see the login page of the IR chat.
|
||||
Now choose a nickname and a chatroom.
|
||||
You can choose every name for the room, even something like #superchatwhosenameisonlyknownbyme.
|
||||
At last, solve the captchas and click the connect button.
|
||||
|
||||
The following window shows some text while connecting. This text isn't importend for you, just wait for the next window. The first line shows your name and your current IP address. The right part of the window shows all user. The lower part of the window contains an input field.
|
||||
The following window shows some text while connecting.
|
||||
This text isn't importend for you, just wait for the next window.
|
||||
The first line shows your name and your current IP address.
|
||||
The right part of the window shows all users.
|
||||
The lower part of the window contains an input field.
|
||||
|
||||
##Jappix Mini
|
||||
Jappix Mini
|
||||
---
|
||||
|
||||
The Jappix Mini Plugin creates a chatbox for jabber- and XMPP-contacts. You should already have a jabber/XMPP-account before setting up the plugin. You can find more information at http://www.jabber.org/
|
||||
The Jappix Mini Plugin creates a chatbox for jabber- and XMPP-contacts.
|
||||
You should already have a jabber/XMPP-account before setting up the plugin.
|
||||
You can find more information at [jabber.org](http://www.jabber.org/).
|
||||
|
||||
You can use several server to create an account:
|
||||
You can use several servers to create an account:
|
||||
|
||||
* [https://jappix.com](https://jappix.com)
|
||||
* [http://xmpp.net](http://xmpp.net)
|
||||
|
||||
**1. Basics**
|
||||
###1. Basics
|
||||
|
||||
At first you have to get the current version (via github):
|
||||
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 as a normal download via: 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“).
|
||||
|
||||
Just unpack the file and rename the directory to „jappixmini“. Next, upload this directory and the .tgz-file into your addon directory of your friendica installation.
|
||||
Just unpack the file and rename the directory to „jappixmini“.
|
||||
Next, upload this directory and the .tgz-file into your addon directory of your friendica installation.
|
||||
|
||||
Now you can activate the plugin at the admin pages. Now you can find an entry of jappix at the plugin sidebar (where you can also find twitter, statusnet and other ones). The following page shows the settings of this plugin.
|
||||
Now you can activate the plugin globally on the admin pages.
|
||||
In the plugin sidebar, you will find an entry of jappix now (where you can also find twitter, statusnet and others).
|
||||
The following page shows the settings of this plugin.
|
||||
|
||||
Now you can activate the BOSH proxy.
|
||||
Next, go to the setting page of your account.
|
||||
Activate the BOSH proxy.
|
||||
|
||||
**2. Settings**
|
||||
###2. Settings
|
||||
|
||||
Go to the account settings and choose the plugin page. Scroll down until you find the Jappix Mini addon settings
|
||||
Go to your user account settings next and choose the plugin page.
|
||||
Scroll down until you find the Jappix Mini addon settings.
|
||||
|
||||
At first you have to activate the addon.
|
||||
|
||||
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/". 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). Finish these steps with "send" to save the entries. Now, you should find the chatbox at the lower right corner of your browser window.
|
||||
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/".
|
||||
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).
|
||||
Finish these steps with "send" to save the entries.
|
||||
Now, you should find the chatbox at the lower right corner of your browser window.
|
||||
|
||||
If you want to add contacts manually, you can click "add contact".
|
||||
If you want to add contacts manually, you can click "add contact".
|
||||
|
|
|
@ -3,7 +3,9 @@ Connectors
|
|||
|
||||
* [Home](help)
|
||||
|
||||
Connectors allow you to connect with external social networks and services. Connectors are only required for posting to existing accounts on Facebook, Twitter, and StatusNet. There is also a connector for accessing your email INBOX.
|
||||
Connectors allow you to connect with external social networks and services.
|
||||
They are only required for posting to existing accounts on Facebook, Twitter, and StatusNet.
|
||||
There is also a connector for accessing your email INBOX.
|
||||
|
||||
If the following network connectors are installed on your system, select the following links to visit the appropriate settings page and configure them for your account:
|
||||
|
||||
|
@ -15,53 +17,75 @@ If the following network connectors are installed on your system, select the fol
|
|||
Instructions For Connecting To People On Specific Services
|
||||
==========================================================
|
||||
|
||||
**Friendica**
|
||||
Friendica
|
||||
---
|
||||
|
||||
You can either connect to others by providing your Identity Address on the 'Connect' page of any Friendica member.
|
||||
Or you can put their Identity Address into the Connect box on your [Contacts](contacts) page.
|
||||
|
||||
|
||||
You may connect by providing your Identity Address on the 'Connect' page of any Friendica member. You may also put their Identity Address into the Connect box on your [Contacts](contacts) page.
|
||||
|
||||
|
||||
**Diaspora**
|
||||
Diaspora
|
||||
---
|
||||
|
||||
Add the Diaspora 'handle' to the 'Connect/Follow' text box on your [Contacts](contacts) page.
|
||||
|
||||
|
||||
**Identi.ca/StatusNet/GNU-Social**
|
||||
Identi.ca/StatusNet/GNU-Social
|
||||
---
|
||||
|
||||
These are described as the "federated social web" or OStatus contacts.
|
||||
|
||||
Please note that there are **no** privacy provisions on the OStatus network. Any message which is delivered to **any** OStatus member is visible to anybody in the world and will negate any privacy settings that you have in effect. These messages will also turn up in public searches.
|
||||
Please note that there are **no** privacy provisions on the OStatus network.
|
||||
Any message which is delivered to **any** OStatus member is visible to anybody in the world and will negate any privacy settings that you have in effect.
|
||||
These messages will also turn up in public searches.
|
||||
|
||||
Since OStatus communications do not use authentication, if you select the profile privacy option to hide your profile and messages from unknown viewers, OStatus members will **not** be able to receive your communications.
|
||||
|
||||
To connect with an OStatus member insert their profile URL or Identity address into the Connect box on your [Contacts](contacts) page.
|
||||
|
||||
The StatusNet connector may be used if you wish posts to appear on an OStatus site using an existing OStatus account.
|
||||
|
||||
It is not necessary to do this, as you may 'follow' OStatus members from Friendica and they may follow you (by placing their own Identity Address into your 'Connect' page).
|
||||
|
||||
**Blogger, Wordpress, RSS feeds, arbitrary web pages**
|
||||
Blogger, Wordpress, RSS feeds, arbitrary web pages
|
||||
---
|
||||
|
||||
Put the URL into the Connect box on your [Contacts](contacts) page. You will not be able to reply to these contacts.
|
||||
Put the URL into the Connect box on your [Contacts](contacts) page.
|
||||
PLease note that you will not be able to reply to these contacts.
|
||||
|
||||
This will allow you to _connect_ with millions of pages on the internet. All that we require to do this is that the page use a discoverable feed using either the RSS or Atom syndication format, and which provides an author name and a site image in a form which we can extract.
|
||||
This feed reader feature will allow you to _connect_ with millions of pages on the internet.
|
||||
All that the pages need to have is a discoverable feed using either the RSS or Atom syndication format, and which provides an author name and a site image in a form which we can extract.
|
||||
|
||||
Twitter
|
||||
---
|
||||
|
||||
**Twitter**
|
||||
To follow a Twitter member, put the URL of the Twitter member's main page into the Connect box on your [Contacts](contacts) page.
|
||||
To reply, you must have the Twitter connector installed, and reply using your own status editor.
|
||||
Begin the message with @twitterperson replacing with the Twitter username.
|
||||
|
||||
To follow a Twitter member, put the URL of the Twitter member's main page into the Connect box on your [Contacts](contacts) page. To reply, you must have the Twitter connector installed, and reply using your own status editor. Begin the message with @twitterperson replacing with the Twitter username.
|
||||
Email
|
||||
---
|
||||
|
||||
**Email**
|
||||
Configure the email connector from your [Settings](settings) page.
|
||||
Once this has been done, you may enter an email address to connect with using the Connect box on your [Contacts](contacts) page.
|
||||
They must be the sender of a message which is currently in your INBOX for the connection to succeed.
|
||||
You may include email contacts in private conversations.
|
||||
|
||||
Configure the email connector from your [Settings](settings) page. Once this has been done, you may enter an email addres to connect with using the Connect box on your [Contacts](contacts) page. They must be the sender of a message which is currently in your INBOX for the connect to succeed. You may include email contacts in private conversations.
|
||||
Facebook
|
||||
---
|
||||
|
||||
**Facebook**
|
||||
The Facebook connector is a plugin/addon which allows you to interact with friends on Facebook from within Friendica.
|
||||
If enabled, your Facebook friend list will be imported, and you will see and be able to respond to Facebook posts.
|
||||
Facebook members may also be added to private conversation groups.
|
||||
You will not be able to connect with individual Facebook accounts - but will have your entire friend list imported and updated if new friends are added.
|
||||
|
||||
The Facebook connector is a plugin/addon which allows you to interact with friends on Facebook from within Friendica. If enabled, your Facebook friend list will be imported, and you will see and be able to respond to Facebook posts. Facebook members may also be added to private conversation groups. You will not be able to connect with individual Facebook accounts - but will have your entire friend list imported and updated if new friends are added.
|
||||
Assuming the Facebook plugin/addon has been installed on your system, it can be enabled by going to your [Plugin Settings](settings/addon) page, and then selecting "Facebook Connector Settings" on that page.
|
||||
This will only appear if the Facebook plugin/addon has been installed.
|
||||
Follow the instruction to install or remove the Facebook connector.
|
||||
|
||||
Assuming the Facebook plugin/addon has been installed on your system, it can be enabled by going to your [Plugin Settings](settings/addon) page, and then select "Facebook Connector Settings" on that page. This will only appear if the Facebook plugin/addon has been installed. Follow the instruction to install or remove the Facebook connector.
|
||||
|
||||
You may also choose whether your public postings are posted to Facebook by default. You may toggle this setting at any time from the Permissions settings of the status post editor (click the lock icon). This setting has no effect on private conversations - which will always be delivered to Facebook friends who are included in the permissions.
|
||||
|
||||
(Note: At this time, Facebook contacts will not be able to view any private photos. This will be resolved in a future release. Facebook contacts may however see any public photos you have uploaded.)
|
||||
You may also choose whether your public postings are posted to Facebook by default.
|
||||
You may toggle this setting at any time from the Permissions settings of the status post editor (click the lock icon).
|
||||
This setting has no effect on private conversations - which will always be delivered to Facebook friends who are included in the permissions.
|
||||
|
||||
(Note: At this time, Facebook contacts will not be able to view any private photos.
|
||||
This will be resolved in a future release.
|
||||
Facebook contacts may however see any public photos you have uploaded.)
|
||||
|
|
|
@ -3,47 +3,76 @@ Where to get started to help improve Friendica?
|
|||
|
||||
* [Home](help)
|
||||
|
||||
Do you want to help us improve Friendica? Here we have compiled some hints on how to get started and some tasks to help you choose. A project like Friendica is the sum of many different contributions. **Very different skills are required to make good software. Some of them involve coding, others do not.** We are looking for helpers in all areas, whether you write text or code, whether you spread the word to convince people or design new icons. Whether you feel like an expert or like a newbie - join us with your ideas!
|
||||
Do you want to help us improve Friendica?
|
||||
Here we have compiled some hints on how to get started and some tasks to help you choose.
|
||||
A project like Friendica is the sum of many different contributions.
|
||||
**Very different skills are required to make good software.
|
||||
Some of them involve coding, others do not.**
|
||||
We are looking for helpers in all areas, whether you write text or code, whether you spread the word to convince people or design new icons.
|
||||
Whether you feel like an expert or like a newbie - join us with your ideas!
|
||||
|
||||
**Contact us**
|
||||
Contact us
|
||||
---
|
||||
|
||||
The discussion of Friendica development takes place in the following Friendica forums:
|
||||
|
||||
* The main [forum for Friendica development](https://friendika.openmindspace.org/profile/friendicadevelopers)
|
||||
* The [forum for Friendica theme development](https://friendica.eu/profile/ftdevs)
|
||||
|
||||
**Help other users**
|
||||
Help other users
|
||||
---
|
||||
|
||||
Remember the questions you had when you first tried Friendica? A good place to start can be to help new people find their way around Friendica in the [general support forum](https://helpers.pyxis.uberspace.de/profile/helpers). Welcome them, answer their questions, point them to documentation or ping other helpers directly if you can't help but think you know who can.
|
||||
Remember the questions you had when you first tried Friendica?
|
||||
A good place to start can be to help new people find their way around Friendica in the [general support forum](https://helpers.pyxis.uberspace.de/profile/helpers).
|
||||
Welcome them, answer their questions, point them to documentation or ping other helpers directly if you can't help but think you know who can.
|
||||
|
||||
**Translations**
|
||||
Translation
|
||||
---
|
||||
|
||||
The documentation contains help on how to translate Friendica in the [at Transifex](/help/translations) where the UI is translated.
|
||||
If you don't want to translate the UI, or it is already done to your satisfaction, you might want to work on the translation of the /help files?
|
||||
|
||||
**Design**
|
||||
Design
|
||||
---
|
||||
|
||||
Are you good at designing things? If you have seen Friendica you probably have ideas to improve it, haven't you?
|
||||
Are you good at designing things?
|
||||
If you have seen Friendica you probably have ideas to improve it, haven't you?
|
||||
|
||||
* If you would like to work with us on enhancing the user interface, please join the [UX Watchdogs forum](https://fc.oscp.info/profile/ux-watchdogs)
|
||||
* Make plans for a better Friendica interface design and share them with us.
|
||||
* Tell us if you are able to realize your ideas or what kind of help you need. We can't promise we have the right skills in the group but we'll try.
|
||||
* Tell us if you are able to realize your ideas or what kind of help you need.
|
||||
We can't promise we have the right skills in the group but we'll try.
|
||||
* Choose a thing to start with, e.g. work on the icon set of your favourite theme
|
||||
|
||||
**Programming**
|
||||
Programming
|
||||
---
|
||||
|
||||
* **Issues:** Have a look at our [issue tracker](https://github.com/friendica/friendica) on gihub!
|
||||
* 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.
|
||||
* Fix a bug if you can. Please make the pull request against the *develop* branch of the repository.
|
||||
###Issues
|
||||
|
||||
* **Web interface:** The thing many people want most is a better interface, preferably a responsive Friendica theme. This is a piece of work! If you want to get involved here:
|
||||
* Look at the first steps that were made (e.g. the clean theme). Ask us to find out whom to talk to about their experiences.
|
||||
* Talk to design people if you know any.
|
||||
* Let us know about your plans [in the dev forum](https://friendika.openmindspace.org/profile/friendicadevelopers) and the [theme developer forum](https://friendica.eu/profile/ftdevs). Do not worry about cross-posting.
|
||||
Have a look at our [issue tracker](https://github.com/friendica/friendica) on github!
|
||||
|
||||
* **Client software:** There are free software clients that do somehow work with Friendica but most of them need love and maintenance. Also, they were mostly made for other platforms using the StatusNet API. This means they lack:w
|
||||
the features that are really specific to Friendica. Popular clients you might want to have a look at are:
|
||||
* [Hotot (Linux)](http://hotot.org/) - abandoned
|
||||
* [Friendica for Android](https://github.com/max-weller/friendica-for-android) - abandoned
|
||||
* You can find more working client software in [Wikipedia](https://en.wikipedia.org/wiki/Friendica).
|
||||
* 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.
|
||||
* Fix a bug if you can. Please make the pull request against the *develop* branch of the repository.
|
||||
|
||||
###Web interface
|
||||
|
||||
The thing many people want most is a better interface, preferably a responsive Friendica theme.
|
||||
This is a piece of work!
|
||||
If you want to get involved here:
|
||||
|
||||
* Look at the first steps that were made (e.g. the clean theme).
|
||||
Ask us to find out whom to talk to about their experiences.
|
||||
* Talk to design people if you know any.
|
||||
* Let us know about your plans [in the dev forum](https://friendika.openmindspace.org/profile/friendicadevelopers) and the [theme developer forum](https://friendica.eu/profile/ftdevs).
|
||||
Do not worry about cross-posting.
|
||||
|
||||
###Client software
|
||||
There are free software clients that do somehow work with Friendica but most of them need love and maintenance.
|
||||
Also, they were mostly made for other platforms using the StatusNet API.
|
||||
This means they lack the features that are really specific to Friendica.
|
||||
Popular clients you might want to have a look at are:
|
||||
|
||||
* [Hotot (Linux)](http://hotot.org/) - abandoned
|
||||
* [Friendica for Android](https://github.com/max-weller/friendica-for-android) - abandoned
|
||||
* You can find more working client software in [Wikipedia](https://en.wikipedia.org/wiki/Friendica).
|
||||
|
|
123
doc/FAQ.md
123
doc/FAQ.md
|
@ -25,92 +25,109 @@ User
|
|||
*****
|
||||
<a name="ssl"></a>
|
||||
|
||||
**Why do I getting warnings about certificates?**
|
||||
###Why do I get warnings about SSL certificates?
|
||||
|
||||
Sometimes you get a browser warning about a missing certificate. These warnings can have three reasons:
|
||||
SSL (Secure Socket Layer) is a technology to encrypt data transfer between computers.
|
||||
Sometimes your browser warns you about a missing or invalid certificate.
|
||||
These warnings can have three reasons:
|
||||
|
||||
1. the server you are connected to doesn't have SSL;
|
||||
1. The server you are connected to doesn't offer SSL encryption.
|
||||
2. The server has a self-signed certificate (not recommended).
|
||||
3. The certificate is expired.
|
||||
|
||||
2. the server has a self-signed certificate (not recommended)
|
||||
|
||||
3. the certificate is expired.
|
||||
|
||||
*(SSL (Secure Socket Layer) is a technology to encrypt data as it passes between two computers).*
|
||||
|
||||
If you dont have a SSL cert yet, there are three ways to get one: buy one, get a free one (eg. via StartSSL) or create your own (not recommended). [You can find more information about setting up SSL and why it's a bad idea to use self-signed SSL here.](help/SSL)
|
||||
|
||||
Be aware that a browser warning about security issues is something that can make new users feel insecure about the whole friendica project.
|
||||
|
||||
Also you can have problems with the connection to diaspora because some pods require a SSL-certificated connection.
|
||||
|
||||
If you are just using friendica for a specified group of people on a single server without a connection to the rest of the friendica network, there is no need to use SSL. If you exclusively use public posts, there is also no need for it.
|
||||
|
||||
If you havn't set up a server yet, it's wise to compare the different provider and their SSL conditions. Some allow the usage of free certificates or give you the access to their certificate for free. Other ones only allow bought certificates from themselves or other providers.
|
||||
We recommend to talk to the admin(s) of the affected friendica server. (Admins, please see the respective section of the [admin manual](help/SSL).)
|
||||
|
||||
<a name="upload"></a>
|
||||
|
||||
**How can I upload images, files, links, videos and sound files to posts?**
|
||||
###How can I upload images, files, links, videos and sound files to posts?
|
||||
|
||||
You can upload images from your computer by using the [editor](help/Text_editor). An overview of all uploaded images is listed at <i>yourpage.com/photos/profilename</i>. There you could also upload images directly and choose, if your contacts shall receive a message about this upload.
|
||||
You can upload images from your computer by using the [editor](help/Text_editor).
|
||||
An overview of all uploaded images is listed at *yourpage.com/photos/profilename*.
|
||||
On that page, you can also upload images directly and choose, if your contacts shall receive a message about this upload.
|
||||
|
||||
Generally, you could attach every kind of file to a post. This is possible by using the "paper-clip"-symbol at the editor. These files will be linked to your post and can be downloaded by your contacts. But it's not possible to get a preview for these ones. Because of this, this upload method is recommended for office or zipped files.
|
||||
If you want to use Dropbox, owncloud at your own server or any other [filehoster](http://en.wikipedia.org/wiki/Comparison_of_file_hosting_services), you'll have use the "link"-button (chain-symbol).
|
||||
Generally, you could attach every kind of file to a post.
|
||||
This is possible by using the "paper-clip"-symbol in the editor.
|
||||
These files will be linked to your post and can be downloaded by your contacts.
|
||||
But it's not possible to get a preview for these ones.
|
||||
Because of this, this upload method is recommended for office or zipped files.
|
||||
If you want share content from Dropbox, Owncloud or any other [filehoster](http://en.wikipedia.org/wiki/Comparison_of_file_hosting_services), use the "link"-button (chain-symbol).
|
||||
|
||||
When you're adding URLs of other webpages with the "link"-button, Friendica tries to create a small preview. If this doesn't work, try to add the link by typing: [url=http://example.com]<i>self-chosen name</i>[/url].
|
||||
When you're adding URLs of other webpages with the "link"-button, Friendica tries to create a small preview.
|
||||
If this doesn't work, try to add the link by typing: [url=http://example.com]*self-chosen name*[/url].
|
||||
|
||||
You can also add video and audio files to posts. But instead of a direct upload you have to use one of the following methods:
|
||||
You can also add video and audio files to posts.
|
||||
But instead of a direct upload you have to use one of the following methods:
|
||||
|
||||
1. Add the video or audio link of a hoster (Youtube, Vimeo, Soundcloud and everyone else with oembed/opengraph-support). Videos will be shown with a preview image you can click on to start it. SoundCloud directly inserts a player to your post.
|
||||
|
||||
2. If you have an own server, you can upload your multimedia files via FTP and insert the URL. Your video or sound file will be shown with their own player at your post.
|
||||
2. If you have your own server, you can upload multimedia files via FTP and insert the URL.
|
||||
|
||||
Friendica is using HTML5 for embedding content. Therefore, the supported files are depending on your browser and operating system (OS). Some filetypes are WebM, MP4, MP3 and OGG. There are more examples at wikipedia ([video](http://en.wikipedia.org/wiki/HTML5_video), [audio](http://en.wikipedia.org/wiki/HTML5_audio)).
|
||||
Friendica is using HTML5 for embedding content.
|
||||
Therefore, the supported files are depending on your browser and operating system.
|
||||
Some supported filetypes are WebM, MP4, MP3 and OGG.
|
||||
See Wikipedia for more of them ([video](http://en.wikipedia.org/wiki/HTML5_video), [audio](http://en.wikipedia.org/wiki/HTML5_audio)).
|
||||
|
||||
<a name="avatars"></a>
|
||||
|
||||
**Is it possible to have different avatars per profile?**
|
||||
###Is it possible to have different avatars per profile?
|
||||
|
||||
Yes. On your Edit/Manage Profiles page, you will find a "change profile photo" link. Clicking this will take you to a page where you can upload a photograph and select which profile it will be associated with. To avoid privacy leakage, we only display the photograph associated with your default profile as the avatar in your posts.
|
||||
Yes. On your Edit/Manage Profiles page, you will find a "change profile photo" link.
|
||||
Clicking this will take you to a page where you can upload a photograph and select which profile it will be associated with.
|
||||
To avoid privacy leakage, we only display the photograph associated with your default profile as the avatar in your posts.
|
||||
|
||||
<a name="contacts"></a>
|
||||
|
||||
**What is the difference between blocked|ignored|archived|hidden contacts?**
|
||||
###What is the difference between blocked|ignored|archived|hidden contacts?
|
||||
|
||||
We prevent direct communication with blocked contacts. They are not included in delivery, and their own posts to you are not imported; however their conversations with your friends will still be visible in your stream. If you remove a contact completely, they can send you another friend request. Blocked contacts cannot do this. They cannot communicate with you directly, only through friends.
|
||||
We prevent direct communication with **blocked contacts**.
|
||||
They are not included in delivery, and their own posts to you are not imported.
|
||||
However their conversations with your friends will still be visible in your stream.
|
||||
If you remove a contact completely, they can send you another friend request.
|
||||
Blocked contacts cannot do this. They cannot communicate with you directly, only through friends.
|
||||
|
||||
Ignored contacts are included in delivery - they will receive your posts. However we do not import their posts to you. Like blocking, you will still see this person's comments to posts made by your friends.
|
||||
**Ignored contacts** are included in delivery - they will receive your posts.
|
||||
However we do not import their posts to you.
|
||||
Like blocking, you will still see this person's comments to posts made by your friends.
|
||||
|
||||
[A plugin called "blockem" can be installed to collapse/hide all posts from a particular person in your stream if you desire complete blocking of an individual, including his/her conversations with your other friends.]
|
||||
A plugin called "blockem" can be installed to collapse/hide all posts from a particular person in your stream if you desire complete blocking of an individual, including his/her conversations with your other friends.
|
||||
|
||||
An archived contact means that communication is not possible and will not be attempted (perhaps the person moved to a new site and removed the old profile); however unlike blocking, existing posts this person made before being archived will be visible in your stream.
|
||||
An **archived contact** means that communication is not possible and will not be attempted.
|
||||
(Perhaps the person moved to a new site and removed the old profile.)
|
||||
However unlike blocking, existing posts this person made before being archived will be visible in your stream.
|
||||
|
||||
A hidden contact will not be displayed in any "friend list" (except to you). However a hidden contact will appear normally in conversations and this may expose his/her hidden status to anybody who can see the conversation.
|
||||
A **hidden contact** will not be displayed in any "friend list" (except to you).
|
||||
However a hidden contact will appear normally in conversations and this may expose his/her hidden status to anybody who can see the conversation.
|
||||
|
||||
<a name="removed"></a>
|
||||
|
||||
**What happens when an account is removed? Is it truly deleted?**
|
||||
###What happens when an account is removed? Is it truly deleted?
|
||||
|
||||
If you delete your account, we will immediately remove all your content on your server, and then issue requests to all your contacts to remove you. This will also remove you from the global directory. Doing this requires that your account and profile still be "partially" available for up to 24 hours in order to establish contact with all your friends. We can block it in several ways so that it appears empty and all profile information erased, but will then wait for 24 hours (or after all of your contacts have been notified) before we can physically remove it.
|
||||
If you delete your account, we will immediately remove all your content on **your** server.
|
||||
|
||||
Then Friendica issues requests to all your contacts to remove you.
|
||||
This will also remove you from the global directory.
|
||||
Doing this requires your account and profile still to be "partially" available for up to 24 hours in order to establish contact with all your friends.
|
||||
We can block it in several ways so that it appears empty and all profile information erased, but will then wait for 24 hours (or after all of your contacts have been notified) before we can physically remove it.
|
||||
|
||||
After that, your account is deleted.
|
||||
|
||||
<a name="hashtag"></a>
|
||||
|
||||
**Can I follow a hashtag?**
|
||||
###Can I follow a hashtag?
|
||||
|
||||
No. The act of 'following' a hashtags is an interesting technology, but presents a few issues.
|
||||
|
||||
1.) Posts which have to be copied to all sites on the network that are "listening" to that tag, which increases the storage demands to the detriment of small sites, and making the use of shared hosting practically impossible, and
|
||||
1. Posts would have to be copied to all sites on the network that are "listening" to that hashtag. This would increase the storage demands to the detriment of small sites. It would make the use of shared hosting practically impossible.
|
||||
|
||||
2.) Making spam easy (tag spam is quite a serious issue on identi.ca for instance)
|
||||
2. Making spam easy (tag spam is quite a serious issue on identi.ca for instance)
|
||||
|
||||
but mostly
|
||||
|
||||
3.) It creates a natural bias towards large sites which hold more tagged content - if your network uses tagging instead of other conversation federation mechanisms such as groups/forums.
|
||||
3. It creates a natural bias towards large sites which hold more tagged content - if your network uses tagging instead of other conversation federation mechanisms such as groups/forums.
|
||||
|
||||
Instead, we offer other mechanisms for wide-area conversations while retaining a 'level playing ground' for both large and small sites, such as forums and community pages and shared tags.
|
||||
|
||||
<a name="rss"></a>
|
||||
|
||||
**How to create a RSS feed of the stream?**
|
||||
###How to create a RSS feed of the stream?
|
||||
|
||||
If you want to share your public page via rss you can use one of the following links:
|
||||
|
||||
|
@ -132,9 +149,10 @@ RSS feed of the conversations at your site
|
|||
|
||||
<a name="clients"></a>
|
||||
|
||||
**Are there any clients for friendica I can use?**
|
||||
###Are there any clients for friendica I can use?
|
||||
|
||||
Friendica is using a [Twitter/StatusNet compatible API](help/api), which means you can use any Twitter/StatusNet/GNU Social client for your plattform as long as you can change the API path in its settings. Here is a list of known working clients
|
||||
Friendica is using a [Twitter/StatusNet compatible API](help/api), which means you can use any Twitter/StatusNet/GNU Social client for your plattform as long as you can change the API path in its settings.
|
||||
Here is a list of known working clients:
|
||||
|
||||
* Android
|
||||
* Friendica Client for Android
|
||||
|
@ -153,9 +171,11 @@ Depending on the features of the client you might encounter some glitches in usa
|
|||
|
||||
<a name="help"></a>
|
||||
|
||||
**Where I can find help?**
|
||||
###Where I can find help?
|
||||
|
||||
If you have problems with your Friendica page, you can ask the community at the [Friendica Support Group](https://helpers.pyxis.uberspace.de/profile/helpers). If you can't use your default profile you can either use a test account [test server](http://friendica.com/node/31) respectively an account at a public site [list](http://dir.friendica.com/siteinfo) or you can use the Librelist mailing list. If you want to use the mailing list, please just send a mail to friendica AT librelist DOT com.
|
||||
If you have problems with your Friendica page, you can ask the community at the [Friendica Support Group](https://helpers.pyxis.uberspace.de/profile/helpers).
|
||||
If you can't use your default profile you can either use a test account [test server](http://friendica.com/node/31) respectively an account at a public site [list](http://dir.friendica.com/siteinfo) or you can use the Librelist mailing list.
|
||||
If you want to use the mailing list, please just send a mail to friendica AT librelist DOT com.
|
||||
|
||||
If you are a theme developer, you will find help at this forum: [Friendica Theme Developers](https://friendica.eu/profile/ftdevs).
|
||||
|
||||
|
@ -164,15 +184,16 @@ Admin
|
|||
*****
|
||||
<a name="multiple"></a>
|
||||
|
||||
**Can I configure multiple domains with the same code instance?**
|
||||
###Can I configure multiple domains with the same code instance?
|
||||
|
||||
This function is not supported anymore starting from Friendica 3.3
|
||||
No, this function is not supported anymore starting from Friendica 3.3.
|
||||
|
||||
<a name="sources"></a>
|
||||
|
||||
**Where can I find the source code of friendica, addons and themes?**
|
||||
###Where can I find the source code of friendica, addons and themes?
|
||||
|
||||
You can find the main respository [here](https://github.com/friendica/friendica). There you will always find the current stable version of friendica.
|
||||
You can find the main respository [here](https://github.com/friendica/friendica).
|
||||
There you will always find the current stable version of friendica.
|
||||
|
||||
Addons are listed at [this page](https://github.com/friendica/friendica-addons).
|
||||
|
||||
|
|
|
@ -6,31 +6,56 @@ Forums
|
|||
|
||||
Friendica also lets you create forums and/or celebrity accounts.
|
||||
|
||||
Every page in Friendica has a nickname and these must all be unique. This applies to all forums, whether they are normal profiles or forum profiles.
|
||||
Every page in Friendica has a nickname and these must all be unique.
|
||||
This applies to all forums, whether they are normal profiles or forum profiles.
|
||||
|
||||
Therefore the first thing you need to do to create a new forum is to register a new account for the forum. Please note that the site administrator can restrict and/or regulate the registration of new accounts.
|
||||
Therefore the first thing you need to do to create a new forum is to register a new account for the forum.
|
||||
Please note that the site administrator can restrict and/or regulate the registration of new accounts.
|
||||
|
||||
If you create a second account on a system and use the same email address or OpenID account as an existing account, you will no longer be able to use the email address (or OpenID) to login to the account. You should login using the account nickname instead.
|
||||
If you create a second account on a system and use the same email address or OpenID account as an existing account, you will no longer be able to use the email address (or OpenID) to log in to the account.
|
||||
You should log in using the account nickname instead.
|
||||
|
||||
On the new account, visit the 'Settings' page. Towards the end of the page are "Advanced Account/Page Type Settings". Typically you would use "Normal Account" for a normal personal account. This is the default selection. Community Forum/Celebrity Accounts provide the ability for people to become friends/fans of the forum without requiring approval.
|
||||
On the new account, visit the 'Settings' page.
|
||||
Towards the end of the page are "Advanced Account/Page Type Settings".
|
||||
Typically you would use "Normal Account" for a normal personal account.
|
||||
This is the default selection.
|
||||
Community Forum/Celebrity Accounts provide the ability for people to become friends/fans of the forum without requiring approval.
|
||||
|
||||
The exact setting you would use depends on how you wish to interact with people who join the page. The "Soapbox" setting let's the page owner control all communications. Everything you post will go out to the forum members, but there will be no opportunity for interaction. This setting would typically be used for announcements or corporate communications.
|
||||
The exact setting you would use depends on how you wish to interact with people who join the page.
|
||||
The "Soapbox" setting let's the page owner control all communications.
|
||||
Everything you post will go out to the forum members, but there will be no opportunity for interaction.
|
||||
This setting would typically be used for announcements or corporate communications.
|
||||
|
||||
The most common setting is the "Community Forum". This creates a forum page where all members can freely interact.
|
||||
The most common setting is the "Community Forum".
|
||||
This creates a forum page where all members can freely interact.
|
||||
|
||||
The "Automatic Friend Account" is typically used for personal profile forums where you wish to automatically approve any friendship/connection requests.
|
||||
|
||||
**Managing Multiple forums**
|
||||
Managing Multiple forums
|
||||
---
|
||||
|
||||
We recommend that you create group forums with the same email address and password as your normal account. If you do this, you will find a new "Manage" tab on the menu bar which lets you toggle identities easily and manage your forums. You are not required to do this, but the alternative is to logout and log back into the other account to manage alternate forums - and this could get cumbersome if you manage several different forums/identities.
|
||||
We recommend that you create group forums with the same email address and password as your normal account.
|
||||
If you do this, you will find a new "Manage" tab on the menu bar which lets you toggle identities easily and manage your forums.
|
||||
You are not required to do this, but the alternative is to log out and log back into the other account to manage alternate forums.
|
||||
This could get cumbersome if you manage several different forums/identities.
|
||||
|
||||
You may also appoint a delegate to manage your forum. Do this by visiting the [Delegation Setup Page](delegate). This will provide you with a list of contacts on this system under "Potential Delegates". Selecting one or more persons will give them access to manage your forum. They will be able to edit contacts, profiles, and all content for this account/page. Please use this facility wisely. Delegated managers will not be able to alter basic account settings such as passwords or page types and/or remove the account.
|
||||
You may also appoint a delegate to manage your forum.
|
||||
Do this by visiting the [Delegation Setup Page](delegate).
|
||||
This will provide you with a list of contacts on this system under "Potential Delegates".
|
||||
Selecting one or more persons will give them access to manage your forum.
|
||||
They will be able to edit contacts, profiles, and all content for this account/page.
|
||||
Please use this facility wisely.
|
||||
Delegated managers will not be able to alter basic account settings such as passwords or page types and/or remove the account.
|
||||
|
||||
|
||||
**Posting to Community forums**
|
||||
Posting to Community forums
|
||||
---
|
||||
|
||||
If you are a member of a community forum, you may post to the forum by including an @-tag in the post mentioning the forum. For example @bicycle would send my post to all members of the group "bicycle" in addition to the normal recipients. If your post is private you must also explicitly include the group in the post permissions (to allow the forum "contact" to see the post) **and** mention it in a tag (which redistributes the post to the forum members).
|
||||
If you are a member of a community forum, you may post to the forum by including an @-tag in the post mentioning the forum.
|
||||
For example @bicycle would send my post to all members of the group "bicycle" in addition to the normal recipients.
|
||||
If your post is private you must also explicitly include the group in the post permissions (to allow the forum "contact" to see the post) **and** mention it in a tag (which redistributes the post to the forum members).
|
||||
|
||||
You may also post to a community forum by posting a "wall-to-wall" post using secure cross-site authentication.
|
||||
|
||||
Comments which are relayed to community forums will be relayed back to the original post creator. Mentioning the forum with an @-tag in a comment does not relay the message, as distribution is controlled entirely by the original post creator.
|
||||
Comments which are relayed to community forums will be relayed back to the original post creator.
|
||||
Mentioning the forum with an @-tag in a comment does not relay the message, as distribution is controlled entirely by the original post creator.
|
||||
|
|
|
@ -3,26 +3,68 @@ Friendica on Github
|
|||
|
||||
* [Home](help)
|
||||
|
||||
**Here is how you can work on the code with us**
|
||||
Here is how you can work on the code with us. If you have any questions please write to the Friendica developers' forum.
|
||||
|
||||
Introduction to the workflow with our Github repository
|
||||
-------------------------------------------------------
|
||||
|
||||
1. Install git on the system you will be developing on.
|
||||
2. Create your own [github](https://github.com) account.
|
||||
3. Fork the Friendica repository from [https://github.com/friendica/friendica.git](https://github.com/friendica/friendica.git).
|
||||
4. Clone your fork from your Github account to your machine. Follow the instructions provided here: [http://help.github.com/fork-a-repo/](http://help.github.com/fork-a-repo/) to create and use your own tracking fork on github
|
||||
5. Commit your changes to your fork. Then go to your github page and create a "Pull request" to notify us to merge your work.
|
||||
4. Clone your fork from your Github account to your machine.
|
||||
Follow the instructions provided here: [http://help.github.com/fork-a-repo/](http://help.github.com/fork-a-repo/) to create and use your own tracking fork on github
|
||||
5. Commit your changes to your fork.
|
||||
Then go to your github page and create a "Pull request" to notify us to merge your work.
|
||||
|
||||
**Branches**
|
||||
Our Git Branches
|
||||
----------------
|
||||
|
||||
There are two branches in the main repo on Github:
|
||||
There are two relevant branches in the main repo on Github:
|
||||
|
||||
1. master: This branch contains stable releases only.
|
||||
2. develop: This branch contains the latest code. This is what you want to work with.
|
||||
2. develop: This branch contains the latest code.
|
||||
This is what you want to work with.
|
||||
|
||||
**Important**
|
||||
Fast-forwarding
|
||||
---------------
|
||||
|
||||
Please pull in any changes from the project repository and merge them with your work **before** issuing a pull request. We reserve the right to reject any patch which results in a large number of merge conflicts. This is especially true in the case of language translations - where we may not be able to understand the subtle differences between conflicting versions.
|
||||
Fast forwarding is enabled by default in git.
|
||||
When you merge with fast-forwarding it does not add a new commit to mark when you've performed the merge and how.
|
||||
This means in your commit history you can't know exactly what happened in terms of merges.
|
||||
**It's best to turn off fast-forwarding.**
|
||||
This is done by running "git merge --no-ff".
|
||||
[Here](https://stackoverflow.com/questions/5519007/how-do-i-make-git-merges-default-be-no-ff-no-commit) is an explanation on how to configure git to turn off fast-forwarding by default.
|
||||
You can find some more background reading [here](http://nvie.com/posts/a-successful-git-branching-model/).
|
||||
|
||||
Also - **test your changes**. Don't assume that a simple fix won't break something else. If possible get an experienced Friendica developer to review the code.
|
||||
Release branches
|
||||
----------------
|
||||
|
||||
A release branch is created when the develop branch contains all features it should have.
|
||||
A release branch is used for a few things.
|
||||
|
||||
1. It allows last-minute bug fixing before the release goes to master branch.
|
||||
2. It allows meta-data changes (README, CHANGELOG, etc.) for version bumps and documentation changes.
|
||||
3. It makes sure the develop branch can receive new features that are **not** part of this release.
|
||||
|
||||
That last point is important because...
|
||||
**The moment a release branch is created, develop is now intended for the version after this release**.
|
||||
So please don't ever merge develop into a release!
|
||||
An example: If a release branch "release-3.4" is created, "develop" becomes either 3.5 or 4.0.
|
||||
If you were to merge develop into release-3.4 at this point, features and bug-fixes intended for 3.5 or 4.0 might leak into this release branch.
|
||||
This might introduce new bugs, too.
|
||||
Which defeats the purpose of the release branch.
|
||||
|
||||
Some important reminders
|
||||
------------------------
|
||||
|
||||
1. Please pull in any changes from the project repository and merge them with your work **before** issuing a pull request.
|
||||
We reserve the right to reject any patch which results in a large number of merge conflicts.
|
||||
This is especially true in the case of language translations - where we may not be able to understand the subtle differences between conflicting versions.
|
||||
|
||||
2. **Test your changes**.
|
||||
Don't assume that a simple fix won't break anything else.
|
||||
If possible get an experienced Friendica developer to review the code.
|
||||
Don't hesitate to ask us in case of doubt.
|
||||
|
||||
Check out how to work with [our Vagrant](help/Vagrant) to save a lot of setup time!
|
||||
|
||||
|
|
|
@ -27,7 +27,6 @@ Friendica Documentation and Resources
|
|||
|
||||
* [Install](help/Install)
|
||||
* [Settings](help/Settings)
|
||||
* [Plugins](help/Plugins)
|
||||
* [Installing Connectors (Facebook/Twitter/StatusNet)](help/Installing-Connectors)
|
||||
* [Message Flow](help/Message-Flow)
|
||||
* [Using SSL with Friendica](help/SSL)
|
||||
|
@ -40,6 +39,7 @@ Friendica Documentation and Resources
|
|||
* [Help on Vagrant](help/Vagrant)
|
||||
* [How to translate Friendica](help/translations)
|
||||
* [Bugs and Issues](help/Bugs-and-Issues)
|
||||
* [Plugin Development](help/Plugins)
|
||||
* [Smarty 3 Templates](help/smarty3-templates)
|
||||
|
||||
**External Resources**
|
||||
|
|
|
@ -1,13 +1,9 @@
|
|||
How to: improve performance
|
||||
How to improve the performance of a Friendica site
|
||||
==============
|
||||
|
||||
* [Home](help)
|
||||
|
||||
A little guide to increase the performance of a Friendica site
|
||||
|
||||
**At first**
|
||||
|
||||
Feel free to ask at Friendica support at https://helpers.pyxis.uberspace.de/profile/helpers if you need some clarification about the following instructions or if you need help in any other way.
|
||||
Feel free to ask in the [Friendica support forum](https://helpers.pyxis.uberspace.de/profile/helpers) if you need some clarification about the following instructions or if you need help in any other way.
|
||||
|
||||
System configuration
|
||||
--------
|
||||
|
@ -26,9 +22,11 @@ If you have many OStatus contacts then completing of conversations can be very t
|
|||
|
||||
Lock files help avoid the possibility of several background processes running at the same time.
|
||||
|
||||
For example: It can happen that the poller.php takes longer than expected. When there is no lock file, it is possible for several instances of poller.php to run at the same time - which would slow down the system and affect the maximum numbers of processes and database connections.
|
||||
For example: It can happen that the poller.php takes longer than expected.
|
||||
When there is no lock file, it is possible for several instances of poller.php to run at the same time - which would slow down the system and affect the maximum numbers of processes and database connections.
|
||||
|
||||
Please define a full file path that is writeable by the web server process. If your site is located at "/var/www/sitename/htdocs/" you could maybe create a folder "/var/www/sitename/temp/".
|
||||
Please define a full file path that is writeable by the web server process.
|
||||
If your site is located at "/var/www/sitename/htdocs/" you could maybe create a folder "/var/www/sitename/temp/".
|
||||
|
||||
Enable "Use MySQL full text engine"
|
||||
|
||||
|
@ -36,20 +34,17 @@ When using MyISAM (default) this speeds up search.
|
|||
|
||||
Set "Path to item cache" to an empty value outside your web root.
|
||||
|
||||
Parsed BBCode and some external images will be put there. Parsing BBCode is a time wasting process that also makes heave use of the CPU.
|
||||
|
||||
Parsed BBCode and some external images will be put there.
|
||||
Parsing BBCode is a time wasting process that also makes heave use of the CPU.
|
||||
You can use the same folder you used for the lock file.
|
||||
|
||||
**Warning!**
|
||||
|
||||
The folder for item cache is cleaned up regularly. Every file that exceeds the cache duration is deleted. **If you accidentally point the cache path to your web root then you will delete your web root!**
|
||||
|
||||
The folder for item cache is cleaned up regularly.
|
||||
Every file that exceeds the cache duration is deleted. **If you accidentally point the cache path to your web root then you will delete your web root!**
|
||||
So double check that the folder only contains temporary content that can be deleted at any time.
|
||||
|
||||
You have been warned.
|
||||
|
||||
P.S. It happened to me :)
|
||||
|
||||
Plugins
|
||||
--------
|
||||
|
||||
|
@ -61,20 +56,18 @@ Active the following plugins:
|
|||
|
||||
###Alternate Pagination
|
||||
|
||||
|
||||
**Description**
|
||||
|
||||
This plugin reduces the database load massively. Downside: You can't see the total number of pages available at each module, and have this replaced with "older" and "newer" links.
|
||||
|
||||
**Administration**
|
||||
This plugin reduces the database load massively.
|
||||
Downside: You can't see the total number of pages available at each module, and have this replaced with "older" and "newer" links.
|
||||
|
||||
Go to the admin settings of "altpager" and set it to "global".
|
||||
|
||||
###rendertime
|
||||
|
||||
This plugin doesn't speed up your system. It helps analyzing your bottlenecks.
|
||||
This plugin doesn't speed up your system.
|
||||
It helps to analyze your bottlenecks.
|
||||
|
||||
When enabled you see some values like the following at the bottom of every page:
|
||||
When enabled you see some values at the bottom of every page.
|
||||
They show your performance problems.
|
||||
|
||||
Performance: Database: 0.244, Network: 0.002, Rendering: 0.044, Parser: 0.001, I/O: 0.021, Other: 0.237, Total: 0.548
|
||||
|
||||
|
@ -86,50 +79,47 @@ When enabled you see some values like the following at the bottom of every page:
|
|||
Others: Everything else :)
|
||||
Total: The sum of all above values
|
||||
|
||||
These values show your performance problems.
|
||||
|
||||
Webserver
|
||||
Apache Webserver
|
||||
--------
|
||||
|
||||
If you are using Apache please enable the following modules.
|
||||
The following Apache modules are recommended:
|
||||
|
||||
**Cache-Control**
|
||||
###Cache-Control
|
||||
|
||||
This module tells the client to cache the content of static files so that they aren't fetched with every request.
|
||||
|
||||
Enable the module "mod_expires" by typing in "a2enmod expires" as root.
|
||||
|
||||
Please add the following lines to your site configuration in the "directory" context.
|
||||
|
||||
ExpiresActive on ExpiresDefault "access plus 1 week"
|
||||
ExpiresActive on ExpiresDefault "access plus 1 week"
|
||||
|
||||
See also: http://httpd.apache.org/docs/2.2/mod/mod_expires.html
|
||||
Also see the Apache [2.2](http://httpd.apache.org/docs/2.2/mod/mod_expires.html) / [2.4](https://httpd.apache.org/docs/2.4/mod/mod_expires.html) documentation.
|
||||
|
||||
**Compress content**
|
||||
###Compress content
|
||||
|
||||
This module compresses the traffic between the web server and the client.
|
||||
|
||||
Enable the module "mod_deflate" by typing in "a2enmod deflate" as root.
|
||||
|
||||
See also: http://httpd.apache.org/docs/2.2/mod/mod_deflate.html
|
||||
Also see the Apache [2.2](http://httpd.apache.org/docs/2.2/mod/mod_deflate.html) / [2.4](https://httpd.apache.org/docs/2.4/mod/mod_deflate.html) documentation.
|
||||
|
||||
PHP
|
||||
--------
|
||||
|
||||
**FCGI**
|
||||
###FCGI
|
||||
|
||||
When using apache think about using FCGI. When using a Debian based distribution you will need the packages named "php5-cgi" and "libapache2-mod-fcgid".
|
||||
When using Apache think about using FCGI.
|
||||
In a Debian-based distribution you will need to install the packages named "php5-cgi" and "libapache2-mod-fcgid".
|
||||
|
||||
Please refer to external documentations for a more detailed explanation how to set up a system based upon FCGI.
|
||||
Please refer to external documentation for a more detailed explanation how to set up a system based upon FCGI.
|
||||
|
||||
**APC**
|
||||
###APC
|
||||
|
||||
APC is an opcode cache. It speeds up the processing of PHP code.
|
||||
APC is an opcode cache.
|
||||
It speeds up the processing of PHP code.
|
||||
When APC is enabled, Friendica uses it to store configuration data between different requests.
|
||||
This helps speeding up the page creation time.
|
||||
|
||||
When APC is enabled, Friendica uses it to store configuration data between different requests. This helps speeding up the page creation time.
|
||||
###Database
|
||||
|
||||
**Database**
|
||||
There are scripts like [tuning-primer.sh](http://www.day32.com/MySQL/) and [mysqltuner.pl](http://mysqltuner.pl) that analyze your database server and give hints on values that could be changed.
|
||||
|
||||
There are scripts like [tuning-primer.sh](http://www.day32.com/MySQL/) and [mysqltuner.pl](http://mysqltuner.pl) that analyzes your database server and give hints on values that could be changed.
|
||||
|
||||
Please enable the slow query log. This helps being aware of performance problems.
|
||||
Please enable the slow query log. This helps to find performance problems.
|
||||
|
|
162
doc/Install.md
162
doc/Install.md
|
@ -1,118 +1,126 @@
|
|||
Friendica Installation
|
||||
===============
|
||||
|
||||
We've tried very hard to ensure that Friendica will run on commodity hosting platforms - such as those used to host Wordpress blogs and Drupal websites. But be aware that Friendica is more than a simple web application. It is a complex communications system which more closely resembles an email server than a web server. For reliability and performance, messages are delivered in the background and are queued for later delivery when sites are down. This kind of functionality requires a bit more of the host system than the typical blog. Not every PHP/MySQL hosting provider will be able to support Friendica. Many will. But **please** review the requirements and confirm these with your hosting provider prior to installation.
|
||||
We've tried very hard to ensure that Friendica will run on commodity hosting platforms - such as those used to host Wordpress blogs and Drupal websites.
|
||||
But be aware that Friendica is more than a simple web application.
|
||||
It is a complex communications system which more closely resembles an email server than a web server.
|
||||
For reliability and performance, messages are delivered in the background and are queued for later delivery when sites are down.
|
||||
This kind of functionality requires a bit more of the host system than the typical blog.
|
||||
Not every PHP/MySQL hosting provider will be able to support Friendica.
|
||||
Many will.
|
||||
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 forums at http://groups.google.com/group/friendica or file an issue at http://bugs.friendica.com . 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.
|
||||
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).
|
||||
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.
|
||||
|
||||
Before you begin: Choose a domain name or subdomain name for your server. Put some thought into this - because changing it after installation is currently not-supported. Things will break, and some of your friends may have difficulty communicating with you. We plan to address this limitation in a future release.
|
||||
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.
|
||||
Things will break, and some of your friends may have difficulty communicating with you.
|
||||
We plan to address this limitation in a future release.
|
||||
|
||||
|
||||
1. Requirements
|
||||
- Apache with mod-rewrite enabled and "Options All" so you can use a
|
||||
local .htaccess file
|
||||
Requirements
|
||||
---
|
||||
|
||||
- PHP 5.2+. The later the better. You'll need 5.3 for encryption of key exchange conversations. On a Windows environment, 5.2+ might not work as the function dns_get_record() is only available with version 5.3.
|
||||
- PHP *command line* access with register_argc_argv set to true in the
|
||||
php.ini file
|
||||
- curl, gd, mysql, hash and openssl extensions
|
||||
- some form of email server or email gateway such that PHP mail() works
|
||||
- mcrypt (optional; used for server-to-server message encryption)
|
||||
* Apache with mod-rewrite enabled and "Options All" so you can use a local .htaccess file
|
||||
* PHP 5.2+. The later the better. You'll need 5.3 for encryption of key exchange conversations. On a Windows environment, 5.2+ might not work as the function dns_get_record() is only available with version 5.3.
|
||||
* PHP *command line* access with register_argc_argv set to true in the php.ini file
|
||||
* curl, gd, mysql, hash and openssl extensions
|
||||
* some form of email server or email gateway such that PHP mail() works
|
||||
* mcrypt (optional; used for server-to-server message encryption)
|
||||
* Mysql 5.x
|
||||
* 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.
|
||||
* If your hosting provider doesn't allow Unix shell access, you might have trouble getting everything to work.
|
||||
|
||||
- Mysql 5.x
|
||||
Installation procedure
|
||||
---
|
||||
|
||||
- ability to schedule jobs with cron (Linux/Mac) or Scheduled Tasks
|
||||
(Windows) [Note: other options are presented in Section 7 of this document]
|
||||
###Get Friendica
|
||||
|
||||
- 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.
|
||||
Unpack the Friendica files into the root of your web server document area.
|
||||
If you are able to do so, we recommend using git to clone the source repository rather than to use a packaged tar or zip file.
|
||||
This makes the software much easier to update.
|
||||
The Linux command to clone the repository into a directory "mywebsite" would be
|
||||
|
||||
|
||||
[Dreamhost.com offers all of the necessary hosting features at a
|
||||
reasonable price. If your hosting provider doesn't allow Unix shell access,
|
||||
you might have trouble getting everything to work.]
|
||||
|
||||
2. Unpack the Friendica files into the root of your web server document area.
|
||||
|
||||
- If you are able to do so, we recommend using git to clone the source repository rather than to use a packaged tar or zip file. This makes the software much easier to update. The Linux command to clone the repository into a directory "mywebsite" would be
|
||||
|
||||
`git clone https://github.com/friendica/friendica.git mywebsite`
|
||||
|
||||
- and then you can pick up the latest changes at any time with
|
||||
|
||||
`git pull`
|
||||
git clone https://github.com/friendica/friendica.git mywebsite
|
||||
|
||||
- make sure folder *view/smarty3* exists and is writable by webserver
|
||||
Make sure the folder *view/smarty3* exists and is writable by the webserver user
|
||||
|
||||
`mkdir view/smarty3`
|
||||
|
||||
`chmod 777 view/smarty3`
|
||||
mkdir view/smarty3
|
||||
chmod 777 view/smarty3
|
||||
|
||||
- For installing addons
|
||||
|
||||
- First you should be **on** your website folder
|
||||
Get the addons by going into your website folder.
|
||||
|
||||
`cd mywebsite`
|
||||
cd mywebsite
|
||||
|
||||
- Then you should clone the addon repository (separtely)
|
||||
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
|
||||
|
||||
- For keeping the addon tree updated, you should be on you addon tree and issue a git pull
|
||||
|
||||
`cd mywebsite/addon`
|
||||
|
||||
`git pull`
|
||||
|
||||
- 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.
|
||||
|
||||
###Create a database
|
||||
|
||||
3. Create an empty database and note the access details (hostname, username, password, database name).
|
||||
Create an empty database and note the access details (hostname, username, password, database name).
|
||||
|
||||
4. Visit your website with a web browser and follow the instructions. Please note any error messages and correct these before continuing.
|
||||
###Run the installer
|
||||
|
||||
5. *If* the automated installation fails for any reason, check the following:
|
||||
Point your web browser to the new site and follow the instructions.
|
||||
Please note any error messages and correct these before continuing.
|
||||
|
||||
- ".htconfig.php" exists ... If not, edit htconfig.php and change system settings. Rename
|
||||
to .htconfig.php
|
||||
- Database is populated. ... If not, import the contents of "database.sql" with phpmyadmin
|
||||
or mysql command line
|
||||
*If* the automated installation fails for any reason, check the following:
|
||||
|
||||
6. At this point visit your website again, and register your personal account.
|
||||
* Does ".htconfig.php" exist? If not, edit htconfig.php and change the system settings. Rename to .htconfig.php
|
||||
* Is the database is populated? If not, import the contents of "database.sql" with phpmyadmin or 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.
|
||||
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.
|
||||
|
||||
7. Set up a cron job or scheduled task to run the poller once every 5-10
|
||||
minutes in order to perform background processing. Example:
|
||||
###Set up the poller
|
||||
|
||||
`cd /base/directory; /path/to/php include/poller.php`
|
||||
Set up a cron job or scheduled task to run the poller once every 5-10 minutes in order to perform background processing.
|
||||
Example:
|
||||
|
||||
cd /base/directory; /path/to/php include/poller.php
|
||||
|
||||
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
|
||||
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". If you
|
||||
have troubles with this section please contact your hosting provider for
|
||||
assistance. Friendica will not work correctly if you cannot perform this step.
|
||||
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.
|
||||
Friendica will not work correctly if you cannot perform this step.
|
||||
|
||||
Alternative: You may be able to use the 'poormancron' plugin to perform this step
|
||||
if you are using a recent Friendica release. To do this, edit the file ".htconfig.php"
|
||||
and look for a line describing your plugins. On a fresh installation, it will look like
|
||||
Alternative: You may be able to use the 'poormancron' plugin to perform this step.
|
||||
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:
|
||||
|
||||
`$a->config['system']['addon'] = 'js_upload';`
|
||||
$a->config['system']['addon'] = 'js_upload';
|
||||
|
||||
This indicates the "js_upload" addon module is enabled. You may add additional
|
||||
addons/plugins using this same line in the configuration file. Change it to read
|
||||
It indicates the "js_upload" addon module is enabled.
|
||||
You may add additional addons/plugins using this same line in the configuration file.
|
||||
Change it to read
|
||||
|
||||
`$a->config['system']['addon'] = 'js_upload,poormancron';`
|
||||
$a->config['system']['addon'] = 'js_upload,poormancron';
|
||||
|
||||
and save your changes.
|
||||
|
||||
Updating your installation with git
|
||||
---
|
||||
|
||||
You can get the latest changes at any time with
|
||||
|
||||
cd mywebsite
|
||||
git pull
|
||||
|
||||
The addon tree has to be updated separately like so:
|
||||
|
||||
cd mywebsite/addon
|
||||
git pull
|
||||
|
|
|
@ -6,66 +6,69 @@ Installing Connectors (Facebook/Twitter/StatusNet)
|
|||
|
||||
Friendica uses plugins to provide connectivity to some networks, such as Facebook and Twitter.
|
||||
|
||||
There is also a plugin to post through to an existing account on a Status.Net service. You do not require this to communicate with Status.Net members from Friendica - only if you wish to post to an existing account.
|
||||
There is also a plugin to post through to an existing account on a StatusNet service.
|
||||
You only need this to post to an already existing StatusNet account, but not to communicate with StatusNet members in general.
|
||||
|
||||
All three of these plugins require an account on the target network. In addition you (or typically the server administrator) will need to obtain an API key to provide authenticated access to your Friendica server.
|
||||
All three plugins require an account on the target network.
|
||||
In addition you (or typically the server administrator) will need to obtain an API key to provide authenticated access to your Friendica server.
|
||||
|
||||
**Site Configuration**
|
||||
Site Configuration
|
||||
---
|
||||
|
||||
Plugins must be installed by the site administrator before they can be used. This is accomplished through the site administration panel.
|
||||
Plugins 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 plugins allow you to enter this information in the site administration pages, while others may require you to edit your configuration file (.htconfig.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.
|
||||
|
||||
Each of the connectors also requires an "API key" from the service you wish to connect with. Some plugins allow you to enter this information in the site administration pages, while others may require you to edit your configuration file (.htconfig.php). The method for obtaining these keys varies greatly - but almost always requires an existing account on the target service. Once installed, these API keys can usually be shared by all site members.
|
||||
The details of configuring each service follow (much of this information comes directly from the plugin source files):
|
||||
|
||||
|
||||
The details of configuring each service follows (much of this information comes directly from the plugin source files):
|
||||
|
||||
**Twitter Plugin for Friendica**
|
||||
Twitter Plugin for Friendica
|
||||
---
|
||||
|
||||
* Author: Tobias Diekershoff
|
||||
* tobias.diekershoff@gmx.net
|
||||
* License: 3-clause BSD license
|
||||
|
||||
* License:3-clause BSD license
|
||||
|
||||
Configuration:
|
||||
To use this plugin you need a OAuth Consumer key pair (key & secret)
|
||||
you can get it from Twitter at https://twitter.com/apps
|
||||
###Configuration
|
||||
To use this plugin you need a OAuth Consumer key pair (key & secret).
|
||||
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 the
|
||||
OAuth Consumer key and secret pair for your application/site.
|
||||
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 global .htconfig.php
|
||||
$a->config['twitter']['consumerkey'] = 'your consumer_key here';
|
||||
$a->config['twitter']['consumersecret'] = 'your consumer_secret here';
|
||||
|
||||
```
|
||||
$a->config['twitter']['consumerkey'] = 'your consumer_key here';
|
||||
$a->config['twitter']['consumersecret'] = 'your consumer_secret here';
|
||||
```
|
||||
After this, your users can configure their Twitter account settings from "Settings -> Connector Settings".
|
||||
|
||||
After this, your user can configure their Twitter account settings
|
||||
from "Settings -> Connector Settings".
|
||||
###More documentation
|
||||
|
||||
Documentation: http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Twitter_Plugin
|
||||
Find the author's documentation here: [http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Twitter_Plugin](http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/Twitter_Plugin)
|
||||
|
||||
|
||||
**StatusNet Plugin for Friendica**
|
||||
StatusNet Plugin for Friendica
|
||||
---
|
||||
|
||||
* Author: Tobias Diekershoff
|
||||
* tobias.diekershoff@gmx.net
|
||||
* License: 3-clause BSD license
|
||||
|
||||
* License:3-clause BSD license
|
||||
|
||||
Configuration
|
||||
###Configuration
|
||||
|
||||
When the addon is activated the user has to aquire the following in order to connect to the StatusNet account of choice.
|
||||
|
||||
* The base URL for the StatusNet API, for identi.ca this is https://identi.ca/api/
|
||||
* OAuth Consumer key & secret
|
||||
|
||||
To get the OAuth Consumer key pair the user has to
|
||||
To get the OAuth Consumer key pair the user has to
|
||||
|
||||
(a) ask her Friendica admin if a pair already exists or
|
||||
(b) has to register the Friendica server as a client application on the StatusNet 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 StatusNet server.
|
||||
|
||||
This can be done from the account settings under "Settings -> Connections -> Register an OAuth client application -> Register a new application" on the StatusNet server.
|
||||
|
||||
|
@ -77,56 +80,57 @@ During the registration of the OAuth client remember the following:
|
|||
* with read & write access
|
||||
* the Source URL should be the URL of your Friendica server
|
||||
|
||||
After the required credentials for the application are stored in the configuration you have to actually connect your Friendica account with StatusNet. This is done from the Settings -> Connector Settings page. Follow the Sign in with StatusNet 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.
|
||||
After the required credentials for the application are stored in the configuration you have to actually connect your Friendica account with StatusNet.
|
||||
This is done from the Settings -> Connector Settings page.
|
||||
Follow the Sign in with StatusNet 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.
|
||||
|
||||
If successful the addon settings will allow you to select to post your public messages to your StatusNet account (have a look behind the little lock symbol beneath the status "editor" on your Home or Network pages).
|
||||
If successful, the addon settings will allow you to select to post your public messages to your StatusNet account (have a look behind the little lock symbol beneath the status "editor" on your Home or Network pages).
|
||||
|
||||
Documentation: http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/StatusNet_Plugin
|
||||
###More documentation
|
||||
|
||||
Find the author's documentation here: [http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/StatusNet_Plugin](http://diekershoff.homeunix.net/redmine/wiki/friendikaplugin/StatusNet_Plugin)
|
||||
|
||||
The Friendica/Facebook connector
|
||||
---
|
||||
|
||||
**Installing the Friendica/Facebook connector**
|
||||
###Configuration
|
||||
|
||||
* register an API key for your site from developer.facebook.com
|
||||
First, register an API key for your site on [Facebook](developer.facebook.com).
|
||||
This requires a Facebook account, and may require additional authentication in the form of credit card or mobile phone verification.
|
||||
|
||||
This requires a Facebook account, and may require additional authentication in the form of credit card or mobile phone verification.
|
||||
We'd be very happy if you include "Friendica" in the application name to increase name recognition.
|
||||
The Friendica icons are also present in the images directory and may be uploaded as a Facebook app icon.
|
||||
Use images/friendica-16.jpg for the Icon and images/friendica-128.jpg for the logo.
|
||||
|
||||
a. We'd be very happy if you include "Friendica" in the application name
|
||||
to increase name recognition. The Friendica icons are also present
|
||||
in the images directory and may be uploaded as a Facebook app icon.
|
||||
Use images/friendica-16.jpg for the Icon and images/friendica-128.jpg for the Logo.
|
||||
|
||||
b. The url should be your site URL with a trailing slash.
|
||||
The url should be your site URL with a trailing slash.
|
||||
|
||||
You **may** be required to provide a privacy and/or terms of service URL.
|
||||
|
||||
c. Navigate to Set Web->Site URL & Domain -> Website Settings. Set Site URL
|
||||
to yoursubdomain.yourdomain.com. Set Site Domain to your yourdomain.com.
|
||||
Navigate to Set Web->Site URL & Domain -> Website Settings.
|
||||
Set Site URL to yoursubdomain.yourdomain.com.
|
||||
Set Site Domain to your yourdomain.com.
|
||||
|
||||
d. Install the Facebook plugin on your Friendica site at 'admin/plugins'. You should then see a link for Facebook under 'Plugin Features' on the sidebar of the admin panel. Select that.
|
||||
|
||||
e. Enter the App-ID and App Secret that Facebook gave you. Change any other settings as desired.
|
||||
Install the Facebook plugin on your Friendica site at 'admin/plugins'.
|
||||
You should then see a link for Facebook under 'Plugin Features' on the sidebar of the admin panel.
|
||||
Select it.
|
||||
|
||||
Enter the App-ID and App Secret that Facebook gave you.
|
||||
Change any other settings as desired.
|
||||
|
||||
On Friendica, each member who wishes to use the Facebook connector should visit the Facebook Settings section of their "Settings->Connector Settings" page, and click 'Install Facebook Connector'.
|
||||
|
||||
Choose the appropriate settings for your usage and privacy requirements.
|
||||
|
||||
This will ask you to login to Facebook and grant permission to the
|
||||
plugin to do its stuff. Allow it to do so.
|
||||
This will ask you to log into Facebook and grant permission to the plugin to do its stuff.
|
||||
Allow it to do so.
|
||||
|
||||
You're done. To turn it off visit the Connector Settings page again and
|
||||
'Remove Facebook posting'.
|
||||
You're done.
|
||||
|
||||
Videos and embeds will not be posted if there is no other content. Links
|
||||
and images will be converted to a format suitable for the Facebook API and
|
||||
long posts truncated - with a link to view the full post.
|
||||
|
||||
Facebook contacts will also not be able to view "private" photos, as they are not able to authenticate to your site to establish identity. We will address this in a future release.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
To turn it off visit the Connector Settings page again and 'Remove Facebook posting'.
|
||||
|
||||
Videos and embeds will not be posted if there is no other content.
|
||||
Links and images will be converted to a format suitable for the Facebook API and long posts truncated - with a link to view the full post.
|
||||
|
||||
Facebook contacts will also not be able to view "private" photos, as they are not able to authenticate to your site.
|
||||
We will address this in a future release.
|
||||
|
|
|
@ -3,55 +3,104 @@ Making Friends
|
|||
|
||||
* [Home](help)
|
||||
|
||||
Friendship in Friendica can take on a great many different meanings. But let's keep it simple, you want to be friends with somebody. How do you do it?
|
||||
Friendship in Friendica can take on a great many different meanings.
|
||||
But let's keep it simple, you want to be friends with somebody.
|
||||
How do you do it?
|
||||
|
||||
The first thing you can do is look at the Directory. The directory is split up into two parts. If you click the directory button, you will be presented with a list of all members (who chose to be listed) on your server. You'll also see a link to the Global Directory. If you click through to the global directory, you will be presented with a list of everybody who chose to be listed across all instances of Friendica. You will also see a "Show Community Forums" link, which will direct you to Groups, Forums and Fanpages. You connect to people, groups and forums in the same way, except groups and forums will automatically accept your introduction request, whereas a human will approve you manually.
|
||||
The Directories
|
||||
---
|
||||
Friendica has two different kinds of "addressbook":
|
||||
The directory of the Friendica server you are registered on and the global directory that collects account information across all Friendica instances.
|
||||
|
||||
To connect with other Friendica users:
|
||||
The first thing you can do is look at the **Directory**.
|
||||
The directory is split up into two parts.
|
||||
If you click the directory button, you will be presented with a list of all members (who chose to be listed) on your server.
|
||||
|
||||
Visit their profile. Just beneath their profile picture will be the word 'Connect' (we're assuming this is an English language profile).
|
||||
You'll also see a link to the **Global Directory**.
|
||||
If you click through to the global directory, you will be presented with a list of everybody who chose to be listed across all instances of Friendica.
|
||||
You will also see a "Show Community Forums" link, which will direct you to Groups, Forums and Fanpages.
|
||||
You connect to people, groups and forums in the same way, except groups and forums will automatically accept your introduction request, whereas a human will approve you manually.
|
||||
|
||||
Click that. It will take you to a "Connect" form.
|
||||
Connect to other Friendica users
|
||||
---
|
||||
|
||||
This is going to ask you for your Identity Address. This is necessary so that this person's website can find yours.
|
||||
Visit their profile.
|
||||
Just beneath their profile picture will be the word 'Connect' (we're assuming this is an English language profile).
|
||||
Click that 'Connect' button.
|
||||
It will take you to a 'Connect' form.
|
||||
|
||||
The form is going to ask you for your Identity Address.
|
||||
This is necessary so that this person's website can find yours.
|
||||
|
||||
What do you put in the box?
|
||||
|
||||
If your Friendica site is called "demo.friendica.com" and your username/nickname on that site is "bob", you would put in "bob@demo.friendica.com".
|
||||
|
||||
Notice this looks just like an email address. It was meant to be that way. It's easy for people to remember.
|
||||
Notice this looks just like an email address.
|
||||
It was meant to be that way.
|
||||
It's easy for people to remember.
|
||||
|
||||
You *could* also put in the URL of your "home" page, such as "http://demo.friendica.com/profile/bob", but the email-style address is certainly easier.
|
||||
|
||||
When you've submitted the connection page, it will take you back to your own site where you must then login (if necessary) and verify the connection request on *your* site. Once you've done this, the two websites can communicate with each other to complete the process (after your new friend has approved the request).
|
||||
When you've submitted the connection page, it will take you back to your own site where you must then login (if necessary) and verify the connection request on *your* site.
|
||||
Once you've done this, the two websites can communicate with each other to complete the process (after your new friend has approved the request).
|
||||
|
||||
If you already know somebody's Identity Address, you can enter it in the "connect" box on your "Contacts" page. This will take you through a similar process.
|
||||
If you already know somebody's Identity Address, you can enter it in the "connect" box on your "Contacts" page.
|
||||
This will take you through a similar process.
|
||||
|
||||
|
||||
**Alternate Networks**
|
||||
Connect to users of alternate networks
|
||||
---
|
||||
###StatusNet/GNUSocial, Google Plus, Twitter, Diaspora
|
||||
You can also use your Identity Address or other people's Identity Addresses to become friends across networks.
|
||||
The list of possible networks is growing all the time.
|
||||
If you know (for instance) "bob" on identi.ca (a StatusNet site) you could put bob@identi.ca into your Contact page and become friends across networks.
|
||||
(Or you can put in the URL to Bob's identi.ca page if you wish).
|
||||
|
||||
You can also use your Identity Address or other people's Identity Addresses to become friends across networks. The list of possible networks is growing all the time. If you know (for instance) "bob" on identi.ca (a Status.Net site) you could put bob@identi.ca into your Contact page and become friends across networks. (Or you can put in the URL to Bob's identi.ca page if you wish). You can also be "partial" friends with somebody on Google Buzz by putting in their gmail address. Google Buzz does not yet support all the protocols we need for direct messaging, but you should be able to follow status updates from within Friendica. You can do the same for Twitter accounts and Diaspora accounts. In fact you can "follow" most anybody or any website that produces a syndication feed (RSS/Atom,etc.). If we can find an information stream and a name to attach to the contact, we'll try to connect with them.
|
||||
You can also be "partial" friends with somebody on Google Plus by putting in their gmail address.
|
||||
Google Plus does not yet support all the protocols we need for direct messaging, but you should be able to follow status updates from within Friendica.
|
||||
|
||||
If you have supplied your mailbox connection information on your Settings page, you can enter the email address of anybody that has sent you a message recently and have their email messages show up in your social stream. You can also reply to them from within Friendica.
|
||||
You can do the same for Twitter accounts and Diaspora accounts.
|
||||
|
||||
People can also become friends with you from other networks. If a friend of yours has an identi.ca account, they can become friends with you by putting your Friendica Identity Address into their identi.ca subscription dialog box. A similar mechanism is available for Diaspora members, by putting your iendtity address into their search bar.
|
||||
In fact, you can "follow" almost anybody or any website that produces a syndication feed (RSS/Atom,etc.).
|
||||
If we can find an information stream and a name to attach to the contact, we'll try to connect with them.
|
||||
|
||||
###Email
|
||||
If you have supplied your mailbox connection information on your Settings page, you can enter the email address of anybody that has sent you a message recently and have their email messages show up in your social stream.
|
||||
You can also reply to them from within Friendica.
|
||||
|
||||
People can also become friends with you from other networks.
|
||||
If a friend of yours has an identi.ca account, they can become friends with you by putting your Friendica Identity Address into their identi.ca subscription dialog box.
|
||||
A similar mechanism is available for Diaspora members, by putting your identity address into their search bar.
|
||||
|
||||
Note: Some versions of StatusNet software may require the full URL to your profile and may not work with the identity address.
|
||||
|
||||
When somebody requests friendship you will receive a notification. You will need to approve this before the friendship is complete.
|
||||
Notification
|
||||
---
|
||||
When somebody requests friendship you will receive a notification.
|
||||
You will need to approve this before the friendship is complete.
|
||||
|
||||
Some networks allow people to send you messages without being friends and without your approval. Friendica does not allow this by default, as it would open a gateway for spam.
|
||||
Approval
|
||||
---
|
||||
Some networks allow people to send you messages without being friends and without your approval.
|
||||
Friendica does not allow this by default, as it would open a gateway for spam.
|
||||
|
||||
When you receive a friendship notification from another Friendica member, you will have the option of allowing them as a "fan" or as a "friend". If they are a fan, they can see what you have to say, including private communications that you send to them, but not vice versa. As a friend, you can both communicate with each other.
|
||||
Unilateral or bilateral friendships
|
||||
---
|
||||
When you receive a friendship notification from another Friendica member, you will have the option of allowing them as a "fan" or as a "friend".
|
||||
If they are a fan, they can see what you have to say, including private communications that you send to them, but not vice versa.
|
||||
As a friend, you can both communicate with each other.
|
||||
|
||||
Diaspora uses a different terminology, and you are given the option of allowing them to "share with you", or being full friends.
|
||||
Diaspora uses a different terminology, and you are given the option of allowing them to "share with you", or being full friends.
|
||||
|
||||
Once you have become friends, if you find the person constantly sends you spam or worthless information, you can "Ignore" them - without breaking off the friendship or even alerting them to the fact that you aren't interested in anything they are saying. In many ways they are like a "fan" - but they don't know this. They think they are a friend.
|
||||
Ignoring, blocking and deleting contacts
|
||||
---
|
||||
Once you have become friends, if you find the person constantly sends you spam or worthless information, you can "Ignore" them - without breaking off the friendship or even alerting them to the fact that you aren't interested in anything they are saying.
|
||||
In many ways they are like a "fan" - but they don't know this.
|
||||
They think they are a friend.
|
||||
|
||||
You can also "block" a person. This completely blocks communications with that person. They may still be able to see your public posts, as can anybody in the world, but they cannot communicate with you directly.
|
||||
|
||||
You can also delete a friend no matter what the friendship status - which complete removes everything relating to that person from your website.
|
||||
|
||||
|
||||
|
||||
You can also "block" a person.
|
||||
This completely blocks communications with that person.
|
||||
They may still be able to see your public posts, as can anybody in the world, but they cannot communicate with you directly.
|
||||
|
||||
You can also delete a friend no matter what the friendship status - which completely removes everything relating to that person from your website.
|
||||
|
|