help: Rename channel in public access option page.

This commit is contained in:
Lauryn Menard 2024-05-02 16:45:12 +02:00 committed by Tim Abbott
parent d10ad01997
commit cdc9e83404
1 changed files with 36 additions and 36 deletions

View File

@ -1,38 +1,38 @@
# Public access option # Public access option
{!web-public-streams-intro.md!} {!web-public-channels-intro.md!}
Web-public streams are indicated with a **globe** (<i class="zulip-icon zulip-icon-globe"></i>) icon. Web-public channels are indicated with a **globe** (<i class="zulip-icon zulip-icon-globe"></i>) icon.
## Enabling web-public streams in your organization ## Enabling web-public channels in your organization
Enabling web-public streams makes it possible to create web-public Enabling web-public channels makes it possible to create web-public
streams in your organization. It also makes certain information about channels in your organization. It also makes certain information about
your organization accessible to anyone on the Internet via the Zulip your organization accessible to anyone on the Internet via the Zulip
API (details below). API (details below).
To help protect closed organizations, creating web-public streams is To help protect closed organizations, creating web-public channels is
disabled by default for all organizations. disabled by default for all organizations.
### Information that can be accessed via API when web-public streams are enabled ### Information that can be accessed via API when web-public channels are enabled
The following information about your organization can be accessed via the Zulip The following information about your organization can be accessed via the Zulip
API if web-public streams are enabled and there is currently at least one API if web-public channels are enabled and there is currently at least one
web-public stream. web-public channel.
* The organization's settings (linkifiers, custom emoji, permissions * The organization's settings (linkifiers, custom emoji, permissions
settings, etc.) settings, etc.)
* Names of users * Names of users
* Names of user groups and their membership * Names of user groups and their membership
* Names and descriptions of streams * Names and descriptions of channels
Enabling web-public streams is thus primarily recommended for open Enabling web-public channels is thus primarily recommended for open
communities such as open-source projects and research communities. communities such as open-source projects and research communities.
### Enable or disable web-public streams ### Enable or disable web-public channels
!!! warn "" !!! warn ""
Self-hosted Zulip servers must enable support for web-public streams in their Self-hosted Zulip servers must enable support for web-public channels in their
[server settings](https://zulip.readthedocs.io/en/stable/production/settings.html) [server settings](https://zulip.readthedocs.io/en/stable/production/settings.html)
by setting `WEB_PUBLIC_STREAMS_ENABLED = True` prior to proceeding. by setting `WEB_PUBLIC_STREAMS_ENABLED = True` prior to proceeding.
@ -40,28 +40,28 @@ communities such as open-source projects and research communities.
{settings_tab|organization-permissions} {settings_tab|organization-permissions}
1. Under **Stream permissions**, toggle the checkbox labeled **Allow 1. Under **Channel permissions**, toggle the checkbox labeled **Allow
creating web-public streams (visible to anyone on the Internet)**. creating web-public channels (visible to anyone on the Internet)**.
{end_tabs} {end_tabs}
### Manage who can create web-public streams ### Manage who can create web-public channels
{start_tabs} {start_tabs}
{settings_tab|organization-permissions} {settings_tab|organization-permissions}
1. Under **Stream permissions**, make sure the checkbox labeled **Allow 1. Under **Channel permissions**, make sure the checkbox labeled **Allow
creating web-public streams (visible to anyone on the Internet)** is creating web-public channels (visible to anyone on the Internet)** is
checked. checked.
1. Under **Who can create web-public streams?**, select the option you prefer. 1. Under **Who can create web-public channels?**, select the option you prefer.
{end_tabs} {end_tabs}
!!! tip "" !!! tip ""
See [Managing abuse](#managing-abuse) to learn why only See [Managing abuse](#managing-abuse) to learn why only
trusted roles like moderators and administrators can create web-public streams. trusted roles like moderators and administrators can create web-public channels.
## Creating a web-public channel ## Creating a web-public channel
@ -69,23 +69,23 @@ To create a new web-public channel, follow the [instructions for
creating a channel](/help/create-a-channel#create-a-channel_1), selecting creating a channel](/help/create-a-channel#create-a-channel_1), selecting
the **Web-public** option for **Who can access the channel?**. the **Web-public** option for **Who can access the channel?**.
To make an existing stream web-public, follow the instructions to To make an existing channel web-public, follow the instructions to
[change the privacy of a [change the privacy of a
channel](/help/change-the-privacy-of-a-channel), selecting the channel](/help/change-the-privacy-of-a-channel), selecting the
**Web-public** option for **Who can access the stream?**. **Web-public** option for **Who can access the channel?**.
## What can logged out visitors do? ## What can logged out visitors do?
Logged out visitors can browse all content in web-public streams, Logged out visitors can browse all content in web-public channels,
including using Zulip's [built-in search](/help/search-for-messages) including using Zulip's [built-in search](/help/search-for-messages)
to find conversations. Logged out visitors can only access to find conversations. Logged out visitors can only access
the web-public streams in your organization, and the topics, messages the web-public channels in your organization, and the topics, messages
(including uploaded files) and emoji reactions in those streams. (including uploaded files) and emoji reactions in those channels.
They **cannot**: They **cannot**:
* View streams that are not configured as web-public streams (or see * View channels that are not configured as web-public channels (or see
whether any such streams exist) without creating an account. whether any such channels exist) without creating an account.
* Send messages. * Send messages.
* React with emoji. * React with emoji.
* Participate in polls, or do anything else that might be visible to * Participate in polls, or do anything else that might be visible to
@ -97,18 +97,18 @@ detailed below.
### Information about the organization ### Information about the organization
* The **Organization settings** and **Stream settings** menus are not * The **Organization settings** and **Channel settings** menus are not
available to logged out visitors. However, organization settings data is available to logged out visitors. However, organization settings data is
required for Zulip to load, and may thus be [accessed via the Zulip API][info-via-api]. required for Zulip to load, and may thus be [accessed via the Zulip API][info-via-api].
* Logged out visitors cannot view [usage statistics](/help/analytics). * Logged out visitors cannot view [usage statistics](/help/analytics).
[info-via-api]: /help/public-access-option#information-that-can-be-accessed-via-api-when-web-public-streams-are-enabled [info-via-api]: /help/public-access-option#information-that-can-be-accessed-via-api-when-web-public-channels-are-enabled
### Information about users ### Information about users
Logged out visitors can see the following information about users who Logged out visitors can see the following information about users who
participate in web-public streams. They do not see this information participate in web-public channels. They do not see this information
about users who do not participate in web-public streams in the Zulip about users who do not participate in web-public channels in the Zulip
UI, though they may access it via the Zulip API. UI, though they may access it via the Zulip API.
* Name * Name
@ -131,7 +131,7 @@ but not to logged out visitors:
and whether they have set themselves as unavailable. and whether they have set themselves as unavailable.
* Detailed profile information, such as [custom profile * Detailed profile information, such as [custom profile
fields](/help/custom-profile-fields). fields](/help/custom-profile-fields).
* Which users are subscribed to which web-public streams. * Which users are subscribed to which web-public channels.
## Managing abuse ## Managing abuse
@ -140,13 +140,13 @@ that allows hosting files visible to the Internet is a potential target for bad
actors looking for places to distribute illegal or malicious content. actors looking for places to distribute illegal or malicious content.
In order to protect Zulip organizations from In order to protect Zulip organizations from
bad actors, web-public streams have a few limitations designed to make bad actors, web-public channels have a few limitations designed to make
Zulip an inconvenient target: Zulip an inconvenient target:
* Only users in trusted roles (moderators and administrators) can be given * Only users in trusted roles (moderators and administrators) can be given
permission to create web-public streams. This is intended to make it hard permission to create web-public channels. This is intended to make it hard
for an attacker to host malicious content in an unadvertised web-public for an attacker to host malicious content in an unadvertised web-public
stream in a legitimate organization. channel in a legitimate organization.
* There are rate limits for unauthenticated access to uploaded * There are rate limits for unauthenticated access to uploaded
files, including viewing avatars and custom emoji. files, including viewing avatars and custom emoji.
@ -161,7 +161,7 @@ with [Zulip's Rules of Use](https://zulip.com/policies/rules).
## Caveats ## Caveats
* Web-public streams do not yet support search engine indexing. You * Web-public channels do not yet support search engine indexing. You
can use [zulip-archive](https://github.com/zulip/zulip-archive) to can use [zulip-archive](https://github.com/zulip/zulip-archive) to
create an archive of a Zulip organization that can be indexed by create an archive of a Zulip organization that can be indexed by
search engines. search engines.