Skip to content
This repository has been archived by the owner on May 19, 2020. It is now read-only.

Commit

Permalink
Fix markdown lint issues
Browse files Browse the repository at this point in the history
  • Loading branch information
aeijdenberg committed Oct 4, 2017
1 parent 0d712ab commit e15d920
Showing 1 changed file with 13 additions and 8 deletions.
21 changes: 13 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ Environments: [Production](https://dashboard.fr.cloud.gov)
[Staging](https://dashboard.fr-stage.cloud.gov)
[Testing Server](https://dashboard-testing-server.app.cloud.gov)


## Introduction

This dashboard is a web application to manage cloud.gov organizations, spaces, services, and apps.
Expand All @@ -17,9 +16,11 @@ Learn more about [cloud.gov](https://cloud.gov).
## Tech Stack

### Backend Server

- `Go` (version 1.8)

### Front end application

- `Node` (version 6.x.x)
- `React` (version ^15.0.0)
- `Babel` (version ^6.x.x)
Expand All @@ -38,10 +39,12 @@ There are two different ways to setup your local environment:
The cloud.gov dashboard is continuously deployed by CircleCI. To deploy manually:

### Bootstrap Deployment Spaces

In each space that you plan on deploying, you need to create a `user-provided-service`.

Run:
```

```bash
# For applications without New Relic monitoring
cf cups dashboard-ups -p '{"CONSOLE_CLIENT_ID":"your-client-id","CONSOLE_CLIENT_SECRET":"your-client-secret", "SESSION_KEY": "a-really-long-secure-value", "SMTP_HOST": "smtp.host.com", "SMTP_PORT": "25", "SMTP_USER": "username", "SMTP_PASS": "password", "SMTP_FROM": "[email protected]"}'

Expand All @@ -56,23 +59,27 @@ cf create-service redis28 standard dashboard-redis
```

### Create a Client with UAAC

- Make sure [UAAC](https://github.com/cloudfoundry/cf-uaac) is installed.
- Target your UAA server. `uaac target <uaa.your-domain.com>`
- Login with your current UAA account. `uaac token client get <your admin account> -s <your uaa admin password>`
- Create client account:
```

```bash
uaac client add <your-client-id> \
--authorities "uaa.none scim.invite cloud_controller.admin scim.read" \
--authorized_grant_types authorization_code,client_credentials,refresh_token \
--scope cloud_controller.admin,cloud_controller.read,cloud_controller.write,openid,scim.read \
--autoapprove true \
-s <your-client-secret>
```
- Unable to create an account still? Troubleshoot [here](https://docs.cloudfoundry.org/adminguide/uaa-user-management.html#creating-admin-users)

- Unable to create an account still? Troubleshoot [here](https://docs.cloudfoundry.org/adminguide/uaa-user-management.html#creating-admin-users)

### CI

This project uses CircleCI.

- You will need to set up the credentials to deploy to the `dashboard-prod` and `dashboard-stage` spaces.
- In both spaces run: `cf create-service cloud-gov-service-account space-deployer dashboard-deployer`.
- You will get the link for that space's credentials by running `cf service dashboard-deployer`.
Expand All @@ -83,7 +90,6 @@ This project uses CircleCI.
- `CF_PASSWORD_STAGE_SPACE` - The password for the `dashboard-stage` deployer
- If you fork this project for your own use, you will need to use the CircleCI CLI UI to set the variables. (If you're forking just to make a pull request, there's no need to do this.)


### Optional features

Some features can be enabled by supplying the right environment configuration.
Expand All @@ -95,20 +101,19 @@ key. These are public and can be set in your manifest file. Note that your
Browser license key is different than your New Relic License Key (which should
be treated as confidential).

```
```bash
# manifest.yml
env:
NEW_RELIC_ID: 12345
NEW_RELIC_BROWSER_LICENSE_KEY: abcdef
```


#### Google Analytics

If you have a GA site configured, specify your tracking ID as `GA_TRACKING_ID`
in your environment.

```
```bash
# manifest.yml
env:
GA_TRACKING_ID: UA-123456-11
Expand Down

0 comments on commit e15d920

Please sign in to comment.