Skip to content

Commit f3b1647

Browse files
committed
update README
1 parent 609e566 commit f3b1647

File tree

1 file changed

+27
-22
lines changed

1 file changed

+27
-22
lines changed

README.md

Lines changed: 27 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Here's a simple Metabase dashboard in action:
1212

1313
Embedding Metabase charts will always be free, but we include a "Powered by Metabase" graphic when using the open source version.
1414

15-
If you'd like to remove the "Powered by Metabase" attribution, check out our [Enterprise Edition](https://www.metabase.com/enterprise/). With full app 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.
1616

1717
## Prerequisites
1818

@@ -22,13 +22,26 @@ If you'd like to remove the "Powered by Metabase" attribution, check out our [En
2222

2323
We'll first need to set up a running instance of Metabase to serve the embedded dashboards.
2424

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.
2634
27-
2. Open up a terminal and clone this repo to your machine.
35+
## Enable embedding
2836
29-
3. `cd` into embedding-reference-apps.
37+
Once you've got Metabase running (on port 3000 by default):
3038
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`.
3245
3346
## Running the apps
3447
@@ -44,35 +57,27 @@ To see an embedded Metabase dashboard in action, [set up Metabase](#set-up-metab
4457
4558
## Embedding charts or dashboards
4659
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.
4861
4962
### Public embeds
5063
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.
5265
5366
### Signed embeds
5467
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.
5669
5770
The web applications go into more detail about embedding, and provide examples. Start up the [Node app](/node/README.md) and explore the app.
5871
59-
## Documentation on embeds
72+
### Full-app embedding
6073
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.
6275
63-
- [Quick search: embed](https://www.metabase.com/search.html?query=embed).
76+
## Docs and articles
6477
65-
Article links:
66-
67-
- [Embedding Metabase components in other applications](https://www.metabase.com/docs/latest/administration-guide/13-embedding.html)
68-
- [Embedding all of Metabase in your web app](https://www.metabase.com/docs/latest/enterprise-guide/full-app-embedding.html)
69-
- [Sharing and embedding dashboards or questions](https://www.metabase.com/docs/latest/administration-guide/12-public-links.html)
70-
71-
## Helpful info
72-
Credentials for Metabase should auto-populate, but here they are for reference:
73-
74-
- user: plucky@admin.com
75-
- password: Metabase123
78+
- [Embedding overview](https://www.metabase.com/docs/latest/embedding/introduction)
79+
- [Publishing data visualizations to the web](https://www.metabase.com/learn/customer-facing-analytics/embedding-charts-and-dashboards)
80+
- [Public sharing](https://www.metabase.com/docs/latest/questions/sharing/public-links)
7681
7782
## Run into trouble?
7883

0 commit comments

Comments
 (0)