Skip to content

docs: document cloud ip access control - #1120

Merged
RiskeyL merged 22 commits into
release/cloud-1.18.0from
docs/ip-access-control-draft
Oct 26, 2026
Merged

RiskeyL merged 22 commits into
release/cloud-1.18.0from
docs/ip-access-control-draft

Conversation

@Ill-donut

@Ill-donut Ill-donut commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Add Cloud IP Access Control documentation in English, Chinese, and Japanese for release/cloud-1.18.0 preparation.

The new guide separates workspace IP policy management (create, edit, delete) from app Access Control (setup, policy and access-point changes, pause and resume). It explains shared-policy effects, role permissions, subscription consequences, and entry points for apps and Agents. Publish Overview and Web App Settings link to the guide; API Errors notes that an app API can return 401 when IP restrictions block a request.

Validation

  • Compared relevant implementation changes from the previously reviewed 43234f84 to Dify 1.18.0. The changes do not require revisions to the approved instructions.
  • Simulated merge into release/cloud-1.18.0 is conflict-free; git diff --check passes.
  • Checked internal links on both the release baseline and the simulated merged tree. Both report the same 6 broken links and 9 broken anchors outside this PR's pages, with 0 navigation issues. This PR introduces no additional failures. Release-wide link checks still need to be green before publishing.
  • Previous three-language review and the current feature-head internal-link and Mintlify checks passed.
  • Earlier development-environment tests covered Web App allow/deny, pause/resume, and saving edits while paused. API denial and subscription lifecycle were not independently retested against the final release deployment.

Release preparation

This PR targets the release preparation branch, not main. Before publishing the release documentation, confirm production feature availability and complete the final deployment checks for API denial and subscription lifecycle behavior. Integration here does not establish production availability.

Closes DC-314

@mintlify

mintlify Bot commented Oct 16, 2026 •

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated
dify-ce-cloud-docs 🟢 Ready View Preview Oct 23, 2026, 3:09 AM

💡 Tip: Enable Automations to automatically generate PRs for you.

