diff options
Diffstat (limited to 'doc/feature')
| -rw-r--r-- | doc/feature/access_tokens.bb | 47 | ||||
| -rw-r--r-- | doc/feature/additional/access.md | 41 | ||||
| -rw-r--r-- | doc/feature/additional/composition.md | 67 | ||||
| -rw-r--r-- | doc/feature/additional/filtering.md | 57 | ||||
| -rw-r--r-- | doc/feature/additional/general.md | 130 | ||||
| -rw-r--r-- | doc/feature/additional/overview.md | 33 | ||||
| -rw-r--r-- | doc/feature/additional/posts.md | 57 |
7 files changed, 0 insertions, 432 deletions
diff --git a/doc/feature/access_tokens.bb b/doc/feature/access_tokens.bb deleted file mode 100644 index eb5c03717..000000000 --- a/doc/feature/access_tokens.bb +++ /dev/null @@ -1,47 +0,0 @@ -Feature: Zot Access Tokens -Status: Draft -Date: 15 July 2016 - - -Purpose: - -In order to facilitate sharing of private resources with non-members or members of federation nodes with limited identification discovery, Hubzilla should provide members with a mechanism to create and manage temporary ("throwaway") logins, aka "Zot Access Tokens". These tokens/credentials may be used to authenticate to a hubzilla site for the sole purpose of accessing privileged or access controlled resources (files, photos, posts, webpages, chatrooms, etc.). - - -Scope: - -Zot Access Tokens do not convey membership in the site or network. In particular, they do not provide an account or channel; which may be necessary to interact with the hub owner or with others in the network or federation of networks. In most cases they can only be used to consume restricted resources and do not have an ability to create those resources, however this ability may be provided by custom configurations or in future releases or addons. - -For instance the ability for a temporary login to access a chatroom may provide suitable permission to create chat messages inside that chatroom. - - -Implementation: - -Zot Access Tokens are managed through a "tab" of the settings page. Access to this tab may be controlled by site configuration. On this page, channels may create, edit, list, and remove any access tokens under their control. - -The form to create/edit accepts three parameters, a human readable name, a password or access token, and an optional expiration. Once expired, the access token is no longer valid, may no longer be used, and will be automatically purged from the list of temporary accounts. The password field in the create/edit forms displays the text of the access token and not an obscured password. By default we will create a token using the autoname() function, which generally produces a random character sequence which is "pronounceable", hence easy to convey or remember. This can be changed to any other character sequence which is acceptable to the site password complexity policy. (In most Hubzilla installations this imposes a minimum of three characters, but may be extended by plugin or site policy). - - -Usage: - -We do not specify mechanisms for sharing these tokens with others. Any communication method may be used. Any tokens you have created are added to the Access Control List selector and may be used anywhere that Access Control Lists are provided. - - Example: A visitor arrives at your site. She has an access token you have provided, and attempts to visit one of your photo albums (which is restricted to be viewed only by yourself and one temporary identity). Permission is denied. - -The visitor now selects "Login" from the menu navigation bar. This presents a login page. She enters the name and password you have provided her, and she can now view the restricted photo album. - - -Alternatively, you may share a link to a protected file by adding a parameter "&zat=abc123" to the URL, where the string "abc123" is the access token or password for the temporary login. No further negotiation is required, and the file is presented. - -Zot Acess Tokens are represented internally as an authenticated "observer". Querying the observer in code should return a pseudo or system generated xchan with an unknown protocol and a default profile photo. It will match (successfully) any access control rule which allows authenticated observers. - -Security Considerations: - -The URL form of authentication is inherently less secure than using a login, but may be preferable for some uses of this feature. It probably should not be transmitted over non-SSL links. - - -Future development: - -It might be desirable for future implementations to provide an options for single-use, where the access token is removed promptly following first use. - -
\ No newline at end of file diff --git a/doc/feature/additional/access.md b/doc/feature/additional/access.md deleted file mode 100644 index b7f0df717..000000000 --- a/doc/feature/additional/access.md +++ /dev/null @@ -1,41 +0,0 @@ -## Access Control and Permissions - - -### Privacy Groups - -Enable management and selection of privacy groups. -<!-- TODO: full description for Privacy Groups --> - -Minimum required technical skill level to see this feature: 0 - - -### Multiple Profiles - -Ability to create multiple profiles. -<!-- TODO: full description for Multiple Profiles --> - -Minimum required technical skill level to see this feature: 3 - - -### Permission Categories - -Provide alternate connection permission limits. -<!-- TODO: full description for Permission Categories --> - -Minimum required technical skill level to see this feature: 2 - - -### OAuth Clients - -Manage authenticatication tokens for mobile and remote apps. -<!-- TODO: full description for OAuth Clients --> - -Minimum required technical skill level to see this feature: 1 - - -### Access Tokens - -Create access tokens so that non-members can access private content. -<!-- TODO: full description for Access Tokens --> - -Minimum required technical skill level to see this feature: 2 diff --git a/doc/feature/additional/composition.md b/doc/feature/additional/composition.md deleted file mode 100644 index 1256f7501..000000000 --- a/doc/feature/additional/composition.md +++ /dev/null @@ -1,67 +0,0 @@ -## Post Composition Features - - -### Large Photos - -Include large (1024px) photo thumbnails in posts. -If not enabled, use small (640px) photo thumbnails -<!-- TODO: full description for Large Photos --> - -Minimum required technical skill level to see this feature: 1 - - -### Channel Sources - -Automatically import channel content from other channels or feeds -<!-- TODO: full description for Channel Sources --> - -Minimum required technical skill level to see this feature: 3 - - -### Even More Encryption - -Allow optional encryption of content end-to-end with a shared secret key -<!-- TODO: full description for Even More Encryption --> - -Minimum required technical skill level to see this feature: 3 - - -### Enable Voting Tools - -Provide a class of post which others can vote on -<!-- TODO: full description for Enable Voting Tools --> - -Minimum required technical skill level to see this feature: 3 - - -### Disable Comments - -Provide the option to disable comments for a post -<!-- TODO: full description for Disable Comments --> - -Minimum required technical skill level to see this feature: 2 - - -### Delayed Posting - -Allow posts to be published at a later date -<!-- TODO: full description for Delayed Posting --> - -Minimum required technical skill level to see this feature: 2 - - -### Content Expiration - -Remove posts/comments and/or private messages at a future time -<!-- TODO: full description for Content Expiration --> - -Minimum required technical skill level to see this feature: 1 - - -### Suppress Duplicate Posts/Comments - -Prevent posts with identical content to be published -with less than two minutes in between submissions. -<!-- TODO: full description for Suppress Duplicate Posts/Comments --> - -Minimum required technical skill level to see this feature: 1 diff --git a/doc/feature/additional/filtering.md b/doc/feature/additional/filtering.md deleted file mode 100644 index ba8e1e29f..000000000 --- a/doc/feature/additional/filtering.md +++ /dev/null @@ -1,57 +0,0 @@ -## Network and Stream Filtering - - -### Search by Date - -Ability to select posts by date ranges -<!-- TODO: full description for Search by Date --> - -Minimum required technical skill level to see this feature: 1 - - -### Saved Searches - -Save search terms for re-use -<!-- TODO: full description for Saved Searches --> - -Minimum required technical skill level to see this feature: 2 - - -### Network Personal Tab - -Enable tab to display only Network posts that you've interacted on -<!-- TODO: full description for Network Personal Tab --> - -Minimum required technical skill level to see this feature: 1 - - -### Network New Tab - -Enable tab to display all new Network activity -<!-- TODO: full description for Network New Tab --> - -Minimum required technical skill level to see this feature: 2 - - -### Affinity Tool - -Filter stream activity by depth of relationships -<!-- TODO: full description for Affinity Tool --> - -Minimum required technical skill level to see this feature: 1 - - -### Suggest Channels - -Show friend and connection suggestions -<!-- TODO: full description for Suggest Channels --> - -Minimum required technical skill level to see this feature: 1 - - -### Connection Filtering - -Filter incoming posts from connections based on keywords/content -<!-- TODO: full description for Connection Filtering --> - -Minimum required technical skill level to see this feature: 3 diff --git a/doc/feature/additional/general.md b/doc/feature/additional/general.md deleted file mode 100644 index a1b712b12..000000000 --- a/doc/feature/additional/general.md +++ /dev/null @@ -1,130 +0,0 @@ -## General Features - - -### New Member Links - -Display new member quick links menu. -<!-- TODO: full description for New Member Links --> - -Minimum required technical skill level to see this feature: 1 - - -### Advanced Profiles - -Additional profile sections and selections -<!-- TODO: full description for Advanced Profiles --> - -Minimum required technical skill level to see this feature: 1 - - -### Profile Import/Export - -Save and load profile details across sites/channels -<!-- TODO: full description for Profile Import/Export --> - -Minimum required technical skill level to see this feature: 3 - - -### Web Pages - -Provide managed web pages on your channel -<!-- TODO: full description for Web Pages --> - -Minimum required technical skill level to see this feature: 3 - - -### Wiki - -Provide a wiki for your channel -<!-- TODO: full description for Wiki --> - -Minimum required technical skill level to see this feature: 2 - - -### Private Notes - -Enables a tool to store notes and reminders (note: not encrypted) -<!-- TODO: full description for Private Notes --> - -Minimum required technical skill level to see this feature: 1 - - -### Cards - -Create personal planning cards -<!-- TODO: full description for Cards --> - -Minimum required technical skill level to see this feature: 1 - - -### Articles - -Create interactive articles -<!-- TODO: full description for Articles --> - -Minimum required technical skill level to see this feature: 1 - - -### Navigation Channel Select - -Change channels directly from within the navigation dropdown menu -<!-- TODO: full description for Navigation Channel Select --> - -Minimum required technical skill level to see this feature: 3 - - -### Photo Location - -If location data is available on uploaded photos, link this to a map. -<!-- TODO: full description for Photo Location --> - -Minimum required technical skill level to see this feature: 2 - - -### Access Controlled Chatrooms - -Provide chatrooms and chat services with access control. -<!-- TODO: full description for Access Controlled Chatrooms --> - -Minimum required technical skill level to see this feature: 1 - - -### Smart Birthdays - -Make birthday events timezone aware in case your friends are scattered across the planet. -<!-- TODO: full description for Smart Birthdays --> - -Minimum required technical skill level to see this feature: 2 - - -### Event Timezone Selection - -Allow event creation in timezones other than your own. -<!-- TODO: full description for Event Timezone Selection --> - -Minimum required technical skill level to see this feature: 2 - - -### Premium Channel - -Allows you to set restrictions and terms -on those that connect with your channel -<!-- TODO: full description for Premium Channel --> - -Minimum required technical skill level to see this feature: 4 - - -### Advanced Directory Search - -Allows creation of complex directory search queries -<!-- TODO: full description for Advanced Directory Search --> - -Minimum required technical skill level to see this feature: 4 - - -### Advanced Theme and Layout Settings - -Allows fine tuning of themes and page layouts -<!-- TODO: full description for Advanced Theme and Layout Settings --> - -Minimum required technical skill level to see this feature: 4 diff --git a/doc/feature/additional/overview.md b/doc/feature/additional/overview.md deleted file mode 100644 index b51f60bcd..000000000 --- a/doc/feature/additional/overview.md +++ /dev/null @@ -1,33 +0,0 @@ -[chset]: /settings "Channel Settings" -[ftset]: /settings/features "Additional Features Settings" -[ftgen]: /help/feature/additional/general "General Features" -[ftacc]: /help/feature/additional/access "Access Control and Permissions" -[ftcom]: /help/feature/additional/composition "Post Composition Features" -[ftfil]: /help/feature/additional/filtering "Network and Stream Filtering" -[ftpos]: /help/feature/additional/posts "Post/Comment Tools" - - -# Additional Features - -<!-- TODO: Introduction to additional features --> - -<!-- TODO: Short info and crosslink on techlevels --> - -You can switch the features on and off from the -[Additional Features][ftset] link in the [Channel Settings][chset]. - -<!-- TODO: Infos about feature visibility and causes/dependencies --> - -The following pages decribe all the available features -grouped in the same way as they are with the accordion tabs on the -[Additional Features][ftset] settings page: - -[General Features][ftgen] - -[Access Control and Permissions][ftacc] - -[Post Composition Features][ftcom] - -[Network and Stream Filtering][ftfil] - -[Post/Comment Tools][ftpos] diff --git a/doc/feature/additional/posts.md b/doc/feature/additional/posts.md deleted file mode 100644 index d3f6b37db..000000000 --- a/doc/feature/additional/posts.md +++ /dev/null @@ -1,57 +0,0 @@ -## Post/Comment Tools - - -### Community Tagging - -Ability to tag existing posts -<!-- TODO: full description for Community Tagging --> - -Minimum required technical skill level to see this feature: 1 - - -### Post Categories - -Add categories to your posts -<!-- TODO: full description for Post Categories --> - -Minimum required technical skill level to see this feature: 1 - - -### Emoji Reactions - -Add emoji reaction ability to posts -<!-- TODO: full description for Emoji Reactions --> - -Minimum required technical skill level to see this feature: 1 - - -### Saved Folders - -Ability to file posts under folders -<!-- TODO: full description for Saved Folders --> - -Minimum required technical skill level to see this feature: 2 - - -### Dislike Posts - -Ability to dislike posts/comments -<!-- TODO: full description for Dislike Posts --> - -Minimum required technical skill level to see this feature: 1 - - -### Star Posts - -Ability to mark special posts with a star indicator -<!-- TODO: full description for Star Posts --> - -Minimum required technical skill level to see this feature: 1 - - -### Tag Cloud - -Provide a personal tag cloud on your channel page -<!-- TODO: full description for Tag Cloud --> - -Minimum required technical skill level to see this feature: 2 |