diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 76009424b7..4ffdb9197c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,5 +1,5 @@ # How to Contribute -If you want to contribute to the project, you don’t need to have coding experience. There are a number of tasks listed in the issue tracker with the label “[Junior Jobs](https://github.com/friendica/friendica/issues?q=is%3Aopen+is%3Aissue+label%3A%22Junior+Jobs%22)” we think are good for new contributors. But you are by no means limited to these – if you find a solution to a problem (even a new one) please make a pull request at [github](https://github.com/friendica/friendica) or let us know in the [development forum](https://forum.friendi.ca/profile/developers). +If you want to contribute to the project, you don’t need to have coding experience. There are a number of tasks listed in the issue tracker with the label “[Junior Jobs](https://github.com/friendica/friendica/issues?q=is%3Aopen+is%3Aissue+label%3A%22Junior+Jobs%22)” we think are good for new contributors. But you are by no means limited to these – if you find a solution to a problem (even a new one) please make a pull request at [github](https://github.com/friendica/friendica) or let us know in the [development group](https://forum.friendi.ca/profile/developers). Contribution to Friendica is also not limited to coding. Any contribution to the [documentation](https://github.com/friendica/friendica/tree/develop/doc), the [translation](https://app.transifex.com/Friendica/friendica/dashboard/) or advertisement materials is welcome or reporting a problem. You don’t need to deal with Git(Hub) or Transifex if you don’t like to. Just [get in touch](https://forum.friendi.ca/profile/helpers) with us and we will get the materials to the appropriate places. diff --git a/doc/Bugs-and-Issues.md b/doc/Bugs-and-Issues.md index 405604c753..126f6af58e 100644 --- a/doc/Bugs-and-Issues.md +++ b/doc/Bugs-and-Issues.md @@ -6,7 +6,7 @@ Bugs and Issues 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. Reducing the workload in this way helps us get new features faster. -You can also contact the [friendica support forum](https://forum.friendi.ca/profile/helpers) and report your problem there. +You can also contact the [friendica support group](https://forum.friendi.ca/profile/helpers) and report your problem there. Bugs are rarely limited to one person, and the chances are somebody from another node has encountered the problem too, and will be able to help you. If you're a technical user, or your site doesn't have a support page, you'll need to use the [Bug Tracker](https://github.com/friendica/friendica/issues). diff --git a/doc/Developers-Intro.md b/doc/Developers-Intro.md index 329219925e..c500b27741 100644 --- a/doc/Developers-Intro.md +++ b/doc/Developers-Intro.md @@ -13,14 +13,14 @@ Whether you feel like an expert or like a newbie - join us with your ideas! ## Contact us -The discussion of Friendica development takes place in the following Friendica forums: +The discussion of Friendica development takes place in the following Friendica groups: -* The main [forum for Friendica development](https://forum.friendi.ca/profile/developers) +* The main [group for Friendica development](https://forum.friendi.ca/profile/developers) ## 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://forum.friendi.ca/profile/helpers). +A good place to start can be to help new people find their way around Friendica in the [general support group](https://forum.friendi.ca/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. ## Translation @@ -33,10 +33,10 @@ If you don't want to translate the UI, or it is already done to your satisfactio 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 [forum for Friendica development](https://forum.friendi.ca/profile/developers). +* If you would like to work with us on enhancing the user interface, please join the [group for Friendica development](https://forum.friendi.ca/profile/developers). * 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. + 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 favorite theme ## Programming @@ -72,7 +72,7 @@ just place it into `.git/hooks/post-merge` and make it executable. ### Coding standards -For the sake of consistency between contribution and general code readability, Friendica follows the widespread [PSR-2 coding standards](http://www.php-fig.org/psr/psr-2/) to the exception of a few rules. +For the sake of consistency between contribution and general code readability, Friendica follows the widespread [PSR-2 coding standards](http://www.php-fig.org/psr/psr-2/) excepted a few rules. Here's a few primers if you are new to Friendica or to the PSR-2 coding standards: * Indentation is tabs, period (not PSR-2). @@ -88,7 +88,7 @@ Here's a few primers if you are new to Friendica or to the PSR-2 coding standard Don't worry, you don't have to know by heart the PSR-2 coding standards to start contributing to Friendica. There are a few tools you can use to check or fix your files before you commit. -For documentation we use the standard of *one sentence per line* for the `md` files in the `/doc` and `/doc/$lng` subdirectories. +For documentation, we use the standard of *one sentence per line* for the `md` files in the `/doc` and `/doc/$lng` subdirectories. #### Check with [PHP Code Sniffer](https://github.com/squizlabs/PHP_CodeSniffer) @@ -113,7 +113,7 @@ If the command-line tools `diff` and `patch` are unavailable for you, `phpcbf` c ### Code documentation -If you are interested in having the documentation of the Friendica code outside of the code files, you can use [Doxygen](http://doxygen.org) to generate it. +If you are interested in having the documentation of the Friendica code outside the code files, you can use [Doxygen](http://doxygen.org) to generate it. The configuration file for Doxygen is located in the base directory of the project sources. Run @@ -126,7 +126,7 @@ If you find missing documentation, don't hesitate to contact us and write it dow ### Issues -Have a look at our [issue tracker](https://github.com/friendica/friendica) on github! +Have a look at our [issue tracker](https://github.com/friendica/friendica) on GitHub! * Try to reproduce a bug that needs more inquiries 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. @@ -143,13 +143,13 @@ 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://forum.friendi.ca/profile/developers) +* Let us know about your plans [in the dev group](https://forum.friendi.ca/profile/developers) Do not worry about cross-posting. ### Client software As Friendica is using a [Twitter/GNU Social compatible API](help/api) any of the clients for those platforms should work with Friendica as well. -Furthermore there are several client projects, especially for use with Friendica. +Furthermore, there are several client projects, especially for use with Friendica. If you are interested in improving those clients, please contact the developers of the clients directly. * Android / LinageOS: **Friendiqa** [src](https://git.friendi.ca/lubuwest/Friendiqa)/[Google Play](https://play.google.com/store/apps/details?id=org.qtproject.friendiqa) developed by [Marco R](https://freunde.ma-nic.de/profile/marco) diff --git a/doc/FAQ-admin.md b/doc/FAQ-admin.md index 94cef1627b..e5f4f2a9f3 100644 --- a/doc/FAQ-admin.md +++ b/doc/FAQ-admin.md @@ -52,4 +52,4 @@ You can manually execute the structure update from the CLI in the base directory bin/console dbstructure update -if there occur any errors, please contact the [support forum](https://forum.friendi.ca/profile/helpers). +if there occur any errors, please contact the [support group](https://forum.friendi.ca/profile/helpers). diff --git a/doc/FAQ.md b/doc/FAQ.md index 2a2af56885..ebb8c041b5 100644 --- a/doc/FAQ.md +++ b/doc/FAQ.md @@ -4,14 +4,14 @@ Frequently Asked Questions - FAQ * [Home](help) * **[Where I can find help?](help/FAQ#help)** -* **[Why do I getting warnings about certificates?](help/FAQ#ssl)** +* **[Why do I get warnings about certificates?](help/FAQ#ssl)** * **[How can I upload images, files, links, videos and sound files to posts?](help/FAQ#upload)** * **[Is it possible to have different avatars per profile?](help/FAQ#avatars)** * **[How can I view Friendica in a certain language?](help/FAQ#language)** * **[How do blocked, ignored, archived and hidden contacts behave?](help/FAQ#contacts)** * **[What happens when an account is removed? Is it truly deleted?](help/FAQ#removed)** * **[Can I subscribe to a hashtag?](help/FAQ#hashtag)** -* **[How to create a RSS feed of the stream?](help/FAQ#rss)** +* **[How to create an RSS feed of the stream?](help/FAQ#rss)** * **[What friendica clients can I use?](help/FAQ#clients)** @@ -21,7 +21,7 @@ Frequently Asked Questions - FAQ If this FAQ does not answer your question you can always reach out to the community via the following options: - * Friendica Support Forum: [@helpers@forum.friendi.ca](https://forum.friendi.ca/~helpers) + * Friendica Support Group: [@helpers@forum.friendi.ca](https://forum.friendi.ca/~helpers) * Community chat rooms (the IRC, Matrix and XMPP rooms are bridged) these public chats are logged [from IRC](https://gnusociarg.nsupdate.info/2021/%23friendica/) and [Matrix](https://view.matrix.org/alias/%23friendi.ca:matrix.org/) * XMPP: support(at)forum.friendi.ca * IRC: #friendica at [libera.chat](https://web.libera.chat/?channels=#friendica) @@ -66,7 +66,7 @@ If this doesn't work, try to add the link by typing: [url=http://example.com]*se You can also add video and audio files to posts. However, 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 anyone else with oembed/opengraph-support). Videos will be shown with a preview image you can click on to start. SoundCloud directly inserts a player to your post. +1. Add the video or audio link of a hoster (YouTube, Vimeo, Soundcloud and anyone else with oembed/opengraph-support). Videos will be shown with a preview image you can click on to start. SoundCloud directly inserts a player to your post. 2. If you have your own server, you can upload multimedia files via FTP and insert the URL. @@ -92,7 +92,7 @@ A question mark is required for the separation between url and parameters. Example: - https://social.example.com/profile/example + https://social.example.com/profile/example in German: @@ -107,48 +107,48 @@ When a certain language is forced, the language remains until session is closed. Direct communication will be blocked. Blocked contacts 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. +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 Ignored contacts are included in delivery and will receive your posts and private messages. -However we do not import their posts or private messages to you. -Like blocking you will still see this person's comments to posts made by your friends. +However, we do not import their posts or private messages to you. +Like blocking, you will still see this person's comments to posts made by your friends. An addon 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 their conversations with your other friends. ##### Archived Communication is not possible and will not be attempted. -However unlike blocking, existing posts this person made before being archived will be visible in your stream. +However, unlike blocking, existing posts this person made before being archived will be visible in your stream. ##### Hidden Contact not be displayed in your public friend list. -However a hidden contact will appear normally in conversations and this may expose their hidden status to anybody who can see the conversation. +However, a hidden contact will appear normally in conversations and this may expose their hidden status to anybody who can see the conversation. ### What happens when an account is removed? -If you remove your account, it will be scheduled for permanent deletion in *seven days*. -As soon as you activate the deletion process you won't be able to login any more. +If you remove your account, it will be scheduled for permanent deletion in *seven days*. +As soon as you activate the deletion process you won't be able to log in anymore. Only the administrator of your node can halt this process prior to permanent deletion. -After the elapsed time of seven days, all your posts, messages, photos, and personal information stored on your node will be deleted. -Your node will also issue removal requests to all your contacts; this will also remove your profile from the global directory if you are listed. +After the elapsed time of seven days, all your posts, messages, photos, and personal information stored on your node will be deleted. +Your node will also issue removal requests to all your contacts; this will also remove your profile from the global directory if you are listed. Your username cannot be reissued for future sign-ups for security reasons. ### Can I follow a hashtag? -Yes. Simply add the hash tag to your saved searches. +Yes. Simply add the hashtag to your saved searches. The posts will appear on your network page. For technical reasons, your answers to such posts won't appear on the "personal" tab in the network page and the whole thread isn't accessible via the API. -### How to create a RSS feed of the stream? +### How to create an RSS feed of the stream? If you want to share your public page via rss you can use one of the following links: @@ -191,10 +191,10 @@ The available features are client specific and may differ. #### iOS -* [Mastodon](https://joinmastodon.org/apps) ([AppStore](https://apps.apple.com/us/app/mastodon-for-iphone/id1571998974)) -* [Stella*](https://www.stella-app.net/) ([AppStore](https://apps.apple.com/us/app/stella-for-mastodon-twitter/id921372048)) -* [Tooot](https://github.com/tooot-app) ([AppStore](https://apps.apple.com/app/id1549772269) -* [TwidereX](https://github.com/TwidereProject/TwidereX-iOS) ([AppStore](https://apps.apple.com/app/twidere-x/id1530314034)) +* [Mastodon](https://joinmastodon.org/apps) ([App Store](https://apps.apple.com/us/app/mastodon-for-iphone/id1571998974)) +* [Stella*](https://www.stella-app.net/) ([App Store](https://apps.apple.com/us/app/stella-for-mastodon-twitter/id921372048)) +* [Tooot](https://github.com/tooot-app) ([App Store](https://apps.apple.com/app/id1549772269) +* [TwidereX](https://github.com/TwidereProject/TwidereX-iOS) ([App Store](https://apps.apple.com/app/twidere-x/id1530314034)) #### Linux @@ -206,7 +206,7 @@ The available features are client specific and may differ. #### macOS * [TheDesk](https://thedesk.top/en/) ([GitHub](https://github.com/cutls/TheDesk)) -* [Whalebird](https://whalebird.social/en/desktop/contents) ([AppStore](https://apps.apple.com/de/app/whalebird/id1378283354), [GitHub](https://github.com/h3poteto/whalebird-desktop)) +* [Whalebird](https://whalebird.social/en/desktop/contents) ([App Store](https://apps.apple.com/de/app/whalebird/id1378283354), [GitHub](https://github.com/h3poteto/whalebird-desktop)) #### Windows diff --git a/doc/Forums.md b/doc/Forums.md deleted file mode 100644 index 6e768983eb..0000000000 --- a/doc/Forums.md +++ /dev/null @@ -1,66 +0,0 @@ -Forums -===== - -* [Home](help) - - -Friendica also lets you create community forums and other types of accounts that can function as discussion forums, celebrity accounts, announcement channels, news reflectors, or organization pages, depending on how you want to interact with others. Management of these pages can be delegated to other accounts, or a parent account can be designated to easily toggle multiple identities. - -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. - -Managing Accounts ---- - -To create a new linked account that can be used as a forum, log in to your normal account and go to Settings > Manage Accounts. -Here you can register additional accounts with new nicknames that will be linked to your primary account. - -You may appoint a delegate to manage your new account (e.g. forum page). -The Delegates section of Manage Accounts page will provide you with a list of contacts on this instance 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, or remove the account. - -Additionally, this page is also where you can choose to designate an account as a parent user. -If your primary account is designated as the parent user, you will be able to easily toggle identities and manage your forums or other types of accounts. - -Types of Accounts ---- - -On the new account, visit the Settings > Account page. -Towards the end of the page is a section for "Advanced account types". -Typically you would use "Personal Page - Standard" for a normal personal account with manual approval of “friends” and “followers.” -This is the default selection. -On this page you can change the type of account if desired. - -The other subtypes of a Personal Page are “Soapbox” and “Love-all.” -A Soapbox account is an announcement channel that automatically approvals follower requests. -Everything posted by the account will go out to the followers, but there will be no opportunity for interaction. -This setting would typically be used for announcements or corporate communications. -“Love-all” automatically approves contacts as friends. - -In addition to Personal Page, there are options for Organization Page, News Page, and Community Forum. -Organization and New Pages automatically approve contact requests as followers. - -Community Forum provide the ability for people to become friends/fans of the forum without requiring approval. -This creates a forum page where all members can freely interact. - -Posting to Community forums ---- - -If you are a member of a community forum, you may post to the forum by including an @-mention 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 you mention a forum (you are a member of) in a new posting, the posting will be distributed to all members of the forum, regardless of your privacy settings for the posting. -Also, if the forum is a public forum, your posting will be public for the all internet users. -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). -Posting privately to a public forum, will result in your posting being displayed on the forum wall, but not on yours. - -Additionally it is possible to address a forum with the exclamation mark. -In the example above this means that you can address the bicycle forum via !bicycle. -The difference to the @ is that the post will only be sent to the addressed forum. -This also means that you shouldn't address multiple forums in a single post in that way since it will only be distributed by one the forums. - -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 @-mention in a comment does not relay the message, as distribution is controlled entirely by the original post creator. diff --git a/doc/GitHub.md b/doc/GitHub.md index 5fbc3788ee..24f2e6aa41 100644 --- a/doc/GitHub.md +++ b/doc/GitHub.md @@ -3,7 +3,7 @@ Friendica on GitHub * [Home](help) -Here is how you can work on the code with us. If you have any questions please write to the Friendica developers' forum. +Here is how you can work on the code with us. If you have any questions please write to the Friendica developers' group. Introduction to the workflow with our GitHub repository ------------------------------------------------------- diff --git a/doc/Groups.md b/doc/Groups.md new file mode 100644 index 0000000000..3c2e17929d --- /dev/null +++ b/doc/Groups.md @@ -0,0 +1,68 @@ +Groups +===== + +* [Home](help) + + +Friendica also lets you create accounts that can function as discussion groups, celebrity accounts, announcement channels, news reflectors, or organization pages, depending on how you want to interact with others. +Management of these accounts can be delegated to other accounts, or a parent account can be designated to easily toggle multiple identities. + +Every account in Friendica has a nickname and these must all be unique. +This applies to all accounts, whether they are individual profiles or group profiles. + +Managing Accounts +--- + +To create a new linked account that can be used as a group, log in to your normal account and go to Settings > Manage Accounts. +Here you can register additional accounts with new nicknames that will be linked to your primary account. + +You may appoint a delegate to manage your new account. +The Delegates section of Manage Accounts page will provide you with a list of contacts on this instance under "Potential Delegates". +Selecting one or more persons will give them access to manage your newly created account. +They will be able to edit contacts, profiles, and all content for this account. +Please use this facility wisely. +Delegated managers will not be able to alter basic account settings, such as passwords or account types, or remove the account. + +Additionally, this page is also where you can choose to designate an account as a parent user. +If your primary account is designated as the parent user, you will be able to easily toggle identities and manage your groups or other types of accounts. + +Types of Accounts +--- + +On the new account, visit the Settings > Account page. +Towards the end of the page is a section for "Advanced account types". +Typically, you would use "Personal Page - Standard" for a normal personal account with manual approval of “friends” and “followers.” +This is the default selection. +On this page you can change the type of account if desired. + +The other subtypes of a Personal Page are “Soapbox” and “Love-all.” +A Soapbox account is an announcement channel that automatically approvals follower requests. +Everything posted by the account will go out to the followers, but there will be no opportunity for interaction. +This setting would typically be used for announcements or corporate communications. +“Love-all” automatically approves contacts as friends. + +In addition to Personal Page, there are options for Organization Page, News Page, and Community Group. +Organization and New Pages automatically approve contact requests as followers. + +Community Group provide the ability for people to join the group without requiring approval. +This creates a group where all members can freely interact. + +Posting to Community groups +--- + +If you are a member of a community group, you may post to the group by including an @-mention in the post mentioning the group. +For example @bicycle would send my post to all members of the group "bicycle" in addition to the normal recipients. +If you mention a group (you are a member of) in a new posting, the posting will be distributed to all members of the group, regardless of your privacy settings for the posting. +Also, if the group is public, your posting will be public for the all internet users. +If your post is private you must also explicitly include the group in the post permissions (to allow the group "contact" to see the post) **and** mention it in a tag (which redistributes the post to the group members). +Posting privately to a public group, will result in your posting being displayed on the group wall, but not on yours. + +Additionally, it is possible to address a group with the exclamation mark. +In the example above this means that you can address the bicycle group via !bicycle. +The difference with the @-mention is that the post will only be sent to the addressed group. +This also means that you shouldn't address multiple groups in a single post in that way since it will only be distributed by one the groups. + +You may also post to a community group by posting a "wall-to-wall" post using secure cross-site authentication. + +Comments which are relayed to community groups will be relayed back to the original post creator. +Mentioning the group with an @-mention in a comment does not relay the message, as distribution is controlled entirely by the original post creator. diff --git a/doc/Home.md b/doc/Home.md index 760c8bf563..9578e914a0 100644 --- a/doc/Home.md +++ b/doc/Home.md @@ -16,7 +16,7 @@ Friendica Documentation and Resources * [Making Friends](help/Making-Friends) * [Circles and Privacy](help/Circles-and-Privacy) * [Tags and Mentions](help/Tags-and-Mentions) - * [Community Forums](help/Forums) + * [Community Groups](help/Groups) * [Chats](help/Chats) * Further information * [Move your account](help/Move-Account) @@ -67,7 +67,7 @@ Friendica Documentation and Resources * [Main Website](https://friendi.ca) * Ways to get Support - * Friendica Support Forum: [@helpers@forum.friendi.ca](https://forum.friendi.ca/~helpers) + * Friendica Support Group: [@helpers@forum.friendi.ca](https://forum.friendi.ca/~helpers) * [Mailing List Archive](http://mailman.friendi.ca/mailman/listinfo/support-friendi.ca) you can subscribe to the list by sending an email to ``support-request(at)friendi.ca?subject=subscribe`` * Community chat rooms (the IRC, Matrix and XMPP rooms are bridged) these public chats are logged [from IRC](https://gnusociarg.nsupdate.info/2021/%23friendica/) and [Matrix](https://view.matrix.org/alias/%23friendi.ca:matrix.org/) * XMPP/Jabber MUC: support(at)forum.friendi.ca diff --git a/doc/Improve-Performance.md b/doc/Improve-Performance.md index 1d0a859f1f..727fa104be 100644 --- a/doc/Improve-Performance.md +++ b/doc/Improve-Performance.md @@ -3,7 +3,7 @@ How to improve the performance of a Friendica site * [Home](help) -Feel free to ask in the [Friendica support forum](https://forum.friendi.ca/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 group](https://forum.friendi.ca/profile/helpers) if you need some clarification about the following instructions or if you need help in any other way. System configuration -------- @@ -31,7 +31,7 @@ Active the following addons: ### rendertime -This addon doesn't speed up your system. +This addon doesn't speed up your system. It helps to analyze your bottlenecks. When enabled you see some values at the bottom of every page. diff --git a/doc/Install.md b/doc/Install.md index ddffe601c5..bf9dffb357 100644 --- a/doc/Install.md +++ b/doc/Install.md @@ -15,7 +15,7 @@ Many will. But **please** review the [requirements](#Requirements) and confirm these with your hosting provider prior to installation. ## Support -If you encounter installation issues, please let us know via the [helper](http://forum.friendi.ca/profile/helpers) or the [developer](https://forum.friendi.ca/profile/developers) forum or [file an issue](https://github.com/friendica/friendica/issues). +If you encounter installation issues, please let us know via the [helper](http://forum.friendi.ca/profile/helpers) or the [developer](https://forum.friendi.ca/profile/developers) group 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. @@ -23,7 +23,7 @@ Due to the large variety of operating systems and PHP platforms in existence we ## Prerequisites * Choose a domain name or subdomain name for your server. Put some thought into this. While changing it after installation is supported, things still might break. -* Setup HTTPS on your domain. +* Setup HTTPS on your domain. ### Requirements @@ -42,7 +42,7 @@ Due to the large variety of operating systems and PHP platforms in existence we For alternative server configurations (such as Nginx server and MariaDB database engine), refer to the [Friendica wiki](https://github.com/friendica/friendica/wiki). -### Optional +### Optional * PHP ImageMagick extension (php-imagick) for animated GIF support. @@ -105,11 +105,11 @@ If you encounter a bug, please let us know. ### Create a database -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). Generate a strong password, then enter mysql with: mysql - + Then use the following script using the password you just generated: CREATE DATABASE friendicadb; @@ -148,7 +148,7 @@ You have the following options to automatically install Friendica: - using environment variables (f.e. `MYSQL_HOST`) - using options (f.e. `--dbhost `) -You can combine environment variables and options, but be aware that options are prioritized over environment variables. +You can combine environment variables and options, but be aware that options are prioritized over environment variables. For more information during the installation, you can use this command line option @@ -157,7 +157,7 @@ For more information during the installation, you can use this command line opti If you wish to include all optional checks, use `-a` like this statement: bin/console autoinstall -a - + *If* the automatic installation fails for any reason, check the following: * Does `config/local.config.php` already exist? If yes, the automatic installation won't start @@ -171,7 +171,7 @@ You can use a prepared config file like [local-sample.config.php](/config/local- Navigate to the main Friendica directory and execute the following command: bin/console autoinstall -f - + #### B.2: Environment variables There are two types of environment variables. @@ -194,7 +194,7 @@ if you don't use the option `--savedb` during installation, the DB credentials w **Friendica settings** This variables wont be used at normal Friendica runtime. -Instead, they get saved into `config/local.config.php`. +Instead, they get saved into `config/local.config.php`. - `FRIENDICA_URL_PATH` The URL path of Friendica (f.e. '/friendica') - `FRIENDICA_PHP_PATH` The path of the PHP binary @@ -238,7 +238,7 @@ Example: ### Verify the "host-meta" page is working Friendica should respond automatically to important addresses under the */.well-known/* rewrite path. -One critical URL would look like, for example: https://example.com/.well-known/host-meta +One critical URL would look like, for example: https://example.com/.well-known/host-meta It must be visible to the public and must respond with an XML file that is automatically customized to your site. If that URL is not working, it is possible that some other software is using the /.well-known/ path. @@ -257,7 +257,7 @@ It may be necessary to chmod the /.well-known/.htaccess file if you were not giv At this point visit your website again, and register your personal account with the same email as in the `config.admin_email` config value. 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. +If you get any *critical* failure at this point, it generally indicates the database was not installed correctly. You might wish to delete/rename `config/local.config.php` to another name and drop all the database tables so that you can start fresh. ## Post Install Configuration @@ -295,7 +295,7 @@ Once started, you can check the daemon status using the following command: cd /path/to/friendica; php bin/daemon.php status -After a server restart or any other failure, the daemon needs to be restarted. +After a server restart or any other failure, the daemon needs to be restarted. This could be achieved by a cronjob. ### (RECOMMENDED) Logging & Log Rotation @@ -408,7 +408,7 @@ provided by one of our members. > On my server I use the php protection system Suhosin [http://www.hardened-php.net/suhosin/]. > One of the things it does is to block certain functions like proc_open, as > configured in `/etc/php5/conf.d/suhosin.ini`: -> +> > suhosin.executor.func.blacklist = proc_open, ... > > For those sites like Friendica that really need these functions they can be @@ -418,34 +418,34 @@ provided by one of our members. > php_admin_value suhosin.executor.func.blacklist none > php_admin_value suhosin.executor.eval.blacklist none > -> +> > This enables every function for Friendica if accessed via browser, but not for > the cronjob that is called via php command line. I attempted to enable it for > cron by using something like: -> +> > */10 * * * * cd /var/www/friendica/friendica/ && sudo -u www-data /usr/bin/php \ > -d suhosin.executor.func.blacklist=none \ > -d suhosin.executor.eval.blacklist=none -f bin/worker.php -> +> > This worked well for simple test cases, but the friendica-cron still failed > with a fatal error: -> +> > suhosin[22962]: ALERT - function within blacklist called: proc_open() > (attacker 'REMOTE_ADDR not set', file '/var/www/friendica/friendica/boot.php', > line 1341) -> +> > After a while I noticed, that `bin/worker.php` calls further PHP script via `proc_open`. > These scripts themselves also use `proc_open` and fail, because they are NOT > called with `-d suhosin.executor.func.blacklist=none`. -> +> > So the simple solution is to put the correct parameters into `config/local.config.php`: -> +> > 'config' => [ > //Location of PHP command line processor > 'php_path' => '/usr/bin/php -d suhosin.executor.func.blacklist=none \ > -d suhosin.executor.eval.blacklist=none', > ], -> +> > This is obvious as soon as you notice that the friendica-cron uses `proc_open` > to execute PHP scripts that also use `proc_open`, but it took me quite some time to find that out. > I hope this saves some time for other people using suhosin with function blocklists. diff --git a/doc/Making-Friends.md b/doc/Making-Friends.md index 7101df2a87..d928995865 100644 --- a/doc/Making-Friends.md +++ b/doc/Making-Friends.md @@ -20,15 +20,15 @@ You'll also see a link to a **Global Directory**. There are several global directories across the globe that regularly exchange information with each other. The specific global directory that you see usually depends on where your server is located. If you click through to the global directory, you will be presented with a list of everybody who choses to be listed across all instances of Friendica. -You will also see a "Show Community Forums" link, which will direct you to Circles, 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. +You will also see a "Show Community Groups" link, which will direct you to Groups. +You connect to people and groups the same way, public groups will automatically accept your introduction, whereas private groups and some individual users will need to manually approve it. Connect to other Friendica users --- 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 and it will take you to a 'Connect' form. +Click that 'Connect' button, and 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. @@ -41,7 +41,7 @@ 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" instead of the email-style address. -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. +When you've submitted the connection page, it will take you back to your own site where you must then log in (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. @@ -55,14 +55,14 @@ You can also use your Identity Address or other people's Identity Addresses to b Currently, Friendica supports connections with people on diaspora*, Red, Hubzilla, GNU Social, StatusNet, Mastodon, Pleroma, socialhome, and ganggo platforms. If you know (for instance) "alice" on gnusocial.net (a GNU Social site) you could put alice@gnusocial.net into your Contact page and become friends across networks. -Likewise you can put in the URL to Alice's gnusocial.net page, if you wish. +Likewise, you can put in the URL to Alice's gnusocial.net page, if you wish. Note: Some versions of GNU Social software may require the full URL to your profile and may not work with the identity address. People on these networks can also initiate contact with you, if they know your contact details. ### Other social media If you server provides this functionality, you can also connect with people one -Twitter or important feeds from Tumblr, Wordpress, and many more. +Twitter or important feeds from Tumblr, WordPress, and many more. To connect, enter their contact details in the "connect" box on your "Contacts" page. diff --git a/doc/Quick-Start-andfinally.md b/doc/Quick-Start-andfinally.md index 6151439cee..7ea3f5dc72 100644 --- a/doc/Quick-Start-andfinally.md +++ b/doc/Quick-Start-andfinally.md @@ -4,7 +4,7 @@ Here are some more things to help get you started: **Groups** -- Friendica Support - problems? This is the place to ask. +- Friendica Support - problems? This is the place to ask. **Documentation** diff --git a/doc/Quick-Start-groupsandpages.md b/doc/Quick-Start-groupsandpages.md index f64f3afcbe..c9a27c6f1c 100644 --- a/doc/Quick-Start-groupsandpages.md +++ b/doc/Quick-Start-groupsandpages.md @@ -1,9 +1,9 @@ This is the global directory. If you get lost, you can click this link to bring yourself back here. -On this page, you'll find a collection of groups, forums and celebrity pages. +On this page, you'll find a collection of groups. Groups are not real people. -Connecting to them is similar to "liking" something on Facebook, or signing up for a new forum. +Connecting to them is similar to "liking" something on Facebook, or signing up for a new group. You don't have to feel awkward about introducing yourself to a new person, because they're not people! When you connect to a group, all messages to that group will start appearing in your network tab. @@ -15,6 +15,6 @@ Remember the link at the top of this page will bring you back here. Once you've added some groups, move on to the next section. - + diff --git a/doc/Tags-and-Mentions.md b/doc/Tags-and-Mentions.md index 8d5ba9d8d1..8424b026cb 100644 --- a/doc/Tags-and-Mentions.md +++ b/doc/Tags-and-Mentions.md @@ -23,19 +23,19 @@ You can tag a person on a different network or one that is **not in your social Unless their system blocks unsolicited "mentions", the person tagged will likely receive a "Mention" post/activity or become a direct participant in the conversation in the case of public posts. Friendica blocks incoming “mentions” from people with no relationship to you. -The exception is an ongoing conversation started from a contact of both you and the 3rd person or a conversation in a forum where you are a member of. +The exception is an ongoing conversation started from a contact of both you and the 3rd person or a conversation in a group where you are a member of. This is a spam prevention measure. Remote mentions are delivered using the OStatus protocol. This protocol is used by Friendica and GNU Social and several other systems like Mastodon, but is not currently implemented in Diaspora. As the OStatus protocol allows this Friendica user can be @-mentioned by users from platforms using this protocol in conversations if the "Enable OStatus support" is activated on the Friendica node. -These @-mentions wont be blocked, even if there is no relationship between the sender and the receiver of the message. +These @-mentions won't be blocked, even if there is no relationship between the sender and the receiver of the message. -Friendica makes no distinction between people and forums for the purpose of tagging. -You can use @-mentions for forums like for other accounts to tag the forum. -If you want to post something exclusively to a forum (e.g. the support forum) please use the bang-notation instead of the @tag. -So !helpers will be an exclusive posting to the support forum if you are connected with the forum. -If you select a forum from the ACL a !-mention will be added automatically to your posting. +Friendica makes no distinction between people and groups for the purpose of tagging. +You can use @-mentions for groups like for other accounts to tag the group. +If you want to post something exclusively to a group (e.g. the support group) please use the !-mention instead of the @-mention. +So !helpers will be an exclusive posting to the support group if you are connected with the group. +If you select a group from the ACL a !-mention will be added automatically to your posting. If you sort your contacts into circles, you cannot @-mention these circles. But you can select the circle in the access control when creating a new posting, to allow (or disallow) a certain circle of people to see the posting. @@ -43,7 +43,7 @@ See [Circles and Privacy](help/Circles-and-Privacy) for more details about group **Topical Tags** -Topical tags are indicated by preceding the tag name with the # character. +Topical tags are indicated by preceding the tag name with the # character. This will create a link in the post to a generalised site search for the term provided. For example, #cars will provide a search link for all posts mentioning 'cars' on your site. Topical tags are generally a minimum of three characters in length. diff --git a/doc/de/FAQ.md b/doc/de/FAQ.md index 6a4e030b01..57d5569c15 100644 --- a/doc/de/FAQ.md +++ b/doc/de/FAQ.md @@ -108,7 +108,7 @@ Zwischen der URL und dem Parameter muss ein Fragezeichen als Trennzeichen verwen Ein Beispiel: - https://social.example.com/profile/example + https://social.example.com/profile/example auf Deutsch: diff --git a/doc/de/Forums.md b/doc/de/Groups.md similarity index 98% rename from doc/de/Forums.md rename to doc/de/Groups.md index 5da5adb25f..52455cfa7f 100644 --- a/doc/de/Forums.md +++ b/doc/de/Groups.md @@ -60,4 +60,4 @@ Dies bedeutet auch, dass es nicht sinnvoll ist, mehrere Gruppen per ! in einem B Du kannst außerdem via "Wall zu Wall" einen Beitrag auf der Community-Seite bzw. in der Community-Gruppe erstellen. Kommentare, die Du an eine Community-Gruppe schickst, werden dem Originalbeitrag hinzugefügt. -Eine weitere Gruppe mit dem @-Erwähnung anzusprechen, leitet den Beitrag nicht an dieses weiter, da die Verteilung der Kommentare komplett vom Originalbeitrag bestimmt wird. \ No newline at end of file +Eine weitere Gruppe mit dem @-Erwähnung anzusprechen, leitet den Beitrag nicht an dieses weiter, da die Verteilung der Kommentare komplett vom Originalbeitrag bestimmt wird. diff --git a/doc/de/Home.md b/doc/de/Home.md index 8f6cfd92e2..91976bb282 100644 --- a/doc/de/Home.md +++ b/doc/de/Home.md @@ -16,7 +16,7 @@ Friendica - Dokumentation und Ressourcen * [Freunde finden](help/Making-Friends) * [Circles und Privatsphäre](help/Circles-and-Privacy) * [Tags und Erwähnungen](help/Tags-and-Mentions) - * [Community-Gruppen](help/Forums) + * [Community-Gruppen](help/Groups) * [Chats](help/Chats) * Weiterführende Informationen * [Account umziehen](help/Move-Account) diff --git a/doc/de/Install.md b/doc/de/Install.md index b4cade3565..3040230131 100644 --- a/doc/de/Install.md +++ b/doc/de/Install.md @@ -182,7 +182,7 @@ Sie werden stattdessen direkt in `config/local.config.php` gespeichert. Gehe im Anschluss in den Friendica-Hauptordner und führe den Kommandozeilen Befehl aus: bin/console autoinstall [--savedb] - + #### B.3: Optionen Alle Optionen werden in `config/local.config.php` gespeichert und überschreiben etwaige, zugehörige Umgebungsvariablen. diff --git a/doc/de/Making-Friends.md b/doc/de/Making-Friends.md index e777ac9810..041365103c 100644 --- a/doc/de/Making-Friends.md +++ b/doc/de/Making-Friends.md @@ -3,21 +3,21 @@ Freunde finden * [Zur Startseite der Hilfe](help) -Freundschaft kann in Friendica viele verschiedene Bedeutungen annehmen. -Aber lasst es uns einfach halten, du willst einfach mit jemandem befreundet sein. +Freundschaft kann in Friendica viele verschiedene Bedeutungen annehmen. +Aber lasst es uns einfach halten, du willst einfach mit jemandem befreundet sein. Wie machst du das? -Schau dir das Verzeichnis an. -Das Verzeichnis ist in zwei Teile aufgeteilt. -Wenn du auf den "Verzeichnis"-Button klickst, wirst du zunächst alle Mitglieder deines Servers sehen, die sich dazu entschlossen haben, angezeigt zu werden. -Außerdem siehst du dort einen Link zum globalen Verzeichnis. -Wenn du dich durch das globale Verzeichnis klickst, siehst du alle Nutzer weltweit auf allen Servern, die sich entschlossen haben, im Verzeichnis zu erscheinen. -Du wirst außerdem den Link "Show Community Groups" sehen, welcher dich zu Gruppen und Fan-Seiten führt. +Schau dir das Verzeichnis an. +Das Verzeichnis ist in zwei Teile aufgeteilt. +Wenn du auf den "Verzeichnis"-Button klickst, wirst du zunächst alle Mitglieder deines Servers sehen, die sich dazu entschlossen haben, angezeigt zu werden. +Außerdem siehst du dort einen Link zum globalen Verzeichnis. +Wenn du dich durch das globale Verzeichnis klickst, siehst du alle Nutzer weltweit auf allen Servern, die sich entschlossen haben, im Verzeichnis zu erscheinen. +Du wirst außerdem den Link "Show Community Groups" sehen, welcher dich zu Gruppen und Fan-Seiten führt. Du verbindest dich mit Personen und Gruppen auf die gleiche Art, wobei Gruppen deine Anfrage automatisch annehmen, wohingegen ein Mensch dich erst manuell bestätigen muss. *Mit anderen Friendica-Nutzern verbinden* -Bes‪uche ihr Profil. +Besuche ihr Profil. Direkt unter dem Profilfoto ist das Wort "Verbinden" (bzw. "Connect" in einem englischsprachigem Profil). Klicke drauf und du gelangst zur "Verbinden"-Seite. Dort wirst du nach deiner Identitätsadresse gefragt. diff --git a/doc/de/Quick-Start-groupsandpages.md b/doc/de/Quick-Start-groupsandpages.md index 8c9d0664c0..d4ea55d3d0 100644 --- a/doc/de/Quick-Start-groupsandpages.md +++ b/doc/de/Quick-Start-groupsandpages.md @@ -1,4 +1,4 @@ -Gruppen und Seiten +Gruppen und Seiten ========== * [Zur Startseite der Hilfe](help) @@ -21,6 +21,6 @@ Solltest Du beim Stöbern durch die vielen Gruppen nicht wieder hierher zurück Wenn Du einige Gruppen hinzugefügt hast, gehe weiter zum nächsten Schritt. - + diff --git a/doc/de/groupsandpages.md b/doc/de/groupsandpages.md deleted file mode 100644 index a65dab906b..0000000000 --- a/doc/de/groupsandpages.md +++ /dev/null @@ -1,26 +0,0 @@ -Gruppen und Seiten -========== - -* [Zur Startseite der Hilfe](help) - -Hier siehst du das globale Verzeichnis. -Wenn du dich mal verirrt hast, kannst du diesen Link klicken und wieder hierher kommen. - -Auf dieser Seite findest du eine Zusammenstellung von Gruppen, Foren und bekannten Seiten. -Gruppen sind keine realen Personen. -Sich mit diesen zu verbinden ist, als wenn man jemanden auf Facebook "liked" ("gefällt mir") oder wenn man sich in einem Forum anmeldet. -Habe keine Sorge, falls du dich unbehaglich fühlst, wenn du dich einer neuen Person vorstellen sollst, da es sich nicht um Personen handelt. - -Wenn du dich mit einer Gruppe verbindest, erscheinen alle Nachrichten der Gruppe in deinem "Netzwerk"-Tab. -Du kannst diese Beiträge kommentieren oder selbst in der Gruppe schreiben, ohne eine der Gruppenmitglieder persönlich hinzuzufügen. -Das ist ein großartiger Weg, dynamisch neue Freunde zu gewinnen. -Du findest Personen, die du magst, anstatt Fremde hinzuzufügen. -Suche dir einfach eine Gruppe und füge sie so hinzu, wie du auch normale Freunde hinzufügst. -Es gibt eine Menge Gruppen und möglicherweise findest du nicht wieder zu dieser Seite zurück. -In diesem Fall nutze einfach den Link oben auf dieser Seite. - -Wenn du einige Gruppen hinzugefügt hast, gehe weiter zum nächsten Schritt. - - - -