[{"_1":2,"_161":-5,"_162":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_140":141},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":-5,"_134":11,"_135":-5,"_136":137,"_138":91,"_139":-7},"canonicalUrl","https://hub.docker.com/r/akrantz/outline/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","akrantz","reponame","outline","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2021-07-04T23:34:57.157257Z","description","The fastest wiki and knowledge base for growing teams.","is_private","last_updated","2021-07-16T15:27:11.936522Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",284,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","\n\n

\n \n

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

\n \n \n \n \n

\n\nThis is the source code that runs [**Outline**](https://www.getoutline.com) 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](https://www.getoutline.com).\n\nIf you'd like to run your own copy of Outline or contribute to development then this is the place for you.\n\n# Installation\n\nOutline requires the following dependencies:\n\n- [Node.js](https://nodejs.org/) >= 12\n- [Yarn](https://yarnpkg.com)\n- [Postgres](https://www.postgresql.org/download/) >=9.5\n- [Redis](https://redis.io/) >= 4\n- AWS S3 bucket or compatible API for file storage\n- Slack or Google developer application for authentication\n\n\n## Self-Hosted Production\n\n### Docker\n\nFor a manual self-hosted production installation these are the recommended steps:\n\n1. First setup Redis and Postgres servers, this is outside the scope of the guide.\n1. Download the latest official Docker image, new releases are available around the middle of every month:\n\n `docker pull outlinewiki/outline`\n1. Using the [.env.sample](.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:\n\n `docker run --env-file=.env outlinewiki/outline`\n1. Setup the database with `yarn db:migrate`. Production assumes an SSL connection to the database by default, if\nPostgres is on the same machine and is not SSL you can migrate with `yarn db:migrate --env=production-ssl-disabled`, for example:\n\n `docker run --rm outlinewiki/outline yarn db:migrate`\n1. Start the container:\n\n `docker run outlinewiki/outline`\n1. Visit http://you_server_ip:3000 and you should be able to see Outline page\n\n > Port number can be changed using the `PORT` environment variable\n\n1. (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.\n\n### Terraform\n\nAlternatively a community member maintains a script to deploy Outline on Google Cloud Platform with [Terraform & Ansible](https://github.com/rjsgn/outline-terraform-ansible).\n\n### Upgrading\n\n#### Docker\n\nIf 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:\n\n```shell\ndocker run --rm outlinewiki/outline:latest yarn db:migrate\n```\n\n#### Git\n\nIf you're running Outline by cloning this repository, run the following command to upgrade:\n\n```shell\nyarn run upgrade\n```\n\n\n## Local Development\n\nFor contributing features and fixes you can quickly get an environment running using Docker by following these steps:\n\n1. Install these dependencies if you don't already have them\n 1. [Docker for Desktop](https://www.docker.com)\n 1. [Node.js](https://nodejs.org/) (v12 LTS preferred)\n 1. [Yarn](https://yarnpkg.com)\n1. Clone this repo\n1. Register a Slack app at https://api.slack.com/apps\n1. Copy the file `.env.sample` to `.env`\n1. Fill out the following fields:\n 1. `SECRET_KEY` (follow instructions in the comments at the top of `.env`)\n 1. `SLACK_KEY` (this is called \"Client ID\" in Slack admin)\n 1. `SLACK_SECRET` (this is called \"Client Secret\" in Slack admin)\n1. Configure your Slack app's Oauth & Permissions settings \n 1. Slack recently prevented the use of `http` protocol for localhost. For local development, you can use a tool like [ngrok](https://ngrok.com) or a package like `mkcert`. ([How to use HTTPS for local development](https://web.dev/how-to-use-local-https/))\n 1. Add `https://my_ngrok_address/auth/slack.callback` as an Oauth redirect URL\n 1. Ensure that the bot token scope contains at least `users:read`\n1. Run `make up`. This will download dependencies, build and launch a development version of Outline\n\n\n# Contributing\n\nOutline is built and maintained by a small team – we'd love your help to fix bugs and add features!\n\nBefore submitting a pull request please let the core team know by creating or commenting in an issue on [GitHub](https://www.github.com/outline/outline/issues), and we'd also love to hear from you in the [Discussions](https://www.github.com/outline/outline/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.\n\nIf you’re looking for ways to get started, here's a list of ways to help us improve Outline:\n\n* [Translation](TRANSLATION.md) into other languages\n* Issues with [`good first issue`](https://github.com/outline/outline/labels/good%20first%20issue) label\n* Performance improvements, both on server and frontend\n* Developer happiness and documentation\n* Bugs and other issues listed on GitHub\n\n\n## Architecture\n\nIf you're interested in contributing or learning more about the Outline codebase\nplease refer to the [architecture document](ARCHITECTURE.md) first for a high level overview of how the application is put together.\n\n\n## Debugging\n\nOutline uses [debug](https://www.npmjs.com/package/debug). To enable debugging output, the following categories are available:\n\n```\nDEBUG=sql,cache,presenters,events,importer,exporter,emails,mailer\n```\n\n## Tests\n\nWe 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.\n\nTo add new tests, write your tests with [Jest](https://facebook.github.io/jest/) and add a file with `.test.js` extension next to the tested code.\n\n```shell\n# To run all tests\nmake test\n\n# To run backend tests in watch mode\nmake watch\n```\n\nOnce the test database is created with `make test` you may individually run\nfrontend and backend tests directly.\n\n```shell\n# To run backend tests\nyarn test:server\n\n# To run frontend tests\nyarn test:app\n```\n\n## Migrations\n\nSequelize is used to create and run migrations, for example:\n\n```\nyarn sequelize migration:generate --name my-migration\nyarn sequelize db:migrate\n```\n\nOr to run migrations on test database:\n\n```\nyarn sequelize db:migrate --env test\n```\n\n## License\n\nOutline is [BSL 1.1 licensed](LICENSE).\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",2198263133,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},"content_type","creator",1502589,"full_size",459801709,"id",156871332,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},"architecture","amd64","digest","sha256:1f7d2bf10f13733902f1afb375bf750c58c56c0bf1a1cd80e839b2a9f319d968","features","","last_pulled","2026-10-07T21:00:01.744564907Z","last_pushed","2021-07-16T15:27:12Z","os","linux","os_features","os_version","size","variant","2021-07-16T15:27:11.646307Z","last_updater","last_updater_username","media_type","latest","repository",14816461,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":142,"_149":150,"_136":159,"_160":11},{"_40":143,"_42":144,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":145,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":146,"_79":11,"_80":148,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":147},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_151":64,"_152":-5,"_153":-5,"_154":155},"count","next","previous","results",[156],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":157,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},[158],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

akrantz/outline

Tags for akrantz/outline