@Ill-donut
Ill-donut changed the base branch from main to release/cloud-1.18.0 October 26, 2026 06:36
@Ill-donut
Ill-donut marked this pull request as ready for review October 26, 2026 06:37
@Ill-donut
Ill-donut requested a review from RiskeyL as a code owner October 26, 2026 06:37
@RiskeyL
RiskeyL merged commit 09a8a3a into release/cloud-1.18.0 Oct 26, 2026
1 of 2 checks passed
@RiskeyL
RiskeyL deleted the docs/ip-access-control-draft branch October 26, 2026 07:23
Ill-donut added a commit that referenced this pull request Oct 28, 2026
* docs: cover agent knowledge bases on the knowledge limit pages (#1128)

* docs: cover agent knowledge bases on the knowledge limit pages

* translate: update zh and ja knowledge limit pages

Also lowercases "knowledge pipeline" on the English rate limit page, per the glossary.

* docs: scope the classic upload section and move the agent retry note

* docs: address review feedback on the knowledge limit pages

* docs: carry ce 1.18.0 changes and agent templates to cloud 1.18.0 (#1134)

* docs: carry agent tracing and nested workflow tools to cloud

* docs: carry the rest of the ce 1.18.0 changes to cloud

* docs: carry app package export and import to cloud

* docs: document the new agent node in chatflow on cloud

* docs: add agent templates to the create an agent section

Agents can start from a template, and each template can be tried from its Details before use. Trials use none of the workspace's AI credits or API keys.

* translate: align the build note list and fix wording in zh and ja

Indent the build note list as the English page does, and correct the zh Preview sentence and three ja sentences that drifted from the English meaning.

* docs: add glossary rows for the agent template details and trial labels

* docs: adapt the cli docs for cloud 1.18.0 (#1135)

* docs: point the cloud cli nav at the shared cli pages

From Cloud 1.18.0 on, one CLI doc set serves Cloud and self-hosted
readers. The Cloud nav's CLI group now lists the {lang}/cli/ pages, the
frozen 1.17.1 copy under {lang}/cloud/cli/ is deleted, and its 60 pages
redirect to their successors. The callouts that sent Cloud readers to
that copy are gone from Overview and Get Started.

* docs: add agent knowledge base commands to the cli docs

The Command Index gets a Cloud-badged section for the seven read-only
knowledge_fs commands, linking to the agent knowledge base docs for how a
coding agent uses them, and Get Started adds knowledge_fs to the commands
an agent can run without asking. The ja Command Index intro also gets a
wording fix from its translation test.

* docs: adapt the cli pages for cloud and self-hosted readers

Lines that hold only on a self-hosted server now say so: the sign-in
lifetime setting, the rate limit setting, the OpenAPI and bearer
variables, installing for an older release, and the docs for 1.17.x. Get
Started names Dify Cloud's address and the workspace shown on the
Authorize page, and drops the sign-in lead-in. Manage Your Sign-In gets a
Cloud-badged Switch Your Workspace section, with workspace rows on the
Command Index and the Upgrade page. The DSL page covers apps in two
workspaces and Knowledge Retrieval links that an import into another
workspace or server drops. Two troubleshooting rows were corrected after
live tests: only OPENAPI_ENABLED causes the device flow 404, and the 503
hits every command that uses the sign-in.

* docs: link the dsl page to the cloud export page

The DSL page's "what else it keeps" link now points at the Cloud tree's
export and import page, which the Cloud 1.18.0 carry adds, instead of
the self-hosted one.

* docs: note that agent knowledge bases are cloud-only on the ce build page (#1141)

Community Edition 1.18.0 shows a disabled Agent Knowledge Base section in the new Agent's Configure panel. The note points readers to the Cloud docs. Remove it at the next CE release, which hides that section (dify#44774).

* docs: document cloud ip access control (#1120)

* docs: document cloud ip access control

* translate: sync ip access control docs in chinese and japanese

* docs: streamline IP access control guidance

* docs: clarify ip address and subscription guidance

* docs: move ip access control into a dedicated guide

* docs: combine ip access requirements in an info callout

* docs: organize ip access control by task

* docs: clarify ip policy editing location

* docs: refine ip access guidance and sharing defaults

* docs: simplify the pre-sharing access check

* docs: separate IP policies from app access control

* docs: clarify IP policy and app access control roles

* docs: remove redundant IP policy navigation tip

* docs: introduce IP access control settings locations

* docs: connect IP access control introduction

* docs: refine IP policy management and entry guidance

* docs: simplify ip policy deletion guidance

* docs: clarify ip access control guidance

* docs: refine ip policy introduction and address guidance

* docs: introduce ip access control before configuration

* docs: adjust ip access control intro paragraphs

* fix: remove redundant ip policy anchor aliases

* docs: add agent knowledge base docs for cloud (#1142)

* feat: support nested guide groups and tier subgroups in the api nav wiring

wire now resolves guide pages under a root folder and splits a tag group into tier subgroups (agent and classic knowledge base APIs), with the op order copied from the en nav.

* docs: add agent knowledge base labels to the glossary

Adds the agent knowledge base terms and UI labels (API Access button, API access switch, Agent Knowledge Retrieval), and points the two Integrations rows at the 1.18.0 navigation keys with ja 連携 for the main nav entry. Regenerates the termbase.

* docs: add agent knowledge base user guides

New pages under knowledge-base/ (overview, create, review, test and tune, retrieval settings, multimodal, use in apps, maintain, upgrade from classic), the knowledge overview, and the Agent Knowledge Retrieval node page, in en, zh, and ja. Updates the classic knowledge base, app, node, and getting-started pages that point to them.

* docs: add agent knowledge base api guides and reference

Adds the Agent Knowledge Base API guide and the Knowledge Base API parent page, updates the shared API guides, and adds the agent knowledge base operations to the service API specs, in en, zh, and ja.

* docs: add agent knowledge base navigation

Adds the Agent Knowledge Base and classic knowledge base groups to the Cloud knowledge navigation and the agent knowledge base API menus, in en, zh, and ja.

* docs: fix agent knowledge base docs from review and live api tests (#1147)

* docs: rework golden questions section and add the paused status

* fix: tighten the vision model sentence on the create page

* translate: use the translated query text label on the ja retrieval node page

* docs: add glossary rows for golden question statuses and the v2 query text

* docs: add live api test findings to the knowledge base guide and spec

* fix: drop the redundant version clause from the citation sentence

* translate: call the documents and sources views tabs in the ja api guide

* docs: add the top k retrieval label to the glossary

* docs: remove the new agent in chatflow passages from cloud (#1148)

* docs: tag the agent knowledge base nav group as new (#1151)

---------

Co-authored-by: Yajing Wang <101789361+Ill-donut@users.noreply.github.com>
RiskeyL added a commit that referenced this pull request Oct 29, 2026
* docs: cover agent knowledge bases on the knowledge limit pages (#1128)

* docs: cover agent knowledge bases on the knowledge limit pages

* translate: update zh and ja knowledge limit pages

Also lowercases "knowledge pipeline" on the English rate limit page, per the glossary.

* docs: scope the classic upload section and move the agent retry note

* docs: address review feedback on the knowledge limit pages

* docs: carry ce 1.18.0 changes and agent templates to cloud 1.18.0 (#1134)

* docs: carry agent tracing and nested workflow tools to cloud

* docs: carry the rest of the ce 1.18.0 changes to cloud

* docs: carry app package export and import to cloud

* docs: document the new agent node in chatflow on cloud

* docs: add agent templates to the create an agent section

Agents can start from a template, and each template can be tried from its Details before use. Trials use none of the workspace's AI credits or API keys.

* translate: align the build note list and fix wording in zh and ja

Indent the build note list as the English page does, and correct the zh Preview sentence and three ja sentences that drifted from the English meaning.

* docs: add glossary rows for the agent template details and trial labels

* docs: adapt the cli docs for cloud 1.18.0 (#1135)

* docs: point the cloud cli nav at the shared cli pages

From Cloud 1.18.0 on, one CLI doc set serves Cloud and self-hosted
readers. The Cloud nav's CLI group now lists the {lang}/cli/ pages, the
frozen 1.17.1 copy under {lang}/cloud/cli/ is deleted, and its 60 pages
redirect to their successors. The callouts that sent Cloud readers to
that copy are gone from Overview and Get Started.

* docs: add agent knowledge base commands to the cli docs

The Command Index gets a Cloud-badged section for the seven read-only
knowledge_fs commands, linking to the agent knowledge base docs for how a
coding agent uses them, and Get Started adds knowledge_fs to the commands
an agent can run without asking. The ja Command Index intro also gets a
wording fix from its translation test.

* docs: adapt the cli pages for cloud and self-hosted readers

Lines that hold only on a self-hosted server now say so: the sign-in
lifetime setting, the rate limit setting, the OpenAPI and bearer
variables, installing for an older release, and the docs for 1.17.x. Get
Started names Dify Cloud's address and the workspace shown on the
Authorize page, and drops the sign-in lead-in. Manage Your Sign-In gets a
Cloud-badged Switch Your Workspace section, with workspace rows on the
Command Index and the Upgrade page. The DSL page covers apps in two
workspaces and Knowledge Retrieval links that an import into another
workspace or server drops. Two troubleshooting rows were corrected after
live tests: only OPENAPI_ENABLED causes the device flow 404, and the 503
hits every command that uses the sign-in.

* docs: link the dsl page to the cloud export page

The DSL page's "what else it keeps" link now points at the Cloud tree's
export and import page, which the Cloud 1.18.0 carry adds, instead of
the self-hosted one.

* docs: note that agent knowledge bases are cloud-only on the ce build page (#1141)

Community Edition 1.18.0 shows a disabled Agent Knowledge Base section in the new Agent's Configure panel. The note points readers to the Cloud docs. Remove it at the next CE release, which hides that section (dify#44774).

* docs: document cloud ip access control (#1120)

* docs: document cloud ip access control

* translate: sync ip access control docs in chinese and japanese

* docs: streamline IP access control guidance

* docs: clarify ip address and subscription guidance

* docs: move ip access control into a dedicated guide

* docs: combine ip access requirements in an info callout

* docs: organize ip access control by task

* docs: clarify ip policy editing location

* docs: refine ip access guidance and sharing defaults

* docs: simplify the pre-sharing access check

* docs: separate IP policies from app access control

* docs: clarify IP policy and app access control roles

* docs: remove redundant IP policy navigation tip

* docs: introduce IP access control settings locations

* docs: connect IP access control introduction

* docs: refine IP policy management and entry guidance

* docs: simplify ip policy deletion guidance

* docs: clarify ip access control guidance

* docs: refine ip policy introduction and address guidance

* docs: introduce ip access control before configuration

* docs: adjust ip access control intro paragraphs

* fix: remove redundant ip policy anchor aliases

* docs: add agent knowledge base docs for cloud (#1142)

* feat: support nested guide groups and tier subgroups in the api nav wiring

wire now resolves guide pages under a root folder and splits a tag group into tier subgroups (agent and classic knowledge base APIs), with the op order copied from the en nav.

* docs: add agent knowledge base labels to the glossary

Adds the agent knowledge base terms and UI labels (API Access button, API access switch, Agent Knowledge Retrieval), and points the two Integrations rows at the 1.18.0 navigation keys with ja 連携 for the main nav entry. Regenerates the termbase.

* docs: add agent knowledge base user guides

New pages under knowledge-base/ (overview, create, review, test and tune, retrieval settings, multimodal, use in apps, maintain, upgrade from classic), the knowledge overview, and the Agent Knowledge Retrieval node page, in en, zh, and ja. Updates the classic knowledge base, app, node, and getting-started pages that point to them.

* docs: add agent knowledge base api guides and reference

Adds the Agent Knowledge Base API guide and the Knowledge Base API parent page, updates the shared API guides, and adds the agent knowledge base operations to the service API specs, in en, zh, and ja.

* docs: add agent knowledge base navigation

Adds the Agent Knowledge Base and classic knowledge base groups to the Cloud knowledge navigation and the agent knowledge base API menus, in en, zh, and ja.

* docs: fix agent knowledge base docs from review and live api tests (#1147)

* docs: rework golden questions section and add the paused status

* fix: tighten the vision model sentence on the create page

* translate: use the translated query text label on the ja retrieval node page

* docs: add glossary rows for golden question statuses and the v2 query text

* docs: add live api test findings to the knowledge base guide and spec

* fix: drop the redundant version clause from the citation sentence

* translate: call the documents and sources views tabs in the ja api guide

* docs: add the top k retrieval label to the glossary

* docs: remove the new agent in chatflow passages from cloud (#1148)

* docs: tag the agent knowledge base nav group as new (#1151)

---------


(cherry picked from commit 4408d7f)

Co-authored-by: Yajing Wang <101789361+Ill-donut@users.noreply.github.com>

This branch was successfully deployed

1 active deployment
staging — 1e70393f Deployed Oct 26, 2026 by mintlify[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants