zulip/help/stream-permissions.md

128 lines
6.1 KiB
Markdown

# Stream privacy settings
Streams are similar to chat rooms, IRC channels, or email lists in that they
determine who receives a message. Zulip supports a few types of streams:
* **Public** (<i class="zulip-icon zulip-icon-hashtag"></i>):
Members can join and view the complete message history.
Public streams are visible to guest users only if they are
subscribed (exactly like private streams with shared history).
* **Private** (<i class="zulip-icon zulip-icon-lock"></i>):
New subscribers must be added by an existing subscriber. Only subscribers
and organization administrators can see the stream's name and description,
and only subscribers can view topics and messages with the stream:
* In **private streams with shared history**, new subscribers can
access the stream's full message history.
* In **private streams with protected history**, new subscribers
can only see messages sent after they join.
* [**Web-public**](/help/public-access-option) (<i class="zulip-icon
zulip-icon-globe"></i>): Members can join (guests must be invited by a
subscriber). Anyone on the Internet can view complete message history without
creating an account.
## Privacy model for private streams
At a high level:
* 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.
* [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.
* 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.
There are two situations in which an organization owner or
administrator can access private stream messages:
* Via some types of [data export](/help/export-your-organization).
* 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.)
## Detailed permissions
### Public streams
<div class="centered_table"></div>
| | 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; | &#10038; | &#10038; |
| Remove others | &#10004; | &#10038; | &#10038; | &#10038;
| 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; | | |
| Delete | &#10004; | | |
<span class="legend_symbol">&#10004;</span><span class="legend_label">Always</span>
<span class="legend_symbol">&#9726;</span><span class="legend_label">If subscribed to the stream</span>
<span class="legend_symbol">&#10038;</span><span class="legend_label">
Configurable. See [Stream posting policy](/help/stream-sending-policy),
[Configure who can add users][add-users], and
[Configure who can remove users][remove-users]
for details.
</span>
### Private streams
<div class="centered_table"></div>
| | Owners and admins | Moderators | Members | Guests
|--- |--- | |--- |---
| View stream name | &#10004; | &#9726; | &#9726; | &#9726;
| Join | | | |
| Unsubscribe | &#9726; | &#9726; | &#9726; | &#9726;
| Add others | &#9726; | &#10038; | &#10038; |
| Remove others | &#10004; | &#10038; | &#10038; | &#10038;
| 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; | | |
| Delete | &#10004; | | |
<span class="legend_symbol">&#10004;</span><span class="legend_label">Always</span>
<span class="legend_symbol">&#9726;</span><span class="legend_label">If subscribed to the stream</span>
<span class="legend_symbol">&#10038;</span><span class="legend_label">
Configurable, but at minimum must be subscribed to the stream.
See [Stream posting policy](/help/stream-sending-policy),
[Configure who can add users][add-users], and
[Configure who can remove users][remove-users]
for details.
</span>
## Related articles
* [Roles and permissions](/help/roles-and-permissions)
* [Stream sending policy](/help/stream-sending-policy)
* [Web-public streams](/help/public-access-option)
[add-users]: /help/configure-who-can-invite-to-streams#configure-who-can-add-users
[remove-users]: /help/configure-who-can-invite-to-streams#configure-who-can-remove-users