You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/developer-guide.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -47,7 +47,7 @@ This solution uses Amazon CloudFront as the entry point of the administration ap
47
47
### Running the client locally
48
48
After SaaS Boost is installed and running, you may be interested in making changes to the administration application. If you want to make changes and develop/test them locally, you can navigate to the `/client/web` folder that is part of the code you downloaded when cloning the SaaS Boost repository.
49
49
50
-
Within the same folder is a `sample.env` file that holds variables that are specific to your deployed environment. Rename this file with the `.env` extension, and edit its settings to allow your local environment to connect to the core services of your deployed SaaS Boost environment.
50
+
Within the same folder is a `sample.env` file that holds variables that are specific to your deployed environment. Rename this file to just be `.env` and edit its settings to allow your local environment to connect to the core services of your deployed SaaS Boost environment.
51
51
52
52
Open the newly named file in an editor of your choice. To run the client locally, there are various environment variables that must be configured. The following is an example of configured settings:
The values for these settings can be retrieved from the AWS Management Console. The Region is based on the physical location of your SaaS Boost deployment. You can also access the Amazon Cognito service in the console to look up the user pool and client ID settings. To get the URI entry point for backend services, use the API Gateway service in the console.
60
+
The values for these settings can be retrieved from the AWS Management Console. The Region is based on the physical location of your SaaS Boost deployment. You can also access the Amazon Cognito service in the console to look up the user pool and client ID settings. To get the URI entry point for backend services, use the API Gateway service in the console and copy the invoke URL for the v1 stage of the public API.
61
61
62
62
After these environment variables are correctly configured, you can edit and run the client locally from the `/client/web` folder using the following command: `yarn start`
Copy file name to clipboardExpand all lines: docs/getting-started.md
+3-6Lines changed: 3 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -68,13 +68,10 @@ To initiate this process, perform the following steps:
68
68
4. Enter the full path to your AWS SaaS Boost directory: /\<mydir\>/aws-saas-boost.
69
69
5. Enter the name of the SaaS Boost environment (dev, QA, test, sandbox, etc.).
70
70
6. Enter the email address of the AWS SaaS Boost administrator who will receive the initial temporary password.
71
-
7. Indicate whether you want a domain to be setup for AWS SaaS Boost (Y/N).
72
-
- If you enter **Y**, you are prompted for a domain name. For example, if your main domain is **example.com**, you can enter **app.example.com** to have that sub-domain setup by the installer. After the installation completes, you need to update the DNS for example.com to add an entry for app.example.com pointing to the nameservers for the Route53 hosted zone created for app.example.com.
73
-
- This step can also be done after the install process.
74
-
8. Indicate whether you would like the metrics and analytics features of AWS SaaS Boost to be installed (Y/N). This is **optional** and will provision a [Redshift](https://aws.amazon.com/redshift) cluster.
71
+
7. Indicate whether you would like the metrics and analytics features of AWS SaaS Boost to be installed (Y/N). This is **optional** and will provision a [Redshift](https://aws.amazon.com/redshift) cluster.
75
72
- If you enter **Y**, you are prompted for [QuickSight](https://aws.amazon.com/quicksight/) setup. To select Y for Quicksight setup, _you must have already registered_ for at least a Standard account of Quicksight in your AWS Account by following the steps at [https://docs.aws.amazon.com/quicksight/latest/user/signing-up.html](https://docs.aws.amazon.com/quicksight/latest/user/signing-up.html).
76
-
9. If your application is Windows based and needs a shared file system, a [Managed Active Directory](https://aws.amazon.com/directoryservice/) must be deployed to support [Amazon FSx for Windows File Server](https://aws.amazon.com/fsx/windows/). Select y or n as needed.
77
-
10. Review the settings for your installation. Enter **y** to proceed or **n** to re-enter or adjust the values.
73
+
8. If your application is Windows based and needs a shared file system, a [Managed Active Directory](https://aws.amazon.com/directoryservice/) must be deployed to support [Amazon FSx for Windows File Server](https://aws.amazon.com/fsx/windows/). Select y or n as needed.
74
+
9. Review the settings for your installation. Enter **y** to proceed or **n** to re-enter or adjust the values.
78
75
79
76
The execution of this process will take 30-45 minutes to provision and configure all the resources (this will vary based on the options you've selected). Detailed logs from the installation process are stored in **saas-boost-install.log**.
0 commit comments