Monthly Downloads: 0
Programming language: JavaScript
Tags: Wikis    
Latest version: v0.43.2

Outline alternatives and similar software solutions

Based on the "Wikis" category

  • Gollum

    A simple, Git-powered wiki with a sweet API and local frontend.
  • Wiki.js

    Wiki.js | A modern, lightweight and powerful wiki app built on NodeJS, Git and Markdown
  • TiddlyWiki

    A reusable non-linear personal web notebook.
  • BookStack

    BookStack is a simple, self-hosted, easy-to-use platform for organizing and storing information. It allows for documentation to be stored in a book like fashion.
  • Dokuwiki

    An easy to use, lightweight, standards-compliant wiki engine with a simple syntax allowing reading the data outside the wiki. All data is stored in plain files, therefore no database is required.
  • Mediawiki

    MediaWiki is a free and open-source wiki software package written in PHP. It serves as the platform for Wikipedia and the other Wikimedia projects, used by hundreds of millions of people each month.
  • Raneto

    Raneto is an open source Knowledgebase platform that uses static Markdown files to power your Knowledgebase
  • Gitit

    A wiki program that stores pages and uploaded files in a git repository, which can then be modified using the VCS command line tools or the wiki's web interface. Supported markups include pandoc's extended version of markdown, reStructuredText, LaTeX, and HTML. Pages can be exported in a number of different formats, including LaTeX, RTF, OpenOffice ODT, and MediaWiki markup. Other features include: plugins, syntax highlighting, caching, ATOM feeds.
  • django-wiki

    A wiki system with complex functionality for simple integration and a superb interface. Store your knowledge with style: Use django models.
  • jingo

    A git based wiki engine written for node.js, with a decent design, a search capability and a good typography.
  • Documize

    Modern Docs + Wiki software with built-in workflow, single binary executable, just bring MySQL/Percona.
  • XWiki

    A second generation wiki that allows the user to extend its functionalities with a powerful extension-based architecture.
  • Wikitten

    Wikitten is a small, fast, PHP wiki, and the perfect place to store your notes, code snippets, ideas, and so on.
  • Realms

    A git-backed wiki inspired by Gollum.
  • Olelo

    Olelo is a wiki that stores pages in a Git repository, supports many markup styles and has an extensible, hackable architecture.
  • Cowyo

    Cowyo is a feature-rich wiki for minimalists.
  • Gruik

    An open-source markdown note-taking web app.
  • commonplace

    A server for your markdown files. Give it a directory, and Commonplace gives you a url, pretty pages, and quick editing.
  • Codex

    Codex is a simple file-based Markdown documentation platform built on top of Laravel.
  • Wikifeat

    Wikifeat is an open source collaboration platform built around the ever-popular Wiki concept.
  • Pepperminty Wiki

    A complete markdown-powered wiki contained in a single PHP file.
  • amusewiki

    Text::Amuse-based publishing platform
  • wiki

    Simple Markdown based wiki engine.
  • Tiki

    Wiki CMS Groupware with the most built-in features.
  • Blazekiss

    BlazeKiss is a KISS-based wiki
  • MoinMoin

    An advanced, easy to use and extensible WikiEngine with a large community of users.
  • ikiwiki

    A wiki compiler.
  • Zim

    Graphical text editor used to maintain a collection of wiki pages. Each page can contain links to other pages, simple formatting and images.
  • PmWiki

    Wiki-based system for collaborative creation and maintenance of websites.
  • TWiki

    TWiki is a Perl-based structured wiki application, typically used to run a collaboration platform, knowledge or document management system, a knowledge base, or team portal.
  • WiKiss

    A Wiki, simple to use and install.

Do you think we are missing an alternative of Outline or a related project?

Add another 'Wikis' Software solution


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

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 getoutline.com.

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
  • Postgres >=9.5
  • Redis >= 4
  • AWS S3 storage bucket for media and other attachments
  • Slack or Google developer application for authentication


In development 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 https://api.slack.com/apps
  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. Add http://localhost:3000/auth/slack.callback as an Oauth redirect URL
    2. 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


For a self-hosted production installation there is more flexibility, but these are the suggested steps:

  1. Clone this repo and install dependencies with yarn or npm install

Requires Node.js and yarn installed

  1. Build the web app with yarn build:webpack or npm run build:webpack
  2. Using the .env.sample as a reference, set the required variables in your production environment. The following are required as a minimum:
    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)
    4. DATABASE_URL (run your own local copy of Postgres, or use a cloud service)
    5. REDIS_URL (run your own local copy of Redis, or use a cloud service)
    6. URL (the public facing URL of your installation)
    7. AWS_ (all of the keys beginning with AWS)
  3. Migrate database schema with yarn sequelize:migrate or npm run sequelize:migrate
  4. Start the service with any daemon tools you prefer. Take PM2 for example, NODE_ENV=production pm2 start index.js --name outline
  5. Visit http://you_server_ip:3000 and you should be able to see Outline page

Port number can be changed in the .env file

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



Outline uses debug. To enable debugging output, the following categories are available:



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 composed of separate backend and frontend application which are both driven by the same Node process. As both are written in Javascript, they share some code but are mostly separate. We utilize the latest language features, including async/await, and Flow typing. Prettier and ESLint are enforced by CI.


Outline's frontend is a React application compiled with Webpack. It uses Mobx for state management and Styled Components for component styles. Unless global, state logic and styles are always co-located with React components together with their subcomponents to make the component tree easier to manage.

The editor itself is built on Prosemirror and hosted in a separate repository to encourage reuse: rich-markdown-editor

  • app/ - Frontend React application
  • app/scenes - Full page views
  • app/components - Reusable React components
  • app/stores - Global state stores
  • app/models - State models
  • app/types - Flow types for non-models


Backend is driven by Koa (API, web server), Sequelize (database) and React for public pages and emails.

  • server/api - API endpoints
  • server/commands - Domain logic, currently being refactored from /models
  • server/emails - React rendered email templates
  • server/models - Database models
  • server/pages - Server-side rendered public pages
  • server/policies - Authorization logic
  • server/presenters - API responses for database models
  • server/test - Test helps and support
  • server/utils - Utility methods
  • shared - Code shared between frontend and backend applications


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
yarn test

# To run backend tests
yarn test:server

# To run frontend tests
yarn test:app


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

However, before working on 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 our Spectrum community. This way we can ensure that an approach is agreed on before code is written and will hopefully help to get your contributions integrated faster!

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

  • Issues with good first issue label
  • Performance improvements, both on server and frontend
  • Developer happiness and documentation
  • Bugs and other issues listed on GitHub
  • Helping others on Spectrum


Outline is BSL 1.1 licensed.

*Note that all licence references and agreements mentioned in the Outline README section above are relevant to that project's source code only.