Skip to content

docs: add self-hosting documentation#8605

Open
adrianjoshua-strutt wants to merge 1 commit into
mainfrom
docs/self-hosting
Open

docs: add self-hosting documentation#8605
adrianjoshua-strutt wants to merge 1 commit into
mainfrom
docs/self-hosting

Conversation

@adrianjoshua-strutt

@adrianjoshua-strutt adrianjoshua-strutt commented Jun 2, 2026

Copy link
Copy Markdown
Member

Preview: https://d2a8cehsb9j05d.cloudfront.net

Adds documentation for the self-managed hosting feature (defineHosting, definePipeline, ampx deploy).

Pages added

  • /deploy-and-host/self-hosting/ — Overview
  • /deploy-and-host/self-hosting/getting-started/ — Install and first deploy
  • /deploy-and-host/self-hosting/define-hosting/ — Configure hosting (domains, WAF, compute, CDK escape hatches)
  • /deploy-and-host/self-hosting/define-pipeline/ — Set up CI/CD pipeline
  • /deploy-and-host/self-hosting/external-pipelines/ — GitHub Actions, GitLab CI

Navigation

Updated src/directory/directory.mjs to add the self-hosting section under deploy-and-host.

Related: aws-amplify/amplify-backend#3211

@adrianjoshua-strutt adrianjoshua-strutt requested review from a team as code owners June 2, 2026 13:18
@github-actions github-actions Bot added the redirects-needed Redirects need to be created for deleted pages label Jun 2, 2026
@mergify

mergify Bot commented Jun 2, 2026

Copy link
Copy Markdown

@adrianjoshua-strutt, since a file was deleted from the src/pages and/or src/fragments directories, redirects might need to be set up so these previous pages do not 404. If redirects are needed, please answer these questions for each redirect that is needed:

  • What is the source address of the redirect? (Where are you trying to redirect from?)

  • What is the target address of the redirect? (Where are you trying to redirect to?)

  • Type of redirect? 301 - permanent redirect or 302 - temporary redirect? (More info on Amplify Hosting redirects here: https://docs.aws.amazon.com/amplify/latest/userguide/redirects.html)

@adrianjoshua-strutt

Copy link
Copy Markdown
Member Author

Redirects are already configured in redirects.json in this PR. All are 301 permanent redirects:

Source Target Type
/<platform>/deploy-and-host/hosting/ /<platform>/deploy-and-host/amplify-hosting/ 301
/<platform>/deploy-and-host/hosting/<*> /<platform>/deploy-and-host/amplify-hosting/<*> 301
/<platform>/deploy-and-host/fullstack-branching/ /<platform>/deploy-and-host/amplify-hosting/ 301
/<platform>/deploy-and-host/fullstack-branching/branch-deployments/ /<platform>/deploy-and-host/amplify-hosting/branch-deployments/ 301
/<platform>/deploy-and-host/fullstack-branching/pr-previews/ /<platform>/deploy-and-host/amplify-hosting/pr-previews/ 301
/<platform>/deploy-and-host/fullstack-branching/secrets-and-vars/ /<platform>/deploy-and-host/amplify-hosting/secrets-and-vars/ 301
/<platform>/deploy-and-host/fullstack-branching/share-resources/ /<platform>/deploy-and-host/amplify-hosting/share-resources/ 301
/<platform>/deploy-and-host/fullstack-branching/custom-pipelines/ /<platform>/deploy-and-host/amplify-hosting/custom-pipelines/ 301
/<platform>/deploy-and-host/fullstack-branching/cross-account-deployments/ /<platform>/deploy-and-host/amplify-hosting/cross-account-deployments/ 301
/<platform>/deploy-and-host/fullstack-branching/mono-and-multi-repos/ /<platform>/deploy-and-host/amplify-hosting/mono-and-multi-repos/ 301
/<platform>/deploy-and-host/fullstack-branching/monorepos/ /<platform>/deploy-and-host/amplify-hosting/monorepos/ 301

All pages moved from hosting/ and fullstack-branching/ into amplify-hosting/ as part of a nav restructure. The ValidateRedirects CI check passes locally.

import { defineHosting } from '@aws-amplify/hosting';

export const hosting = defineHosting({
framework: 'nextjs'

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.

Since we are auto detecting the framework, can omit this framework param and also it is already mentioned in configuration page.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Will do. Thanks!

import { defineHosting } from '@aws-amplify/hosting';

export const hosting = defineHosting({
framework: 'nextjs'

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.

same here, Since we are auto detecting the framework, can omit this framework param and also it is already mentioned in configuration page.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I agree

osama-rizk
osama-rizk previously approved these changes Jun 4, 2026
@adrianjoshua-strutt adrianjoshua-strutt marked this pull request as draft June 4, 2026 10:07
@adrianjoshua-strutt adrianjoshua-strutt marked this pull request as ready for review June 26, 2026 15:55
Adds documentation for the self-managed hosting feature (defineHosting, definePipeline, ampx deploy), restructures the deploy-and-host section into Amplify Hosting and Self-managed hosting, and adds preview labeling.

RFC: aws-amplify/amplify-backend#3211
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

redirects-needed Redirects need to be created for deleted pages

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants