summaryrefslogtreecommitdiff
path: root/opendc-web/opendc-web-ui
diff options
context:
space:
mode:
authorFabian Mastenbroek <mail.fabianm@gmail.com>2021-05-17 12:53:56 +0200
committerFabian Mastenbroek <mail.fabianm@gmail.com>2021-05-18 15:46:43 +0200
commit2bdde75f0a95e070459004c9b7cf7c0d6618bc9d (patch)
tree5f68e2eec7a32575ec5c9bc806dd3e0b0b244b49 /opendc-web/opendc-web-ui
parent1f2e8460a730ffc96ad45a68d7cd8e45f67bfd7a (diff)
docs: Add instructions on configuring Auth0 for OpenDC
This change updates the deployment guide to include instructions on configuring Auth0 for OpenDC. This process should not be much more difficult than creating the Google Application.
Diffstat (limited to 'opendc-web/opendc-web-ui')
-rw-r--r--opendc-web/opendc-web-ui/README.md18
1 files changed, 12 insertions, 6 deletions
diff --git a/opendc-web/opendc-web-ui/README.md b/opendc-web/opendc-web-ui/README.md
index 370c693d..d562f2a4 100644
--- a/opendc-web/opendc-web-ui/README.md
+++ b/opendc-web/opendc-web-ui/README.md
@@ -12,7 +12,7 @@ datacenters. Built in *React.js* and *Redux*, with the help of [Next.js](https:/
## Get Up and Running
-Looking for the full OpenDC stack? Check out the [root](https://github.com/atlarge-research/opendc) for instructions on
+Looking for the full OpenDC stack? Check out the [deployment guide](../../docs/deploy.md) for instructions on
how to set up a Docker container with all of OpenDC, without the hassle of running each of the components manually.
### Installation
@@ -27,11 +27,11 @@ yarn
### Running the development server
-First, you need to have a Google OAuth client ID set up. Check
-the [documentation of the main OpenDC repo](https://github.com/atlarge-research/opendc) if you're not sure how to do
-this. Once you have such an ID, you need to set it as environment variable `NEXT_PUBLIC_OAUTH_CLIENT_ID`. One way of
-doing this is to create an `.env.local` file with content `NEXT_PUBLIC_OAUTH_CLIENT_ID=YOUR_ID` (`YOUR_ID` without
-quotes), in the root directory of this repo.
+First, you need to set up an [Auth0](https://auth0.com) application. Check
+the [documentation in the deployment guide](../../docs/deploy.md) if you're not sure how to do this. Once you have such
+an ID, you need to set it as environment variable `NEXT_PUBLIC_AUTH0_CLIENT_ID` and `NEXT_PUBLIC_AUTH0_DOMAIN`
+One way of doing this is to create an `.env.local` file with content `NEXT_PUBLIC_AUTH0_CLIENT_ID=YOUR_ID` and
+`NEXT_PUBLIC_AUTH0_DOMAIN=YOUR_AUTH0_DOMAIN` in the root directory of this repo.
Once you've set this variable, start the OpenDC `docker-compose` setup. See the root README for instructions on this.
@@ -50,6 +50,12 @@ To compile everything for camera-ready deployment, use the following command:
yarn build
```
+You can run the production server using Next.js as follows:
+
+```bash
+yarn start
+```
+
## Architecture
The codebase follows a standard React.js structure, with static assets being contained in the `public` folder, while