Skip to content
Snippets Groups Projects
Commit 08427656 authored by Allen Gilliland's avatar Allen Gilliland
Browse files

Merge pull request #1264 from metabase/docs_docs_docs

Docs docs docs
parents e4f5c5e3 f584cdba
No related branches found
No related tags found
No related merge requests found
......@@ -6,8 +6,6 @@
> How to contribute back to the Metabase project
[![Circle CI](https://circleci.com/gh/metabase/metabase-init.svg?style=svg&circle-token=3ccf0aa841028af027f2ac9e8df17ce603e90ef9)](https://circleci.com/gh/metabase/metabase-init)
# Install Prerequisites
These are the set of tools which are required in order to complete any build of the Metabase code. Follow the links to download and install them on your own before continuing.
......@@ -191,7 +189,7 @@ Will give you a list of out-of-date dependencies.
Once's this repo is made public, this Clojars badge will work and show the status as well:
[![Dependencies Status](http://jarkeeper.com/metabase/metabase-init/status.png)](http://jarkeeper.com/metabase/metabase-init)
[![Dependencies Status](http://jarkeeper.com/metabase/metabase-init/status.png)](http://jarkeeper.com/metabase/metabase)
## Documentation
......
## ETL Guide
* Normalized vs denormalized data
* Database Views for fun and profit
* ETL jobs vs database views
* write load vs read load
* performance implications
* when to use views
* how to create them
* MySQL
* PostgreSQL
* Common examples
* tables with an is_deleted flag
* user table with a roles field
* test accounts + data
* Dealing with events
* pain on read vs pain on write
* deciding what to collect
* suggested event format
* enriching events
* preparing for cohort analysis
......@@ -42,7 +42,7 @@ When your environment type settings look like the above then go ahead and click
### Application Version
The application version describes the exact binary you wish to deploy to your Elastic Beanstalk application. Metabaes provides a pre-built AWS Elastic Beanstalk application version which can be linked to directly. Simply enter the following url in the `S3 URL` textbox:
The application version describes the exact binary you wish to deploy to your Elastic Beanstalk application. Metabase provides a pre-built AWS Elastic Beanstalk application version which can be linked to directly. Simply enter the following url in the `S3 URL` textbox:
https://s3.amazonaws.com/downloads.metabase.com/v0.12.0/aws-elastic-beanstalk.zip
......@@ -70,7 +70,7 @@ Click `Next` to continue.
To run Metabase in a cloud environment of any kind we highly recommend using an independent database server with high availability such as Amazon RDS. So for standard deployments we will choose to create an RDS instance with our Elastic Beanstalk application.
NOTE: it's possible to skip this step if you wish, however this will force Metabase to use a local H2 database file on your application server and there will be no way to backup and maintain that database, so when your instance is restarted for any reason you'll use all your Metabase data. If you are just doing a quick trial of Metabase that may be okay, but otherwise we recommend against this.
NOTE: it's possible to skip this step if you wish, however this will force Metabase to use a local H2 database file on your application server and there will be no way to backup and maintain that database, so when your instance is restarted for any reason you'll lose all your Metabase data. If you are just doing a quick trial of Metabase that may be okay, but otherwise we recommend against this.
##### Using Metabase in a VPC
......@@ -88,7 +88,7 @@ Once you've made your choices click `Next` and lets move on
There are quite a few choices available here so we'll go through each of them individually.
* `Instance type` is for picking the size of AWS instance you want to run. Any size is fine but we recommend `t2.small` for most uses.
* NOTE: the default setting is often `t1.micro` which is an old instance class. we recommend at least changing this to `t2.micro`
* Remember that you cannot choose a t2.* instance type if you did not check the box to run in a VPC.
* `EC2 key pair` is only needed if you want to ssh into your instance directly. We recommend leaving this out.
* Enter an `Email address` to get notifications about your deployments and changes to your application. This is a very simple way to keep some tabs on your Metabase environment, so we recommend putting a valid email in here.
* The `Application health check URL` is how Elastic Beanstalk knows when the application is ready to run, you must set this to `/api/health`
......@@ -113,7 +113,7 @@ Here you'll make the appropriate choices to configure your RDS database to work
* `Snapshot` should be left as None.
* `DB engine` must be set to `postgres`. Currently this is the only RDS database type that Metabase supports.
* `DB engine version` can simply be left on the default, which should be the latest version.
* For `Instance class` you can choose any size, we recommend `db.t2.small` or bigger for production installs.
* For `Instance class` you can choose any size, we recommend `db.t2.small` or bigger for production installs. Metabase is pretty efficient so there is no need to make this a big instance.
* You can safely leave `Allocated storage` to the default size.
* Pick a `Username` and `Password` for your database. This is just for reference if you need to connect to your db directly for some reason, but generally this should not be necessary. These settings will be automatically made available to your Metabase instance, so you will not need to put them in anywhere manually.
* You can safely leave the `Retention setting` as `Create snapshot`
......
......@@ -9,7 +9,7 @@ Before doing anything you should make sure you have a [Heroku](http://www.heroku
If you've got a Heroku account then all there is to do is follow this one-click deployment button
[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/metabase/metabase-deploy/tree/v0.0.0.7)
[![Deploy to Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/metabase/metabase-deploy)
This will launch a Heroku deployment using a github repository that Metabase maintains.
......
......@@ -2,9 +2,14 @@
To run the Metabase jar file you need to have Java installed on your system. Currently Metabase requires Java 6 or higher and will work on either the OpenJDK or Oracle JDK. Note that the Metabase team prefers to stick with open source solutions where possible, so we use the OpenJDK for our Metabase instances.
### Download Metabase
If you haven't done so already the first thing you need to do is [Download Metabase](http://www.metabase.com/start/jar.html). Simply save the .jar file to a folder on your system where you wish to run Metabase.
### Verify Java is installed
Before you can do anything you must verify that you have Java installed. To check that you have a working java runtime, go to a terminal and type:
Before you can launch the application you must verify that you have Java installed. To check that you have a working java runtime, go to a terminal and type:
java -version
......@@ -14,7 +19,7 @@ You should see output such as:
Java (TM) SE Runtime Environment (build 1.6.0_65-b14-466.1-11M4716)
Java HotSpot (TM) 64-Bit Server VM (build 20.65-b04-466.1, mixed mode)
If you did not see the output above and instead saw either an error or your Java version is less than 1.6, then you need to install the Java JDK.
If you did not see the output above and instead saw either an error or your Java version is less than 1.6, then you need to install the Java Runtime.
[OpenJDK Downloads](http://openjdk.java.net/install/)
[Oracle's Java Downloads](http://www.oracle.com/technetwork/java/javase/downloads/index.html)
......@@ -22,7 +27,7 @@ If you did not see the output above and instead saw either an error or your Java
### Launching Metabase
Now that you have a working JDK, you can now run the jar from a terminal with:
Now that you have a working Java Runtime, you can now run the jar from a terminal with:
java -jar metabase-standalone.jar
......@@ -37,7 +42,7 @@ It's that simple. This will start the Metabase application using all of the def
At this point your ready to go! You can access your new Metabase server on port 3000, most likely at [localhost:3000](http://localhost:3000)
Note that in the default configuration Metabase will use a local H2 database for storing all its own application data. This is meant for simple evaluations or personal installations, but if you are running Metabase for a team we recommend you upgrade to a more robust SQL server such as Postgres. Continue reading for details on how to do that.
Note that in the default configuration Metabase will use a local H2 database for storing all its own application data. This is meant for simple evaluations or personal use, so if you want to run Metabase for a team we recommend you upgrade to a more robust SQL server such as Postgres. See below for details on how to do that.
Now that you’ve installed Metabase, it’s time to [set it up and connect it to your database](/docs/setting-up-metabase.md).
......
......@@ -48,8 +48,5 @@ in the command line to manually clear the locks. Then restart your Metabase ins
Regardless of how you deploy Metabase, it is *strongly* recommended that you use HTTPS for all traffic. If you are using Elastic Beanstalk or AWS, we recommend you use ELB and terminate the HTTPS connection there. Otherwise, you can use nginx as a reverse proxy and terminate there.
#### [Manually running Database Migrations](manually-running-metabase-migrations.md)
If you prefer to have full control over the executing of database schema changes then you'll want to read about Metabase's database migrations and how to run them manually.
#### [Backing up your Metabase](backing-up-the-metabase-database.md)
Better safe than sorry we always say. Simple instructions to help with backing up a Metabase instance.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment