Skip to content

docs: document non-interactive instance restores - #3044

Merged
sebastianiv21 merged 3 commits into
mainfrom
codex/app-15482-automated-restore-docs
Sep 23, 2026
Merged

sebastianiv21 merged 3 commits into
mainfrom
codex/app-15482-automated-restore-docs

Conversation

@sebastianiv21

Copy link
Copy Markdown
Contributor

Description

Document unattended instance restores for CI/CD and disaster recovery, available from Appsmith v2.4.1. Add Docker and Kubernetes examples, exact filename selection, local/S3 behavior, encrypted and unencrypted archive secrets, failure handling, and version mismatch overrides. Update the appsmithctl reference with supported restore options and a link to the guide.

Behavior checked against appsmithorg/appsmith#42147 and appsmithorg/appsmith-ee#9714; appsmithorg/appsmith-ee#9716 records EE sync ancestry without further behavior changes.

Pull request type

  • Review Fixes
  • Documentation Overhaul
  • Feature/Story
  • A-Force
  • Error in documentation
  • Maintenance

Documentation tickets

Validation

  • Docusaurus production build passed. Existing broken-anchor warnings remain, including the unchanged license/plans link in the restore guide.
  • Vale: 0 errors, 0 warnings, and 0 suggestions in both edited files.
  • Bash syntax checks passed for 20 examples; internal link destinations checked.
  • Generated HTML includes the new section, options, and cross-link.
  • git diff --check passed.

Checklist

  • Checked for Grammarly suggestions.
  • Adhered to the writing checklist.
  • Adhered to the media checklist.
  • Verified and updated cross-references or added redirect rules.
  • Tested the redirect rules on deploy preview.
  • Validated the modifications made to the content on the deploy preview.
  • Validated the CSS modifications on different screen sizes.

@vercel

vercel Bot commented Sep 17, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
appsmith-docs Ready Ready Preview Sep 23, 2026 4:24pm UTC

Request Review

Move the restore option table out of the appsmithctl subcommand index
into the guide it defers to, and drop the duplicated pod-restart block.

Replace the Kubernetes command-line password example with a Secret-based
procedure. kubectl exec arguments travel as query parameters in the
request URI, so kube-apiserver audit logs would record the archive
password in plaintext, and an encrypted archive's docker.env carries the
instance encryption keys.

Correct three points about the secrets themselves. The archive password
is transient and must not be persisted; APPSMITH_ENCRYPTION_PASSWORD and
APPSMITH_ENCRYPTION_SALT are durable and do belong in the instance's
docker.env. Appsmith checks only that the latter two are present, not
that they match the source instance.

Document APPSMITH_BACKUP_ARCHIVE_PASSWORD in the environment variable
reference, and record on the backup pages that appsmithctl backup writes
an unencrypted archive when no terminal is attached, which is where the
restore guide's unencrypted path comes from.

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>

@salevine salevine left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@sebastianiv21
sebastianiv21 merged commit f3098e5 into main Sep 23, 2026
5 checks passed
@sebastianiv21
sebastianiv21 deleted the codex/app-15482-automated-restore-docs branch September 23, 2026 16:43

This branch was successfully deployed

1 active deployment
Preview a340130c Deployed Sep 23, 2026 by vercel[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