UPSTREAMED: outline with this patch integrated:
This repository has been archived on 2022-08-14. You can view files and clone it, but cannot push or open issues or pull requests.
Go to file
trav 3e68d80a9e
continuous-integration/drone Build is passing Details
merge changes from oidc fix branch
2021-11-24 14:10:43 -05:00
.circleci chore: Remove `version-` prefix from docker tags 2021-08-03 14:23:14 -07:00
.github Create codeql-analysis.yml 2021-11-07 11:27:42 -08:00
.vscode chore: Upgrade flow (#1854) 2021-01-29 21:36:09 -08:00
__mocks__ flow 2020-11-27 09:48:10 -08:00
app feat: Highlight active ListItem in outline. (#2760) 2021-11-12 17:22:37 -08:00
docs feat: Command Bar (#2669) 2021-10-24 12:30:27 -07:00
flow-typed Merge fix/path-parsing 2021-11-17 21:02:53 -08:00
public feat: Add 'Pitch' embed support 2021-11-14 18:33:30 -08:00
server merge changes from oidc fix branch 2021-11-24 14:10:43 -05:00
shared feat: Add 'Pitch' embed support 2021-11-14 18:33:30 -08:00
.babelrc fix: URLSearchParams polyfill via core-js upgrade (#2059) 2021-04-22 18:21:27 -07:00
.dockerignore perf: Improving dockerfile 2020-09-05 12:44:40 -07:00
.drone.yml drone yml 2021-11-24 14:06:49 -05:00
.env.sample fix: small improvements to local dev (#2699) 2021-10-28 21:44:14 -07:00
.eslintignore Lint rules and flow annotations for rest of the files 2017-11-15 23:40:14 -08:00
.eslintrc refactor: Remove old react lifecycle methods (#1480) 2020-08-23 11:51:56 -07:00
.flowconfig Collaborative editing (#1660) 2021-09-10 22:46:57 -07:00
.gitignore fix: small improvements to local dev (#2699) 2021-10-28 21:44:14 -07:00
.sequelizerc rm localenv 2017-07-06 23:27:16 -07:00
Dockerfile fix: /public directory missing in new docker releases (#2417) 2021-08-04 09:21:25 -07:00
LICENSE Update LICENSE 2021-11-11 07:27:39 -08:00
Makefile Collaborative editing (#1660) 2021-09-10 22:46:57 -07:00
Procfile Collaborative editing (#1660) 2021-09-10 22:46:57 -07:00 fix: visible groups (#2729) 2021-11-15 16:05:58 -08:00
app.json feat: Add TLS ciphers option (#2217) 2021-06-15 21:37:41 -07:00
crowdin.yml Update crowdin.yml 2020-11-30 19:09:41 -08:00
docker-compose.yml chore: Improve performance in dev by running Node/Yarn outside of docker (#1271) 2020-05-17 18:12:48 -07:00
i18next-parser.config.js feat: I18n (#1653) 2020-11-29 20:04:58 -08:00
package.json Merge fix/path-parsing 2021-11-17 21:02:53 -08:00 chore: Faster source map in dev 2021-04-22 18:59:59 -07:00
webpack.config.js chore: Add fetch-retry, remove isomorphic-fetch (#2297) 2021-07-09 04:07:18 -07:00 fix: Restore DNS prefetching for static resources (#1820) 2021-01-18 15:48:46 -08:00
yarn.lock Merge fix/path-parsing 2021-11-17 21:02:53 -08:00

An open, extensible, wiki for your team built using React and Node.js.
Try out Outline using our hosted version at


This is the source code that runs Outline and all the associated services. If you want to use Outline then you don't need to run this code, we offer a hosted version of the app at

If you'd like to run your own copy of Outline or contribute to development then this is the place for you.


Outline requires the following dependencies:

  • Node.js >= 12
  • Yarn
  • Postgres >=9.5
  • Redis >= 4
  • AWS S3 bucket or compatible API for file storage
  • Slack, Google, Azure, or OIDC application for authentication

Self-Hosted Production


For a manual self-hosted production installation these are the recommended steps:

  1. First setup Redis and Postgres servers, this is outside the scope of the guide.

  2. Download the latest official Docker image, new releases are available around the middle of every month:

    docker pull outlinewiki/outline

  3. Using the .env.sample as a reference, set the required variables in your production environment. You can export the environment variables directly, or create a .env file and pass it to the docker image like so:

    docker run --env-file=.env outlinewiki/outline

  4. Setup the database with yarn db:migrate. Production assumes an SSL connection to the database by default, if Postgres is on the same machine and is not SSL you can migrate with yarn db:migrate --env=production-ssl-disabled, for example:

    docker run --rm outlinewiki/outline yarn db:migrate

  5. Start the container:

    docker run outlinewiki/outline

  6. Visit http://you_server_ip:3000 and you should be able to see Outline page

    Port number can be changed using the PORT environment variable

  7. (Optional) You can add an nginx or other reverse proxy to serve your instance of Outline for a clean URL without the port number, support SSL, etc.


Alternatively a community member maintains a script to deploy Outline on Google Cloud Platform with Terraform & Ansible.



If you're running Outline with Docker you'll need to run migrations within the docker container after updating the image. The command will be something like:

docker run --rm outlinewiki/outline:latest yarn db:migrate


If you're running Outline by cloning this repository, run the following command to upgrade:

yarn run upgrade

Local Development

For contributing features and fixes you can quickly get an environment running using Docker by following these steps:

  1. Install these dependencies if you don't already have them
    1. Docker for Desktop
    2. Node.js (v12 LTS preferred)
    3. Yarn
  2. Clone this repo
  3. Register a Slack app at
  4. Copy the file .env.sample to .env
  5. Fill out the following fields:
    1. SECRET_KEY (follow instructions in the comments at the top of .env)
    2. SLACK_KEY (this is called "Client ID" in Slack admin)
    3. SLACK_SECRET (this is called "Client Secret" in Slack admin)
  6. Configure your Slack app's Oauth & Permissions settings
    1. Slack recently prevented the use of http protocol for localhost. For local development, you can use a tool like ngrok or a package like mkcert. (How to use HTTPS for local development)
    2. Add https://my_ngrok_address/auth/slack.callback as an Oauth redirect URL and update the URL env var to match
    3. Ensure that the bot token scope contains at least users:read
  7. Run make up. This will download dependencies, build and launch a development version of Outline


The Makefile has other useful scripts, including some test automation.

  1. To run the entire test suite, run make test
  2. During development, it's often useful, to re-run some tests every time a file is changed. Use make watch to start the test daemon and follow the instructions in the console


Outline is built and maintained by a small team we'd love your help to fix bugs and add features!

Before submitting a pull request please let the core team know by creating or commenting in an issue on GitHub, and we'd also love to hear from you in the Discussions. This way we can ensure that an approach is agreed on before code is written. This will result in a much higher liklihood of code being accepted.

If youre looking for ways to get started, here's a list of ways to help us improve Outline:

  • Translation into other languages
  • Issues with good first issue label
  • Performance improvements, both on server and frontend
  • Developer happiness and documentation
  • Bugs and other issues listed on GitHub


If you're interested in contributing or learning more about the Outline codebase please refer to the architecture document first for a high level overview of how the application is put together.


In development Outline outputs simple logging to the console, prefixed by categories. In production it outputs JSON logs, these can be easily parsed by your preferred log ingestion pipeline.

HTTP logging is disabled by default, but can be enabled by setting the DEBUG=http environment variable.


We aim to have sufficient test coverage for critical parts of the application and aren't aiming for 100% unit test coverage. All API endpoints and anything authentication related should be thoroughly tested.

To add new tests, write your tests with Jest and add a file with .test.js extension next to the tested code.

# To run all tests
make test

# To run backend tests in watch mode
make watch

Once the test database is created with make test you may individually run frontend and backend tests directly.

# To run backend tests
yarn test:server

# To run frontend tests
yarn test:app


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

yarn sequelize migration:generate --name my-migration
yarn sequelize db:migrate

Or to run migrations on test database:

yarn sequelize db:migrate --env test


Outline is BSL 1.1 licensed.