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:
For a manual self-hosted production installation these are the recommended steps:
First setup Redis and Postgres servers, this is outside the scope of the guide.
Download the latest official Docker image, new releases are available around the middle of every month:
docker pull outlinewiki/outline
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
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
Start the container:
docker run outlinewiki/outline
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
(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
For contributing features and fixes you can quickly get an environment running using Docker by following these steps:
.env.sample
to .env
SECRET_KEY
(follow instructions in the comments at the top of .env
)SLACK_KEY
(this is called "Client ID" in Slack admin)SLACK_SECRET
(this is called "Client Secret" in Slack admin)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)https://my_ngrok_address/auth/slack.callback
as an Oauth redirect URL and update the URL
env var to matchusers:read
make up
. This will download dependencies, build and launch a development version of OutlineOutline 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 you’re looking for ways to get started, here's a list of ways to help us improve Outline:
good first issue
labelIf 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.
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。