# From source

:::info
Using the provided docker images is a much simpler way to run Outline, we do not recommend building from source unless you need to support other architectures.

:::


:::tip
**Note:** The licensed edition is distributed through Docker and is not source available. Do not use the from source installation method if you plan on upgrading to a paid license.

:::

# Dependencies

Install the following dependencies:

* [Node.js](https://nodejs.org/en/) (20, 22)
* [Yarn](https://yarnpkg.com/) (>= 4)
* [Postgres](https://www.postgresql.org/) (>=9.5)
* [Redis](https://redis.io/) (>= 4)

# Download

Clone the source code with the following command or download directly from [GitHub](https://github.com/outline/outline).


```bash
git clone git@github.com:outline/outline
```

 

Check out the tag for the last [released version](https://github.com/outline/outline/releases) – The default branch, `main`, is considered in development and may be broken at any time.

# Configuration

Using the `.env.sample` file as a reference add the configuration variables to your environment for your public url, Postgres database, Redis etc.

## Installation

Install the required application dependencies:

```bash
NODE_ENV=development && yarn install --immutable
```


Build a production bundle:

```bash
NODE_ENV=production && yarn build
```

## Database

Create the database with the following command, migrations will be ran automatically when you start the server 

```bash
yarn db:create

# If you are not using SSL then use this command
yarn db:create --env=production-ssl-disabled
```

# Running

You’re ready to start the app:

```bash
yarn start
```

Check the output carefully for errors such as connecting to your database or Redis instance. To make your installation accessible to the outside world look at the [SSL configuration](/doc/ssl-pzk7WO8d1n) documentation.

# Updating

To update Outline, follow these steps:


1. Always [backup the database](/doc/backups-KZtPOADCHG)
2. `pull` the latest code from the repo and merge if you have made changes to the source
3. Re-run the installation step

---

**Documents**

- [License restrictions](https://docs.getoutline.com/s/hosting/doc/license-restrictions-f9aq6uEL3H)
- [Requirements](https://docs.getoutline.com/s/hosting/doc/requirements-ULdYnwi4wG)
- [Installation methods](https://docs.getoutline.com/s/hosting/doc/installation-methods-pSvgz9j0QC)
- [Configuration](https://docs.getoutline.com/s/hosting/doc/configuration-509J4lAzjo)
- [Business + Enterprise](https://docs.getoutline.com/s/hosting/doc/business-enterprise-rv0715NxO3)
- [Backups](https://docs.getoutline.com/s/hosting/doc/backups-KZtPOADCHG)
- [Troubleshooting](https://docs.getoutline.com/s/hosting/doc/troubleshooting-HXckrzCqDJ)