<commit_before><h1>Getting Started</h1>

## Installation

### Installing From Binary Packages

**Debian 8 (Jessie)**

```sh
$ echo "deb https://dl.bintray.com/nrel/api-umbrella-debian jessie main" | sudo tee /etc/apt/sources.list.d/api-umbrella.list
$ sudo apt-get update
$ sudo apt-get install api-umbrella
```

**Debian 7 (Wheezy)**

```sh
$ echo "deb https://dl.bintray.com/nrel/api-umbrella-debian wheezy main" | sudo tee /etc/apt/sources.list.d/api-umbrella.list
$ sudo apt-get update
$ sudo apt-get install api-umbrella
```

**Enterprise Linux 7 (CentOS/RedHat/Oracle/Scientific Linux)**

```sh
$ curl https://bintray.com/nrel/api-umbrella-el7/rpm | sudo tee /etc/yum.repos.d/api-umbrella.repo
$ sudo yum install api-umbrella
```

**Enterprise Linux 6 (CentOS/RedHat/Oracle/Scientific Linux)**

```sh
$ curl https://bintray.com/nrel/api-umbrella-el6/rpm | sudo tee /etc/yum.repos.d/api-umbrella.repo
$ sudo yum install api-umbrella
```

**Ubuntu 14.04 (Trusty)**

```sh
$ echo "deb https://dl.bintray.com/nrel/api-umbrella-ubuntu trusty main" | sudo tee /etc/apt/sources.list.d/api-umbrella.list
$ sudo apt-get update
$ sudo apt-get install api-umbrella
```

**Ubuntu 12.04 (Precise)**

```sh
$ echo "deb https://dl.bintray.com/nrel/api-umbrella-ubuntu precise main" | sudo tee /etc/apt/sources.list.d/api-umbrella.list
$ sudo apt-get update
$ sudo apt-get install api-umbrella
```

### Installing With Chef

If you use [Chef](https://www.chef.io) for managing your servers, we provide a [cookbook](https://github.com/NREL-cookbooks/api-umbrella) that can be used to install the binary packages and configure API Umbrella.

### Running With Docker

In this simple example, the API Umbrella configuration can be stored in the `config/api-umbrella.yml` file on host machine. This gets mounted as `/etc/api-umbrella/api-umbrella.yml` inside the container, which is the path for the configuration file the rest of the documentation will reference.

```sh
$ mkdir config && touch config/api-umbrella.yml
$ docker run -d --name=api-umbrella -p 80:80 -p 443:443 -v $PWD/config:/etc/api-umbrella nrel/api-umbrella
```

### Installing From Source Code

Installing from a binary package is recommended, if available ([let us know](https://github.com/NREL/api-umbrella/issues/new) if you'd like to see binary packages for other platforms). However, if a binary package is not available you can [compile from source](../developer/compiling-from-source.html).

## Setup

- Open the configuration file for editing:

  ```sh
  $ sudo -e /etc/api-umbrella/api-umbrella.yml
  ```

- In the config file, define an e-mail address for your first admin account:

  ```yaml
  web:
    admin:
      initial_superusers:
        - <EMAIL>
  ```
<commit_msg>Fix broken link in docs for compiling from source page.<commit_after><h1>Getting Started</h1>

## Installation

### Installing From Binary Packages

**Debian 8 (Jessie)**

```sh
$ echo "deb https://dl.bintray.com/nrel/api-umbrella-debian jessie main" | sudo tee /etc/apt/sources.list.d/api-umbrella.list
$ sudo apt-get update
$ sudo apt-get install api-umbrella
```

**Debian 7 (Wheezy)**

```sh
$ echo "deb https://dl.bintray.com/nrel/api-umbrella-debian wheezy main" | sudo tee /etc/apt/sources.list.d/api-umbrella.list
$ sudo apt-get update
$ sudo apt-get install api-umbrella
```

**Enterprise Linux 7 (CentOS/RedHat/Oracle/Scientific Linux)**

```sh
$ curl https://bintray.com/nrel/api-umbrella-el7/rpm | sudo tee /etc/yum.repos.d/api-umbrella.repo
$ sudo yum install api-umbrella
```

**Enterprise Linux 6 (CentOS/RedHat/Oracle/Scientific Linux)**

```sh
$ curl https://bintray.com/nrel/api-umbrella-el6/rpm | sudo tee /etc/yum.repos.d/api-umbrella.repo
$ sudo yum install api-umbrella
```

**Ubuntu 14.04 (Trusty)**

```sh
$ echo "deb https://dl.bintray.com/nrel/api-umbrella-ubuntu trusty main" | sudo tee /etc/apt/sources.list.d/api-umbrella.list
$ sudo apt-get update
$ sudo apt-get install api-umbrella
```

**Ubuntu 12.04 (Precise)**

```sh
$ echo "deb https://dl.bintray.com/nrel/api-umbrella-ubuntu precise main" | sudo tee /etc/apt/sources.list.d/api-umbrella.list
$ sudo apt-get update
$ sudo apt-get install api-umbrella
```

### Installing With Chef

If you use [Chef](https://www.chef.io) for managing your servers, we provide a [cookbook](https://github.com/NREL-cookbooks/api-umbrella) that can be used to install the binary packages and configure API Umbrella.

### Running With Docker

In this simple example, the API Umbrella configuration can be stored in the `config/api-umbrella.yml` file on host machine. This gets mounted as `/etc/api-umbrella/api-umbrella.yml` inside the container, which is the path for the configuration file the rest of the documentation will reference.

```sh
$ mkdir config && touch config/api-umbrella.yml
$ docker run -d --name=api-umbrella -p 80:80 -p 443:443 -v $PWD/config:/etc/api-umbrella nrel/api-umbrella
```

### Installing From Source Code

Installing from a binary package is recommended, if available ([let us know](https://github.com/NREL/api-umbrella/issues/new) if you'd like to see binary packages for other platforms). However, if a binary package is not available you can [compile from source](developer/compiling-from-source.html).

## Setup

- Open the configuration file for editing:

  ```sh
  $ sudo -e /etc/api-umbrella/api-umbrella.yml
  ```

- In the config file, define an e-mail address for your first admin account:

  ```yaml
  web:
    admin:
      initial_superusers:
        - <EMAIL>
  ```

{'fraction_non_alphanumeric': 0.13816863100634633, 'fraction_numerical': 0.00942883046237534, 'mean_word_length': 3.9515260323159787, 'pattern_counts': {'":': 0, '<': 9, '<?xml version=': 0, '>': 9, 'https://': 18, 'lorem ipsum': 0, 'www.': 2, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1841808', 'n_tokens_mistral': 2089, 'n_tokens_neox': 1892, 'n_words': 547}