From 1a118a08288fcf6f4a84f2996a0adf5b0b7d9aa5 Mon Sep 17 00:00:00 2001 From: Tobias Luther Date: Sun, 29 Jun 2014 21:07:42 +0200 Subject: Tidied the folder from old backups created new files for a quick explanation of the use of accounts, profiles, channels added FAQ for users, admins and developers (the last one might not be exactly necessary?) created a file to explain posting for new users created new file to explain nomadic identities for users modified main.bb --- doc/accounts_profiles_channels_basics.bb | 17 ++++++++++++++++- doc/encryption.bb | 16 ++++++++++++++++ doc/faq_admins.bb | 8 ++++++++ doc/faq_developers.bb | 28 ++++++++++++++++++++++++++++ doc/faq_users.bb | 13 +++++++++++++ doc/first-post.bb | 3 +++ doc/main.bb | 22 ++++++++++++++-------- doc/nomadic-identity.bb | 1 + 8 files changed, 99 insertions(+), 9 deletions(-) create mode 100644 doc/encryption.bb create mode 100644 doc/faq_admins.bb create mode 100644 doc/faq_developers.bb create mode 100644 doc/faq_users.bb create mode 100644 doc/first-post.bb create mode 100644 doc/nomadic-identity.bb (limited to 'doc') diff --git a/doc/accounts_profiles_channels_basics.bb b/doc/accounts_profiles_channels_basics.bb index b3ba2ef6d..6ba34e771 100644 --- a/doc/accounts_profiles_channels_basics.bb +++ b/doc/accounts_profiles_channels_basics.bb @@ -1,4 +1,19 @@ -This still needs to be written +[size=large][b]Accounts, Profiles and Channels[/b][/size] + +Once you have registered an [i]account[/i] at the matrix you have also created a [i]profile[/i] and a [i]channel[/i]. + +[b]Account[/b] +You have [i]one[/i] account. This consists of your email account and your password. With your account you access your profile and your channel. +[i]Think of your account as the way you authenticate at one Red Matrix site. It lets you do things, such as creating profiles and channels with which you can connect to other people.[/i] + +[b]Profile[/b] +You surely have registered with some other internet services, such as forums or online communities. For all of them you provided some information about yourself, such as date of birth, country, age and the likes. If you like you can see your profile here: [baseurl]/profile/[observer.name] and edit it by clicking on the pencil icon next to your avatar image. +Unlike other services Red Matrix offers you the advantage of creating [i]many more profiles[/i]. That way you are able to distinguish between profiles targeted specially at everyone (your public profile), at your work mates, your family and your partner. +[i]Think of your profile as the basic information about yourself you tell other people.[/i] + +[b]Channel[/b] +During the registration you created your first [i]channel[/i]. Yes, besides several profiles you are able to have several channels. This might be a bit confusing in the beginning, but let's clear things up. You already have created one channel. You can use this one for the public, to communicate with people about every day life. But you are an avid book reader and many people are bored by that. So you open a [i]second channel[/i] just for the book lovers, where you all can talk about books as much as you like. Obviously this is a new stream of posts, with a new profile (... or new profile[i]s[/i] ...) and completely different contacts. Some connections might exist in both channels, but there will be some that are exclusive to only one of both. You yourself just switch between both of them just like you would in real life switch when talking to people you meet on the street or people you meet specially to talk about books. You can even connect to yourself, or better: to your other channel. :) +[i]Think of a channel as different spaces dedicated to different topics where you meet with different people.[/i] Return to the [url=[baseurl]/help/main]Main documentation page[/url] diff --git a/doc/encryption.bb b/doc/encryption.bb new file mode 100644 index 000000000..3eee7a452 --- /dev/null +++ b/doc/encryption.bb @@ -0,0 +1,16 @@ +[size=large]Builtin Automatic Encryption Plus Super-Safe Encryption[/size] + +Full disclosure: The encryption Red Matrix uses per default is not absolutely waterproof. There [i]are[/i] known procedures to circumvent it. [i]But[/i] this takes a lot of effort and needs to be done individually for each channel. And to make this clear: Other services store your messages in plaintext, therefore we regard this approach as a [i]significant[/i] improvement for your privacy. Plus you are always free to use further encryption and password protection if you so desire. + +To explain this in more detail: + +- each channel has its key pair +- every non-public post is automatically encrypted +- optional password protected super-safe encryption (needs to be enabled in settings) + +So what is the scope of security? Full disclosure: This might be great, but it is not perfect. +- every non-public post is automatically encrypted but persons who have access to the site's database and files [i]may[/i] be able to decrypt everything by usig these keys which obviously need to be stored on the server. To be clear: The encrypion keys are different for every channel and it is [i]quite an effort[/i] to do this. And again: Other services store your messages in plain text unencrypted. So this [i]is[/i] quite a significant win for your privacy. +So if you require super tight encryption enable ... and protect your posting with a password only you and the adressee(s) know. This way even people with access to the database and server ... + + +... needs to be written ... diff --git a/doc/faq_admins.bb b/doc/faq_admins.bb new file mode 100644 index 000000000..0bff9983a --- /dev/null +++ b/doc/faq_admins.bb @@ -0,0 +1,8 @@ +[size=large][b]The Red Matrix FAQ[/b][/size] + +(...) still needs to be written (...) + +[ul] +[*][b]Is there a way to change the Admin account?[/b] +Yes. (...) +[/ul] diff --git a/doc/faq_developers.bb b/doc/faq_developers.bb new file mode 100644 index 000000000..192dcb5c5 --- /dev/null +++ b/doc/faq_developers.bb @@ -0,0 +1,28 @@ +[size=large][b]Frequently Asked Questions For Developers[/b][/size] + +(...) still needs to be written (...) + +[ul] +[*][b]What does $a mean?[/b] +$a is a class defined in boot.php and passed all around Red Matrix as a global reference variable. It defines everything necessary for the Red Matrix application: Server variables, URL arguments, page structures, layouts, content, installed plugins, output device info, theme info, identity of the observer and (potential) page owner ... +We don't ever create more than one instance and always modify the elements of the single instance. The mechanics of this are somewhat tricky. If you have a function that is passed $a and needs to modify $a you need to declare it as a reference with '&' e.g. + +[code]function foo(&$a) { $a->something = 'x'; // whatever }; + +*or* access it within your function as a global variable via get_app() + +function foo() { + $a = get_app(); + $a->something = 'x'; +} + + +function foo($a) { $a->something = 'x'; }; + +will *not* change the global app state. + +function foo() { + get_app()->something = 'x'; +} +[/code] +[/ul] diff --git a/doc/faq_users.bb b/doc/faq_users.bb new file mode 100644 index 000000000..405a2e8f9 --- /dev/null +++ b/doc/faq_users.bb @@ -0,0 +1,13 @@ +[size=large][b]The Red Matrix FAQ[/b][/size] + +(...) still needs to be written (...) + +[ul] +[*][b]I am able to edit a post's text after I saved it, but is there a way to change the permissions?[/b] +Short anser: No, there isn't. This has got some resons. You are able to change permissons to your files, photos and the likes, but not to posts after you have saved them. The reason is: Once you have saved a post it is being distributed either to the public channel and from there to other Red Matrix servers or to those you intended it to go. Just like you cannot reclaim a few after you have sold them off to some people, you cannot change permissions to Red Matrix posts. We would need to track everywhere your posting goes, keep track of everyone you allowed to see it and then keep track of from whom to delete it. +If a posting is public this is even harder, as the Red Matrix is a global network and there is no way to follow a post, let alone reclaim it reliably. +Once you have sent out an email there too is no way to take it back. So think wisely and keep alert when posting. :) +[*][b]I downloaded my channel and uploaded it to another site but there is no content, no posts, no photos. What is wrong???[/b] +To be honest: Nothing. That's the way it is right now. Technically it is surely possible to take at least your own posts and maybe even files with you, but this has simply put not implemented yet. When creating this feature we thought that keeping all your contacts was more important. Once we find someone willing to implement this, it will be done. :) +[*] +[/ul] diff --git a/doc/first-post.bb b/doc/first-post.bb new file mode 100644 index 000000000..cf6ed5b49 --- /dev/null +++ b/doc/first-post.bb @@ -0,0 +1,3 @@ +[size=large]Your first posting[/size] + +... to be written ... diff --git a/doc/main.bb b/doc/main.bb index b8520c5be..45c45139c 100644 --- a/doc/main.bb +++ b/doc/main.bb @@ -13,17 +13,17 @@ Think of standalone family communication platforms, distributed online communiti Zot is the great new communicaton protocol invented especially for the Red Matrix. As a user you are no longer bound to a single hoster thanks to "Nomadic Identities". Migrate easily to another server and keep your contacts intact, or clone it and run the same channel on several servers. Just in case one of them might shut down, you don't lose out. Plus once you are inside the Red Matrix there is no need for you to authenticate twice, even when accessing another Red Matrix site. Zot is what sets the Red Matrix apart. [size=large][b]Getting Started[/b][/size] - [zrl=[baseurl]/help/registration]Account Registration[/zrl] +[zrl=[baseurl]/help/accounts_profiles_channels_basics]You at the Red Matrix: accounts, profiles and channels in short[/zrl] [zrl=[baseurl]/help/profiles]Profiles[/zrl] [zrl=[baseurl]/help/channels]Channels[/zrl] -[zrl=[baseurl]/help/connecting_to_channels]Connecting to Channels[/zrl] -[zrl=[baseurl]/help/permissions]Permissions[/zrl] +[zrl=[baseurl]/help/first-post]Your first posting[/zrl] +[zrl=[baseurl]/help/connecting_to_channels]Connecting To Other Channels[/zrl] +[zrl=[baseurl]/help/permissions]Permissions And Encryption: You Are In Control[/zrl] [zrl=[baseurl]/help/cloud]Cloud Storage[/zrl] [zrl=[baseurl]/help/remove_account]Remove Account[/zrl] [size=large][b]Using the Red Matrix[/b][/size] - [zrl=[baseurl]/help/tags_and_mentions]Tags and Mentions[/zrl] [zrl=[baseurl]/help/webpages]Web Pages[/zrl] [zrl=[baseurl]/help/bbcode]BBcode reference for posts and comments[/zrl] @@ -31,18 +31,22 @@ Zot is the great new communicaton protocol invented especially for the Red Matri [zrl=[baseurl]/help/cloud_desktop_clients]Cloud Desktop Clients[/zrl] [zrl=[baseurl]/help/AdvancedSearch]Advanced Directory Search[/zrl] [zrl=[baseurl]/help/addons]Help With Addons[/zrl] +[zrl=[baseurl]/help/nomadic-identity]Got Zot? Nomadic Identity, Channel Cloning And More[/zrl] -[size=large][b]For Hub Administrators[/b][/size] +[size=large][b]Frequently Asked Questions For Users[/b][/size] +[zrl=[baseurl]/help/faq_users]FAQ For Users[/zrl] +[size=large][b]For Hub Administrators[/b][/size] [zrl=[baseurl]/help/install]Install[/zrl] [zrl=[baseurl]/help/debian_install]Easy Install on Debian via script[/zrl] [zrl=[baseurl]/help/red2pi]Installing Red on the Raspberry Pi[/zrl] [zrl=[baseurl]/help/problems-following-an-update]Problems Following A Software Update[/zrl] [zrl=[baseurl]/help/troubleshooting]Troubleshooting Tips[/zrl] +[size=large][b]Frequently Asked Questions For Hub Admins[/b][/size] +[zrl=[baseurl]/help/faq_admins]FAQ For Admins[/zrl] [size=large][b]Technical Documentation[/b][/size] - [zrl=[baseurl]/help/comanche]Comanche Page Descriptions[/zrl] [zrl=[baseurl]/help/Creating-Templates]Creating Comanche Templates[/zrl] [zrl=[baseurl]/help/Widgets]Core Widgets[/zrl] @@ -59,13 +63,15 @@ Zot is the great new communicaton protocol invented especially for the Red Matri [zrl=[baseurl]/help/to_do_code]To-Do list for Developers[/zrl] [zrl=[baseurl]/help/git_for_non_developers]Git for Non-Developers[/zrl] -[size=large][b]External Resources[/b][/size] +[size=large][b]Frequently Asked Questions For Developers[/b][/size] +[zrl=[baseurl]/help/faq_developers]FAQ For Developers[/zrl] + +[size=large][b]External Resources[/b][/size] [zrl=[baseurl]/help/external-resource-links]External Resource Links[/zrl] [url=https://github.com/friendica/red]Main Website[/url] [url=https://github.com/friendica/red-addons]Addon Website[/url] [url=https://zothub.com/channel/one]Development Channel[/url] [size=large][b]About This Red Matrix Site[/b][/size] - [zrl=[baseurl]/siteinfo] [baseurl]/siteinfo[/zrl] diff --git a/doc/nomadic-identity.bb b/doc/nomadic-identity.bb new file mode 100644 index 000000000..a062e58c8 --- /dev/null +++ b/doc/nomadic-identity.bb @@ -0,0 +1 @@ +This still needs to be written. -- cgit v1.2.3