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: README.md
+27-22Lines changed: 27 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Here's a simple Metabase dashboard in action:
12
12
13
13
Embedding Metabase charts will always be free, but we include a "Powered by Metabase" graphic when using the open source version.
14
14
15
-
If you'd like to remove the "Powered by Metabase" attribution, check out our [Enterprise Edition](https://www.metabase.com/enterprise/). With fullapp embedding, you can add dashboards, charts, or even the entire Metabase interface into your own app with a fully branded experience.
15
+
If you'd like to remove the "Powered by Metabase" attribution, check out our [paid plans](https://www.metabase.com/pricing/). With [full-app embedding](#full-app-embedding), you can add dashboards, charts, or even the entire Metabase interface into your own app with a fully branded experience.
16
16
17
17
## Prerequisites
18
18
@@ -22,13 +22,26 @@ If you'd like to remove the "Powered by Metabase" attribution, check out our [En
22
22
23
23
We'll first need to set up a running instance of Metabase to serve the embedded dashboards.
24
24
25
-
1. If you already have an instance of Metabase running on your machine, shut it down. Then download and run Metabase according to the guides in our [install section](https://www.metabase.com/docs/latest/operations-guide/installing-metabase.html).
25
+
1. Shut down Metabase if you already have it running on your machine.
26
+
2. Download the [JAR file for Metabase OSS](https://www.metabase.com/start/oss/jar).
27
+
3. Open up a terminal and clone this repo to your machine.
28
+
4. Move the `metabase.jar` file to the `metabase` directory of this repo.
29
+
5. Run the JAR file:
30
+
```
31
+
java -jar metabase.jar
32
+
```
33
+
6. [Run any example](#running-the-apps) depending on the programming language you choose.
26
34
27
-
2. Open up a terminal and clone this repo to your machine.
35
+
## Enable embedding
28
36
29
-
3.`cd` into embedding-reference-apps.
37
+
Once you've got Metabase running (on port 3000 by default):
30
38
31
-
3. Run any example depending on the programming language you choose.
39
+
1. Go to `localhost:3000` in your browser.
40
+
2. Log into Metabase.
41
+
- User: plucky@admin.com
42
+
- Password: Metabase123
43
+
3. Go to **Admin settings** > **Embedding** and click the toggle.
44
+
4. Make sure the embedding key in the **Admin settings** matches the embedding key in `index.js`.
32
45
33
46
## Running the apps
34
47
@@ -44,35 +57,27 @@ To see an embedded Metabase dashboard in action, [set up Metabase](#set-up-metab
44
57
45
58
## Embedding charts or dashboards
46
59
47
-
There are two ways to embed charts or dashboards in web applications:
60
+
There are three ways to embed Metabase charts or dashboards in web applications.
48
61
49
62
### Public embeds
50
63
51
-
The Public embedding method is to simply use the public URLs inside of an iframe, or really anywhere you can insert HTML. The embedded dashboard has a secure URL, so a user can only look at the contents of the dashboard being shared. An end user never has information they can use to modify the URL and gain access to any other resources on your Metabase instance.
64
+
The [public embedding](https://www.metabase.com/docs/latest/questions/sharing/public-links#public-embeds) method is to simply use the public URLs inside of an iframe, or really anywhere you can insert HTML. The embedded dashboard has a secure URL, so a user can only look at the contents of the dashboard being shared. An end user never has information they can use to modify the URL and gain access to any other resources on your Metabase instance.
52
65
53
66
### Signed embeds
54
67
55
-
With signed embedding, all embedded charts and dashboards have to be signed using a secret key. This allows you to build dynamic dashboards with a parameter that can be be locked down on the client side. You should sign embedded charts and dashboards on your server, which allows you to embed dashboards accessible to specific organizations, accounts, or users.
68
+
With [signed embedding](https://www.metabase.com/docs/latest/embedding/signed-embedding), all embedded charts and dashboards have to be signed using a secret key. This allows you to build dynamic dashboards with a [parameter that can be be locked down](https://www.metabase.com/docs/latest/embedding/signed-embedding-parameters#restricting-data-in-a-signed-embed) on the client side. You should sign embedded charts and dashboards on your server, which allows you to embed dashboards accessible to specific organizations, accounts, or users.
56
69
57
70
The web applications go into more detail about embedding, and provide examples. Start up the [Node app](/node/README.md) and explore the app.
58
71
59
-
##Documentation on embeds
72
+
### Full-app embedding
60
73
61
-
You can also learn more about embedding dashboards by reading [Metabase's documentation](https://www.metabase.com/docs/latest/).
74
+
Full-app embedding puts the entire Metabase app inside your app, so you can include the query builder in addition to your charts and dashboards. Full-app embedding isn't covered in this repo. Check out the [full-app embedding demo](https://embedding-demo.metabase.com/) instead.
0 commit comments