mirror of
https://github.com/apache/superset.git
synced 2026-04-12 04:37:49 +00:00
bfd2a3d79f
* fix: database permissions on update and delete (avoid orphaned perms) * fix event transaction * fix test * fix lint * update datasource access permissions * add tests * fix import * fix tests * update slice and dataset perms also * fix lint * fix tests * fix lint * fix lint * add test for edge case, small refactor * add test for edge case, small refactor * improve code * fix lint
162 lines
4.8 KiB
Plaintext
162 lines
4.8 KiB
Plaintext
---
|
|
title: Installing From Scratch
|
|
hide_title: true
|
|
sidebar_position: 2
|
|
version: 1
|
|
---
|
|
|
|
## Installing Superset from Scratch
|
|
|
|
### OS Dependencies
|
|
|
|
Superset stores database connection information in its metadata database. For that purpose, we use
|
|
the cryptography Python library to encrypt connection passwords. Unfortunately, this library has OS
|
|
level dependencies.
|
|
|
|
**Debian and Ubuntu**
|
|
|
|
The following command will ensure that the required dependencies are installed:
|
|
|
|
```
|
|
sudo apt-get install build-essential libssl-dev libffi-dev python-dev python-pip libsasl2-dev libldap2-dev default-libmysqlclient-dev
|
|
```
|
|
|
|
In Ubuntu 20.04 the following command will ensure that the required dependencies are installed:
|
|
|
|
```
|
|
sudo apt-get install build-essential libssl-dev libffi-dev python3-dev python3-pip libsasl2-dev libldap2-dev default-libmysqlclient-dev
|
|
```
|
|
|
|
**Fedora and RHEL-derivative Linux distributions**
|
|
|
|
Install the following packages using the `yum` package manager:
|
|
|
|
```
|
|
sudo yum install gcc gcc-c++ libffi-devel python-devel python-pip python-wheel openssl-devel cyrus-sasl-devel openldap-devel
|
|
```
|
|
|
|
In more recent versions of CentOS and Fedora, you may need to install a slightly different set of packages using `dnf`:
|
|
|
|
```
|
|
sudo dnf install gcc gcc-c++ libffi-devel python3-devel python3-pip python3-wheel openssl-devel cyrus-sasl-devel openldap-devel
|
|
```
|
|
|
|
Also, on CentOS, you may need to upgrade pip for the install to work:
|
|
|
|
```
|
|
pip3 install --upgrade pip
|
|
```
|
|
|
|
**Mac OS X**
|
|
|
|
If you're not on the latest version of OS X, we recommend upgrading because we've found that many
|
|
issues people have run into are linked to older versions of Mac OS X. After updating, install the
|
|
latest version of XCode command line tools:
|
|
|
|
```
|
|
xcode-select --install
|
|
```
|
|
|
|
We don't recommend using the system installed Python. Instead, first install the
|
|
[homebrew](https://brew.sh/) manager and then run the following commands:
|
|
|
|
```
|
|
brew install readline pkg-config libffi openssl mysql postgres
|
|
```
|
|
|
|
You should install a recent version of Python (the official docker image uses 3.8.13). We'd recommend using a Python version manager like [pyenv](https://github.com/pyenv/pyenv) (and also [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv)).
|
|
|
|
Let's also make sure we have the latest version of `pip` and `setuptools`:
|
|
|
|
```
|
|
pip install --upgrade setuptools pip
|
|
```
|
|
|
|
Lastly, you may need to set LDFLAGS and CFLAGS for certain Python packages to properly build. You can export these variables with:
|
|
|
|
```
|
|
export LDFLAGS="-L$(brew --prefix openssl)/lib"
|
|
export CFLAGS="-I$(brew --prefix openssl)/include"
|
|
```
|
|
|
|
These will now be available when pip installing requirements.
|
|
|
|
### Python Virtual Environment
|
|
|
|
We highly recommend installing Superset inside of a virtual environment. Python ships with
|
|
`virtualenv` out of the box. If you're using [pyenv](https://github.com/pyenv/pyenv), you can install [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv). Or you can install it with `pip`:
|
|
|
|
```
|
|
pip install virtualenv
|
|
```
|
|
|
|
You can create and activate a virtual environment using:
|
|
|
|
```
|
|
# virtualenv is shipped in Python 3.6+ as venv instead of pyvenv.
|
|
# See https://docs.python.org/3.6/library/venv.html
|
|
python3 -m venv venv
|
|
. venv/bin/activate
|
|
```
|
|
|
|
Or with pyenv-virtualenv:
|
|
|
|
```
|
|
# Here we name the virtual env 'superset'
|
|
pyenv virtualenv superset
|
|
pyenv activate superset
|
|
```
|
|
|
|
Once you activated your virtual environment, all of the Python packages you install or uninstall
|
|
will be confined to this environment. You can exit the environment by running `deactivate` on the
|
|
command line.
|
|
|
|
### Installing and Initializing Superset
|
|
|
|
First, start by installing `apache-superset`:
|
|
|
|
```
|
|
pip install apache-superset
|
|
```
|
|
|
|
Then, you need to initialize the database:
|
|
|
|
```
|
|
superset db upgrade
|
|
```
|
|
|
|
Finish installing by running through the following commands:
|
|
|
|
```
|
|
# Create an admin user in your metadata database (use `admin` as username to be able to load the examples)
|
|
export FLASK_APP=superset
|
|
superset fab create-admin
|
|
|
|
# Load some data to play with
|
|
superset load_examples
|
|
|
|
# Create default roles and permissions
|
|
superset init
|
|
|
|
# To start a development web server on port 8088, use -p to bind to another port
|
|
superset run -p 8088 --with-threads --reload --debugger
|
|
```
|
|
|
|
If everything worked, you should be able to navigate to `hostname:port` in your browser (e.g.
|
|
locally by default at `localhost:8088`) and login using the username and password you created.
|
|
|
|
### Installing Superset with Helm in Kubernetes
|
|
|
|
You can install Superset into Kubernetes with [Helm](https://helm.sh/). The chart is located in
|
|
the `helm/` directory.
|
|
|
|
To install Superset in your Kubernetes cluster with Helm 3, run:
|
|
|
|
```
|
|
helm dep up ./helm/superset
|
|
helm upgrade --install superset ./helm/superset
|
|
```
|
|
|
|
Note that the above command will install Superset into `default` namespace of your Kubernetes
|
|
cluster.
|