Mirror
/
zulip
mirror of https://github.com/zulip/zulip.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
zulip/templates/zerver/help/stream-permissions.md

109 lines
4.9 KiB
Markdown
Raw Normal View History

user docs: Add doc for stream privacy settings.
2018-05-22 19:34:42 +02:00
# Stream privacy settings
user docs: Explain streams are similar to channels in stream-permissions.
2018-07-27 03:49:26 +02:00
Streams are similar to chatrooms, IRC channels, or email lists in that they
determine who receives a message. There are three types of streams in Zulip.
user docs: Add doc for stream privacy settings.
2018-05-22 19:34:42 +02:00
help: Clarify documentation on guest users and streams. This tries to make it more immediately clear facts like that guests cannot see public streams.
2021-04-09 17:48:18 +02:00
* **Public**: Members can join and view the complete message history.
help: Clarify guest users on public streams. The previous language was unclear that we were talking about how the features interacted, but the users.
2021-04-19 23:37:31 +02:00
Public streams are visible to Guest users only if they are
subscribed (exactly like private streams with shared history).
user docs: Add doc for stream privacy settings.
2018-05-22 19:34:42 +02:00
help: Clarify documentation on guest users and streams. This tries to make it more immediately clear facts like that guests cannot see public streams.
2021-04-09 17:48:18 +02:00
* **Private, shared history**: You must be added by a member of the
stream. The complete message history is available as soon as you are
added.
user docs: Add doc for stream privacy settings.
2018-05-22 19:34:42 +02:00
* **Private, protected history**: You must be added by a member of the
stream. You only have access to the messages that are sent after you are added.
## Privacy model for private streams
At a high level:
help: Add basic documentation of organization owners.
2020-06-10 22:42:20 +02:00
* Organization owners and administrators can see and modify most
aspects of a private stream, including the membership and estimated
traffic. Owners and administrators generally cannot see private
stream messages or do things that would give them access to private
stream messages, like adding new subscribers or changing the stream
privacy settings.
help: Add basic documentation for organization moderators. We'll extend this in the future with details on what is configurable, but this at least ensures we don't have a state where they don't appear in our documentation at all.
2021-04-30 00:49:02 +02:00
* [Organization members and moderators](/help/roles-and-permissions)
cannot easily see which private streams exist, or interact with them
in any way until they are added. Given a stream name, they can
figure out whether a stream with that name exists, but cannot see
any other details about the stream.
user docs: Add doc for stream privacy settings.
2018-05-22 19:34:42 +02:00
help: Clarify documentation on guest users and streams. This tries to make it more immediately clear facts like that guests cannot see public streams.
2021-04-09 17:48:18 +02:00
* From the perspective of a guest, all streams are private streams,
and they additionally can't add other members to the streams they
are subscribed to.
user docs: Update docs to reflect new guests feature.
2018-10-30 06:40:33 +01:00
help: Add basic documentation of organization owners.
2020-06-10 22:42:20 +02:00
There are two situations in which an organization owner or
administrator can access private stream messages:
user docs: Update stream-permissions to note message access via bots.
2018-10-20 00:33:09 +02:00
* Via some types of [data export](/help/export-your-organization).
help: Add basic documentation of organization owners.
2020-06-10 22:42:20 +02:00
* Owners and administrators can change the ownership of a bot. If a
bot is subscribed to a private stream, then an administrator can get
access to that stream by taking control of the bot, though the
access will be limited to what the bot can do. (E.g. incoming
webhook bots cannot read messages.)
user docs: Update stream-permissions to note message access via bots.
2018-10-20 00:33:09 +02:00
user docs: Add doc for stream privacy settings.
2018-05-22 19:34:42 +02:00
## Detailed permissions
### Public streams
help: Improve alignment for markdown tables.
2021-05-01 06:24:33 +02:00
<div class="centered_table"></div>
help: Add basic documentation for organization moderators. We'll extend this in the future with details on what is configurable, but this at least ensures we don't have a state where they don't appear in our documentation at all.
2021-04-30 00:49:02 +02:00
| | Owners and admins | Moderators | Members | Guests
|--- |--- | |--- |---
| View stream name | &#10004; | &#10004; | &#10004; | &#9726;
| Join | &#10004; | &#10004; | &#10004; |
| Unsubscribe | &#9726; | &#9726; | &#9726; | &#9726;
| Add others | &#10004; | &#10004; | &#10004; |
| See subscriber list | &#10004; | &#10004; | &#10004; | &#9726;
| See full history | &#10004; | &#10004; | &#10004; | &#9726;
| See estimated traffic | &#10004; | &#10004; | &#10004; | &#9726;
| Post | &#10004; | &#10038; | &#10038; | &#10038;
| Change the privacy | &#10004; | | |
| Rename | &#10004; | | |
| Edit the description | &#10004; | | |
| Remove others | &#10004; | | |
| Delete | &#10004; | | |
help: Reorganize stream-permissions table.
2019-03-02 01:02:16 +01:00
&#10004; Always
help: Remove nbsp formatting from stream-permissions. This doesn't look good, but it does look better and deletes code.
2021-04-09 17:50:55 +02:00
&#9726; If subscribed to the stream
help: Reorganize stream-permissions table.
2019-03-02 01:02:16 +01:00
help: Add basic documentation of organization owners.
2020-06-10 22:42:20 +02:00
&#10038; [Configurable](/help/stream-sending-policy). Owners,
Administrators, and Members can, by default, post to any public
stream, and Guests can only post to public streams if they are
subscribed.
user docs: Document admin-only posting in stream-permissions.md.
2018-05-31 22:25:52 +02:00
user docs: Add doc for stream privacy settings.
2018-05-22 19:34:42 +02:00
### Private streams
help: Improve alignment for markdown tables.
2021-05-01 06:24:33 +02:00
<div class="centered_table"></div>
help: Add basic documentation for organization moderators. We'll extend this in the future with details on what is configurable, but this at least ensures we don't have a state where they don't appear in our documentation at all.
2021-04-30 00:49:02 +02:00
| | Owners and admins | Moderators | Members | Guests
|--- |--- | |--- |---
| View stream name | &#10004; | &#9726; | &#9726; | &#9726;
| Join | | | |
| Unsubscribe | &#9726; | &#9726; | &#9726; | &#9726;
| Add others | &#9726; | &#9726; | &#9726; |
| See subscriber list | &#10004; | &#9726; | &#9726; | &#9726;
| See full history | &#10038; | &#10038; | &#10038; | &#10038;
| See estimated traffic | &#10004; | &#9726; | &#9726; | &#9726;
| Post | &#9726; | &#10038; | &#10038; | &#10038;
| Change the privacy | &#9726; | | |
| Rename | &#10004; | | |
| Edit the description | &#10004; | | |
| Remove others | &#10004; | | |
| Delete | &#10004; | | |
user docs: Update docs to reflect new guests feature.
2018-10-30 06:40:33 +01:00
help: Reorganize stream-permissions table.
2019-03-02 01:02:16 +01:00
&#10004; Always
user docs: Document admin-only posting in stream-permissions.md.
2018-05-31 22:25:52 +02:00
help: Remove nbsp formatting from stream-permissions. This doesn't look good, but it does look better and deletes code.
2021-04-09 17:50:55 +02:00
&#9726; If subscribed to the stream
user docs: Add doc for stream privacy settings.
2018-05-22 19:34:42 +02:00
settings: Migrate to stream_post_policy structure. This commit includes a new `stream_post_policy` setting, by replacing the `is_announcement_only` field from the Stream model, which is done by mirroring the structure of the existing `create_stream_policy`. It includes the necessary schema and database migrations to migrate the is_announcement_only boolean field to stream_post_policy, a smallPositiveInteger field similar to many other settings. This change is done to allow organization administrators to restrict new members from creating and posting to a stream. However, this does not affect admins who are new members. With many tweaks by tabbott to documentation under /help, etc. Fixes #13616.
2020-02-04 21:50:55 +01:00
&#10038; [Configurable](/help/stream-sending-policy), but at minimum
must be subscribed to the stream.
docs: Inter-link documentation mentioning guests. Make it easier to understand what guests are allowed to do, and how to make them, by cross-linking the documentation which mentions them.
2020-05-22 02:04:34 +02:00
## Related articles
* [Roles and permissions](/help/roles-and-permissions)
* [Stream sending policy](/help/stream-sending-policy)