AWSを使用して認証でDocusaurusを展開する方法

Deploy fast your documentation with authentication with AWS Amplify. Docusaurus is a great documentation tool. The best, even to collaborate with non-technical people. Deploying and securing through an authentication is always a question I see developers facing. Most of the user cases for documentation besides open source require some level of auth. Working remote, this is a simple way to deploy your documentation.

読み終わった後

これで、どのようにDOWUSAUSを展開するAWSDocusaurus docs itself , どちらがPRを提出するか

AWSによって提供される連続的な統合を使用して、常に最新のあなたのドキュメントを維持する

世界からあなたのドキュメントを保護するのに必要な最小の認証を実装します

私がカバーしないもの

Docusaurusを設定する方法.どうぞfollow the instructions in the official docs . 基本的にはnpx @docusaurus/init@latest init my-website classic 足場プロジェクトを作成するには

特定のブランチに新しいコミットで展開されているコードのリポジトリを設定する方法.

展開

最初にinstall and configure Amplify in your machine . アフタークリエイトamplify.yml ファイルをプロジェクトのルートに戻します.

version: 1
backend:
  phases:
    build:
      commands:
        - ‘# Execute Amplify CLI with the helper script’
        - amplifyPush --simple
frontend:
  phases:
    preBuild:
      commands:
        - yarn install
    build:
      commands:
        - yarn build
  artifacts:
    baseDirectory: /build
    files:
      - ‘**/*’
  cache:
    paths:
      - node_modules/**/*

少し前にopened a ticket 私は、私のビルドプロセスは、CLIの手順に従うことができなかったので、場合にのみ、これはあなたの経験を強化します.私は常にこのカスタムファイルをプロジェクトに配置し、最初の展開で動作するようにしなければなりません.私は自分の環境に問題があると思いますが、これ以外にもスムーズに動作します.
プロジェクトを初期化します

amplify init

いくつかの質問が表示されます、あなたの環境に一致するものを選択します.

Note: It is recommended to run this command from the root of your app directory
? Enter a name for the project yourproject
? Enter a name for the environment dev
? Choose your default editor: Visual Studio Code
? Choose the type of app that you’re building javascript
Please tell us about your project
? What javascript framework are you using react
? Source Directory Path:  .
? Distribution Directory Path: build
? Build Command:  yarn build
? Start Command: yarn build

Docusaurusは反応アプリケーションです、そして、配布経路はコマンドを通してつくられた構築フォルダの中にありますyarn build . これは、S 3バケツでの静的ファイルを生成します、そして、CloudfrontのCDNを通しての配布はAmplifyによってつくられます.静的なファイルを使用するので、起動コマンドを実際に使用しない.
Amplifyは、ローカルおよびクラウドプロジェクトの初期化を開始します.あなたの次のステップは、コマンドですamplify add hosting ドキュメントのホスティングを設定します.
いくつかの質問があります.

? Select the plugin module to execute Hosting with Amplify Console (Managed hosting with custom domains, Continuous deployment)
? Choose a type Continuous deployment (Git-based deployments)
? Continuous deployment is configured in the Amplify Console. Please hit enter once you connect your repository

私はいつもあなたのリポジトリ(Github、Bitbucketなど)を接続することができますので、常に連続展開オプションを使用します.

特定のブランチに定義されたマージによって、プロジェクトの新しいバージョンが自動的に構築されます.マニュアルを選択した場合は、実行する必要がありますamplify publish すべての新しい展開が必要です.
このオプションを使用すると、あなたのプロバイダを接続し、あなただけの指示に従う必要がありますあなたのブラウザのタブを開きます.一度行われると、全体のプロセスが増幅され、端末でEnterキーを押すことになります.

https://branch.qaz2sodsprk2kl.amplifyapp.com

認証

これは単純なHTTP認証です.ユースケースがロールを必要とする場合は、別のブランチを作成して機密コードを展開し、ロールの異なるURLを作成したり、ここでカバーされていないカスタマイズカスタマイズをカスタマイズしたりすることを推奨します.私の経験では、この単純な方法はドキュメントを保護するのに十分です.
アプリケーションのページでは、左側のメニュー上のアプリケーションの設定オプションで“アクセス制御”を選択する必要があります.編集するには、アクセスの制限を変更するには、アクセスの設定を変更し、ユーザー名とパスワードを少なくとも7文字を定義します.ヒット効果を確認します.

経路53で構成されている場合はさらにドメインを追加することもできます.次のようなサブドメインを作成できますdocs.acme.com SSL証明書を生成します.

カバー写真Scott Evans on Unsplash