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.
Outline requires following dependencies to work:
- Postgres >=9.5
- Redis
- S3 bucket configured to support CORS uploads
- Slack developer application
To install and run the application:
- Install dependencies with
yarn - Register a Slack app at https://api.slack.com/apps
- Copy the file
.env.sampleto.envand fill out the keys - Run DB migrations
yarn sequelize db:migrate
To run Outline in development mode with server and frontend code reloading:
yarn devTo run Outline in production mode:
yarn startTo enable debugging statements, set the following env vars:
DEBUG=sql,cache,presenters
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
Outline is BSD licensed.