Outline

An open, extensible, knowledge base for your team built using React and Node.js. Try Outline out using our hosted version at www.getoutline.com or read on to learn about installing on your own infrastructure.

Installation

Outline requires the following dependencies:

• Postgres >=9.5
• Redis
• Slack developer application

In development you can quickly can an environment running using Docker by following these steps:

1. Install Docker for Desktop if you don't already have it.
2. Register a Slack app at https://api.slack.com/apps
3. Copy the file .env.sample to .env and fill out the Slack keys, everything else should work well for development.
4. Run make up. This will download dependencies, build and launch a development version of Outline.

Development

Server

To enable debugging statements, add the following to your .env file:

DEBUG=sql,cache,presenters

Migrations

Sequelize is used to create and run migrations, for example:

yarn sequelize migration:create
yarn sequelize db:migrate

Or to run migrations on test database:

yarn sequelize db:migrate --env test

License

Outline is BSD licensed.