A fast, collaborative, knowledge base 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, A hosted version of the app is offered at getoutline.com. You can also find documentation on using Outline in our guide.
If you'd like to run your own copy of Outline then this is the place for you.
Please see the documentation for running your own copy of Outline in a production configuration.
Available container images:
If you have questions or improvements for the docs please create a thread in GitHub discussions.
Outline is localized through community contributions on CrowdIn. See the translation guide to help bring Outline to other languages.
There is a short guide for setting up a development environment.
If you're interested in 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. logging
can be enabled for all categories by setting DEBUG=* or for specific categories such as DEBUG=database and LOG_LEVEL=debug, or LOG_LEVEL=silly for very verbose logging.
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 Vitest and add a file with .test.ts extension next to the tested code.
# To run all tests
make test
# To run backend tests in watch mode
make watchOnce the test database is created with make test you may individually run
frontend and backend tests directly with vitest:
# To run backend tests
yarn test:server
# To run a specific backend test in watch mode
yarn test path/to/file.test.ts --watch
# To run frontend tests
yarn test:appSequelize is used to create and run migrations, for example:
yarn db:create-migration --name my-migration
yarn db:migrate
yarn db:rollbackOr, to run migrations on test database:
yarn db:migrate --env testOutline is BSL 1.1 licensed.