diff --git a/aws-terraform/README.md b/aws-terraform/README.md index 8e71eb8..b83ad5a 100644 --- a/aws-terraform/README.md +++ b/aws-terraform/README.md @@ -9,7 +9,7 @@ This is only an example of how you could deploy the 1Password SCIM Bridge to you If you find that you are not using a majority of the services listed in this documentation within your AWS account - for instance, you have an external DNS provider, or you are providing your own certificates through a third-party service - consider deploying through [Kubernetes](https://github.com/1Password/scim-examples/tree/master/kubernetes/README.md) using AWS Elastic Kubernetes Service (EKS). The 1Password SCIM Bridge is not a resource-intensive service, and a full AWS deployment may include more infrastructure than you require, unless it fits neatly into your existing setup. -To continue, please ensure you've read through [PREPARING.md](https://github.com/1Password/scim-examples/tree/master/PREPARING.md) before beginning deployment. +To continue, please ensure you've read through [PREPARATION.md](https://github.com/1Password/scim-examples/blob/master/PREPARATION.md) before beginning deployment. ## Deployment overview @@ -84,7 +84,7 @@ Custom Key Management Service key can be specified by `--kms-key-id `. terraform apply ./op-scim.plan ``` -6. Update/Create 1Password SCIM configuration in your Identity Provider using your generated [bearer token](https://github.com/1Password/scim-examples/tree/master/PREPARING.md) and newly-created subdomain. +6. Update/Create 1Password SCIM configuration in your Identity Provider using your generated [bearer token](https://github.com/1Password/scim-examples/blob/master/PREPARATION.md) and newly-created subdomain. ## Advanced diff --git a/docker/README.md b/docker/README.md index 3797a61..c5159ed 100644 --- a/docker/README.md +++ b/docker/README.md @@ -4,7 +4,7 @@ This example describes the methods of deploying the 1Password SCIM bridge using ## Preparing -Please ensure you've read through the [Preparing](https://github.com/1Password/scim-examples/tree/master/PREPARING.md) document before beginning deployment. +Please ensure you've read through the [PREPARATION.md](https://github.com/1Password/scim-examples/blob/master/PREPARATION.md) document before beginning deployment. ## Docker Compose vs Docker Swarm @@ -38,7 +38,7 @@ Once set up and you've logged into your Swarm with `docker swarm join`, it's rec The script will do the following: 1. Add your `scimsession` to the SCIM bridge container, using a .env file for Docker Compose or a swarm secret for Docker Swarm. -2. Prompt you for your SCIM bridge domain name which will configure LetsEncrypt to automatically issue a certificate for your bridge. This is the domain you selected in [Preparing](https://github.com/1Password/scim-examples/tree/master/PREPARING.md). +2. Prompt you for your SCIM bridge domain name which will configure LetsEncrypt to automatically issue a certificate for your bridge. This is the domain you selected in [PREPARATION.md](https://github.com/1Password/scim-examples/blob/master/PREPARATION.md). 3. Deploy a container using `1password/scim`, and a redis container. The redis container is necessary to store LetsEncrypt certificates. The logs from the SCIM bridge and redis containers will be streamed to your machine. If everything seems to have deployed successfully, press Ctrl+C to exit, and the containers will remain running on the remote machine. diff --git a/docker/deploy.sh b/docker/deploy.sh index 2b7fb59..736822d 100755 --- a/docker/deploy.sh +++ b/docker/deploy.sh @@ -1,7 +1,7 @@ #!/usr/bin/env bash # Docker Swarm deployment script -# Please ensure you've read PREPARING.md and docker/README.md +# Please ensure you've read PREPARATION.md and docker/README.md # set the full path of the docker examples directory diff --git a/kubernetes/README.md b/kubernetes/README.md index 0d2ac35..7ca21aa 100644 --- a/kubernetes/README.md +++ b/kubernetes/README.md @@ -6,7 +6,7 @@ If deploying to the Azure Kubernetes Service, you can refer to our [detailed dep ## Preparing -Please ensure you've read through the [Preparing](https://github.com/1Password/scim-examples/tree/master/PREPARING.md) document before beginning deployment. +Please ensure you've read through the [PREPARATION.md](https://github.com/1Password/scim-examples/blob/master/PREPARATION.md) document before beginning deployment. ## Create your `scimsession` Kubernetes secret @@ -58,7 +58,7 @@ kubectl apply -f op-scim-service.yaml ## Configuring DNS -At this stage, you can finish configuring your DNS entry as outlined in [Preparing](https://github.com/1Password/scim-examples/tree/master/PREPARING.md). Please ensure you're using the IP address of the op-scim service you've deployed, which should have been automatically assigned. +At this stage, you can finish configuring your DNS entry as outlined in [PREPATATION.md](https://github.com/1Password/scim-examples/blob/master/PREPARATION.md). Please ensure you're using the IP address of the op-scim service you've deployed, which should have been automatically assigned. ## Test the instance