From source
Note: 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.
Please note that support is only provided through the community discussion forum for self-hosted installations.
Dependencies
Install the following dependencies:
Download
Clone the source code with the following command or download directly from GitHub.
git clone git@github.com:outline/outline
Check out the tag for the last released version – The default branch, main
, is considered in development and may be broken.
Configuration
Using the .env.sample
file as a reference add the configuration variables to your environment for your public url, Postgres database, Redis etc. Be sure to include all of the values in the Required
section and at least one authentication provider.
Installation
Set the environment to development:
NODE_ENV=development
Install and build the required application dependencies:
yarn install --frozen-lockfile && yarn build
Database
Create the database with the following command, migrations will be ran automatically when you start the server
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:
NODE_ENV=production && 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 documentation.
Updating
To update Outline, follow these steps:
Always backup the database
pull
the latest code from the repo and merge if you have made changes to the sourceRe-run the installation step