Skip to content

Commit 5d7980b

Browse files
author
Russ Garner
committed
updated readme
1 parent f9af234 commit 5d7980b

1 file changed

Lines changed: 38 additions & 10 deletions

File tree

README

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,41 +1,69 @@
11

2-
Step 1) Sorry I like to have a custom localhost domain!
2+
## Step 1) A custom localhost domain
3+
---
34
in your /etc/hosts add an entry for embed.demo.com
45
127.0.0.1 embed.demo.com
6+
<br/>
7+
<br/>
58

6-
Step 2) configure green ssl
9+
## Step 2) configure green ssl
10+
---
711
create an ssl cert pair named cert.pem and cert.key and place them under the /ssl folder
8-
I found this process worked for me on mac, with the latest browser updates. Green SSL is required for events
9-
https://eengstrom.github.io/musings/self-signed-tls-certs-v.-chrome-on-macos-catalina
12+
I found this process worked for me on mac, with the latest browser updates.
13+
[Link to Tutorial](https://eengstrom.github.io/musings/self-signed-tls-certs-v.-chrome-on-macos-catalina)
14+
Green SSL is required for events
15+
<br/>
16+
<br/>
1017

1118

12-
Step 3) configure looker
19+
## Step 3) configure looker
20+
---
1321
ensure https://embed.demo.com:3000 is added to your looker's embed domain whitelist
1422
at <<yourlooker>>.cloud.looker.com/admin/embed
23+
<br/>
24+
<br/>
1525

16-
Step 4) fill out config.ini
26+
## Step 4) fill out config.ini
27+
---
1728
I left a config.ini.example with values in it to make it as clear as possible (avoiding little issues like trailing slashes)
1829
rename it to config.ini and put in your real values
30+
<br/>
31+
<br/>
1932

20-
Step 5) put in the correct host at
33+
## Step 5) put in the correct host at
34+
---
2135
frontend/src/components/dashboard.js line 14. this app does not put in the config.ini values onto the frontend
36+
<br/>
37+
<br/>
2238

23-
Step 5) install the dependencies
39+
## Step 6) install the dependencies
40+
---
2441
(highly reccomended to use a virtual environment)
42+
```
2543
pip install -r requirements.txt
2644
cd frontend
2745
npm install
46+
```
47+
<br/>
48+
<br/>
2849

29-
Step 6) Run it!
50+
## Step 7) Run it!
51+
---
3052
I didn't link them up into a single command, so you might need to open two shells
53+
```
3154
python main.py
3255
cd frontend
3356
npm start
57+
```
3458

3559
Now you should be redirected to https://embed.demo.com:3000 where you should see an embeded dashboard
3660
with an event that triggered a simple 'Successfully Loaded!' message
3761

38-
Step 7) Vary the user and URL generation methods as a test
62+
<br/>
63+
<br/>
64+
65+
## Step 8) Vary the user and URL generation methods
66+
---
3967
User:
4068
Since in your real application, the URL will need to be sensitive to the logged in user
4169
this demonstrates how the frontend's request will change what the user sees via the userToken

0 commit comments

Comments
 (0)