{"id":13456442,"url":"https://github.com/BookStackApp/BookStack","last_synced_at":"2025-03-24T10:32:34.588Z","repository":{"id":37245751,"uuid":"41589337","full_name":"BookStackApp/BookStack","owner":"BookStackApp","description":"A platform to create documentation/wiki content built with PHP \u0026 Laravel","archived":false,"fork":false,"pushed_at":"2024-10-29T09:55:10.000Z","size":42860,"stargazers_count":15228,"open_issues_count":600,"forks_count":1900,"subscribers_count":187,"default_branch":"development","last_synced_at":"2024-10-29T11:55:38.368Z","etag":null,"topics":["bookstack","documentation","laravel","php","selfhosted","wiki"],"latest_commit_sha":null,"homepage":"https://www.bookstackapp.com/","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/BookStackApp.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":".github/CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":".github/SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["ssddanbrown"],"ko_fi":"ssddanbrown"}},"created_at":"2015-08-29T10:26:44.000Z","updated_at":"2024-10-29T11:53:32.000Z","dependencies_parsed_at":"2023-12-14T20:48:44.542Z","dependency_job_id":"2b41f2f3-0315-4fe2-b391-b42be638a133","html_url":"https://github.com/BookStackApp/BookStack","commit_stats":{"total_commits":3368,"total_committers":188,"mean_commits":"17.914893617021278","dds":"0.20576009501187653","last_synced_commit":"8e64324d62dcefbf1464bc26e4c66329930f0e95"},"previous_names":["ssddanbrown/bookstack"],"tags_count":201,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BookStackApp%2FBookStack","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BookStackApp%2FBookStack/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BookStackApp%2FBookStack/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/BookStackApp%2FBookStack/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/BookStackApp","download_url":"https://codeload.github.com/BookStackApp/BookStack/tar.gz/refs/heads/development","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245252480,"owners_count":20585073,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["bookstack","documentation","laravel","php","selfhosted","wiki"],"created_at":"2024-07-31T08:01:22.034Z","updated_at":"2025-03-24T10:32:34.581Z","avatar_url":"https://github.com/BookStackApp.png","language":"PHP","readme":"# BookStack\n\n[![GitHub release](https://img.shields.io/github/release/BookStackApp/BookStack.svg)](https://github.com/BookStackApp/BookStack/releases/latest)\n[![license](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/BookStackApp/BookStack/blob/development/LICENSE)\n[![Crowdin](https://badges.crowdin.net/bookstack/localized.svg)](https://crowdin.com/project/bookstack)\n[![Build Status](https://github.com/BookStackApp/BookStack/workflows/test-php/badge.svg)](https://github.com/BookStackApp/BookStack/actions)\n[![Lint Status](https://github.com/BookStackApp/BookStack/workflows/lint-php/badge.svg)](https://github.com/BookStackApp/BookStack/actions)\n[![Maintainability](https://api.codeclimate.com/v1/badges/5551731994dd22fa1f4f/maintainability)](https://codeclimate.com/github/BookStackApp/BookStack/maintainability)\n\n[![Alternate Source](https://img.shields.io/static/v1?label=Alt+Source\u0026message=Git\u0026color=ef391a\u0026logo=git)](https://source.bookstackapp.com/)\n[![Repo Stats](https://img.shields.io/static/v1?label=GitHub+project\u0026message=stats\u0026color=f27e3f)](https://gh-stats.bookstackapp.com/)\n[![Discord](https://img.shields.io/static/v1?label=Discord\u0026message=chat\u0026color=738adb\u0026logo=discord)](https://discord.gg/ztkBqR2)\n[![Mastodon](https://img.shields.io/static/v1?label=Mastodon\u0026message=@bookstack\u0026color=595aff\u0026logo=mastodon)](https://fosstodon.org/@bookstack)\n\n[![PeerTube](https://img.shields.io/static/v1?label=PeerTube\u0026message=bookstack@foss.video\u0026color=f2690d\u0026logo=peertube)](https://foss.video/c/bookstack)\n[![YouTube](https://img.shields.io/static/v1?label=YouTube\u0026message=bookstackapp\u0026color=ff0000\u0026logo=youtube)](https://www.youtube.com/bookstackapp)\n\nA platform for storing and organising information and documentation. Details for BookStack can be found on the official website at https://www.bookstackapp.com/.\n\n* [Installation Instructions](https://www.bookstackapp.com/docs/admin/installation)\n* [Documentation](https://www.bookstackapp.com/docs)\n* [Demo Instance](https://demo.bookstackapp.com)\n    * [Admin Login](https://demo.bookstackapp.com/login?email=admin@example.com\u0026password=password)\n* [Screenshots](https://www.bookstackapp.com/#screenshots) \n* [BookStack Blog](https://www.bookstackapp.com/blog)\n* [Issue List](https://github.com/BookStackApp/BookStack/issues)\n* [Discord Chat](https://discord.gg/ztkBqR2)\n* [Support Options](https://www.bookstackapp.com/support/)\n\n## 📚 Project Definition\n\nBookStack is an opinionated documentation platform that provides a pleasant and simple out-of-the-box experience. New users to an instance should find the experience intuitive and only basic word-processing skills should be required to get involved in creating content on BookStack. The platform should provide advanced power features to those that desire it, but they should not interfere with the core simple user experience.\n\nBookStack is not designed as an extensible platform to be used for purposes that differ to the statement above.\n\nIn regard to development philosophy, BookStack has a relaxed, open \u0026 positive approach. We aim to slowly yet continuously evolve the platform while providing a stable \u0026 easy upgrade path. \n\nYou can read more about the project and its origins in [our FAQ here](https://www.bookstackapp.com/about/project-faq/).\n\n## 🌟 Project Sponsors\n\nShown below are our bronze, silver and gold project sponsors.\nBig thanks to these companies for supporting the project.\n*Note: The listed services are not tested, vetted nor supported by the official BookStack project in any manner.*\n\n[Project donation details](https://www.bookstackapp.com/donate/) - [GitHub Sponsors Page](https://github.com/sponsors/ssddanbrown) - [Ko-fi Page](https://ko-fi.com/ssddanbrown)\n\n#### Gold Sponsor\n\n\u003ctable\u003e\u003ctbody\u003e\u003ctr\u003e\n\u003ctd align=\"center\"\u003e\u003ca href=\"https://www.federated.computer/bookstack-wiki\" target=\"_blank\"\u003e\n    \u003cimg width=\"480\" src=\"https://www.bookstackapp.com/images/sponsors/federated-computer.png\" alt=\"Federated.computer\"\u003e\n\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\u003c/tbody\u003e\u003c/table\u003e\n\n#### Bronze Sponsors\n\n\u003ctable\u003e\u003ctbody\u003e\u003ctr\u003e\n\u003ctd align=\"center\"\u003e\u003ca href=\"https://www.diagrams.net/\" target=\"_blank\"\u003e\n    \u003cimg width=\"240\" src=\"https://www.bookstackapp.com/images/sponsors/diagramsnet.png\" alt=\"Diagrams.net\"\u003e\n\u003c/a\u003e\u003c/td\u003e\n\u003ctd align=\"center\"\u003e\u003ca href=\"https://cloudabove.com/hosting\" target=\"_blank\"\u003e\n    \u003cimg width=\"200\" src=\"https://www.bookstackapp.com/images/sponsors/cloudabove.png\" alt=\"Cloudabove\"\u003e\n\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\u003ctr\u003e\n\u003ctd align=\"center\"\u003e\u003ca href=\"https://www.practicali.be\" target=\"_blank\"\u003e\n    \u003cimg width=\"240\" src=\"https://www.bookstackapp.com/images/sponsors/practicali.png\" alt=\"Practicali\"\u003e\n\u003c/a\u003e\u003c/td\u003e\n\u003ctd align=\"center\"\u003e\u003ca href=\"https://www.stellarhosted.com/bookstack/\" target=\"_blank\"\u003e\n    \u003cimg width=\"240\" src=\"https://www.bookstackapp.com/images/sponsors/stellarhosted.png\" alt=\"Stellar Hosted\"\u003e\n\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd align=\"center\" style=\"text-align: center\"\u003e\u003ca href=\"https://nws.netways.de/apps/bookstack/\" target=\"_blank\"\u003e\n    \u003cimg width=\"240\" src=\"https://www.bookstackapp.com/images/sponsors/netways.png\" alt=\"NETWAYS Web Services\"\u003e\n\u003c/a\u003e\u003c/td\u003e\n\u003ctd align=\"center\" style=\"text-align: center\"\u003e\u003ca href=\"https://www.schroeck-consulting.de/\" target=\"_blank\"\u003e\n    \u003cimg width=\"200\" src=\"https://www.bookstackapp.com/images/sponsors/schroeck-consulting.png\" alt=\"Schroeck IT Consulting\"\u003e\n\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003ctr\u003e\n\u003ctd align=\"center\"\u003e\u003ca href=\"https://practinet.be/\" target=\"_blank\"\u003e\n    \u003cimg width=\"240\" src=\"https://www.bookstackapp.com/images/sponsors/practinet.png\" alt=\"Practinet\"\u003e\n\u003c/a\u003e\u003c/td\u003e\n\u003ctd align=\"center\"\u003e\u003ca href=\"https://route4me.com/\" target=\"_blank\"\u003e\n    \u003cimg width=\"240\" src=\"https://www.bookstackapp.com/images/sponsors/route4me.png\" alt=\"Route4Me - Route Optimizer and Route Planner Software\"\u003e\n\u003c/a\u003e\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/tbody\u003e\u003c/table\u003e\n\n## 🛠️ Development \u0026 Testing\n\nPlease see our [development docs](dev/docs/development.md) for full details regarding work on the BookStack source code.\n\nIf you're just looking to customize or extend your own BookStack instance, take a look at our [Hacking BookStack documentation page](https://www.bookstackapp.com/docs/admin/hacking-bookstack/) for details on various options to achieve this without altering the BookStack source code.\n\nDetails about BookStack's versioning scheme and the general release process [can be found here](dev/docs/release-process.md).\n\n## 🌎 Translations\n\nTranslations for text within BookStack is managed through the [BookStack project on Crowdin](https://crowdin.com/project/bookstack). Some strings have colon-prefixed variables such as `:userName`. Leave these values as they are as they will be replaced at run-time.\n\nPlease use [Crowdin](https://crowdin.com/project/bookstack) to contribute translations instead of opening a pull request. The translations within the working codebase can be out-of-date, and merging via code can cause conflicts \u0026 sync issues. If for some reason you can't use Crowdin feel free to open an issue to discuss alternative options. \n\nIf you'd like a new language to be added to Crowdin, for you to be able to provide translations for, please [open a new issue here](https://github.com/BookStackApp/BookStack/issues/new?template=language_request.yml).\n\nPlease note, translations in BookStack are provided to the \"Crowdin Global Translation Memory\" which helps BookStack and other projects with finding translations. If you are not happy with contributing to this then providing translations to BookStack, even manually via GitHub, is not advised.\n\n## 🎁 Contributing, Issues \u0026 Pull Requests\n\nFeel free to [create issues](https://github.com/BookStackApp/BookStack/issues/new/choose) to request new features or to report bugs \u0026 problems. Just please follow the template given when creating the issue.\n\nPull requests are welcome but, unless it's a small tweak, it may be best to open the pull request early or create an issue for your intended change to discuss how it will fit into the project and plan out the merge. Just because a feature request exists, or is tagged, does not mean that feature would be accepted into the core project.\n\nPull requests should be created from the `development` branch since they will be merged back into `development` once done. Please do not build from or request a merge into the `release` branch as this is only for publishing releases. If you are looking to alter CSS or JavaScript content please edit the source files found in `resources/`. Any CSS or JS files within `public` are built from these source files and therefore should not be edited directly.\n\nThe project's code of conduct [can be found here](https://github.com/BookStackApp/BookStack/blob/development/.github/CODE_OF_CONDUCT.md).\n\n## 🔒 Security\n\nSecurity information for administering a BookStack instance can be found on the [documentation site here](https://www.bookstackapp.com/docs/admin/security/).\n\nIf you'd like to be notified of new potential security concerns you can [sign-up to the BookStack security mailing list](https://updates.bookstackapp.com/signup/bookstack-security-updates).\n\nIf you would like to report a security concern, details of doing so [can be found here](https://github.com/BookStackApp/BookStack/blob/development/.github/SECURITY.md).\n\n## ♿ Accessibility\n\nWe want BookStack to remain accessible to as many people as possible. We aim for at least WCAG 2.1 Level A standards where possible although we do not strictly test this upon each release. If you come across any accessibility issues please feel free to open an issue.\n\n## 🖥️ Website, Docs \u0026 Blog\n\nThe website which contains the project docs \u0026 blog can be found in the [BookStackApp/website](https://codeberg.org/bookstack/website) repo.\n\n## ⚖️ License\n\nThe BookStack source is provided under the [MIT License](https://github.com/BookStackApp/BookStack/blob/development/LICENSE). \n\nThe libraries used by, and included with, BookStack are provided under their own licenses and copyright.\nThe licenses for many of our core dependencies can be found in the attribution list below but this is not an exhaustive list of all projects used within BookStack. \n\n## 👪 Attribution\n\nThe great people that have worked to build and improve BookStack can [be seen here](https://github.com/BookStackApp/BookStack/graphs/contributors). The wonderful people that have provided translations, either through GitHub or via Crowdin [can be seen here](https://github.com/BookStackApp/BookStack/blob/development/.github/translators.txt).\n\nBelow are the great open-source projects used to help build BookStack. \nNote: This is not an exhaustive list of all libraries and projects that would be used in an active BookStack instance.\n\n* [Laravel](http://laravel.com/) - _[MIT](https://github.com/laravel/framework/blob/v8.82.0/LICENSE.md)_\n* [TinyMCE](https://www.tinymce.com/) - _[MIT](https://github.com/tinymce/tinymce/blob/develop/LICENSE.TXT)_\n* [Lexical](https://lexical.dev/) - _[MIT](https://github.com/facebook/lexical/blob/main/LICENSE)_\n* [CodeMirror](https://codemirror.net) - _[MIT](https://github.com/codemirror/CodeMirror/blob/master/LICENSE)_\n* [Sortable](https://github.com/SortableJS/Sortable) - _[MIT](https://github.com/SortableJS/Sortable/blob/master/LICENSE)_\n* [Google Material Icons](https://github.com/google/material-design-icons) - _[Apache-2.0](https://github.com/google/material-design-icons/blob/master/LICENSE)_\n* [markdown-it](https://github.com/markdown-it/markdown-it) and [markdown-it-task-lists](https://github.com/revin/markdown-it-task-lists) - _[MIT](https://github.com/markdown-it/markdown-it/blob/master/LICENSE) and [ISC](https://github.com/revin/markdown-it-task-lists/blob/master/LICENSE)_\n* [Dompdf](https://github.com/dompdf/dompdf) - _[LGPL v2.1](https://github.com/dompdf/dompdf/blob/master/LICENSE.LGPL)_\n* [KnpLabs/snappy](https://github.com/KnpLabs/snappy) - _[MIT](https://github.com/KnpLabs/snappy/blob/master/LICENSE)_\n* [WKHTMLtoPDF](http://wkhtmltopdf.org/index.html) - _[LGPL v3.0](https://github.com/wkhtmltopdf/wkhtmltopdf/blob/master/LICENSE)_\n* [diagrams.net](https://github.com/jgraph/drawio) - _[Embedded Version Terms](https://www.diagrams.net/trust/) / [Source Project - Apache-2.0](https://github.com/jgraph/drawio/blob/dev/LICENSE)_\n* [SAML PHP Toolkit](https://github.com/SAML-Toolkits/php-saml) - _[MIT](https://github.com/SAML-Toolkits/php-saml/blob/master/LICENSE)_\n* [League/CommonMark](https://commonmark.thephpleague.com/) - _[BSD-3-Clause](https://github.com/thephpleague/commonmark/blob/2.2/LICENSE)_\n* [League/Flysystem](https://flysystem.thephpleague.com) - _[MIT](https://github.com/thephpleague/flysystem/blob/3.x/LICENSE)_\n* [League/html-to-markdown](https://github.com/thephpleague/html-to-markdown) - _[MIT](https://github.com/thephpleague/html-to-markdown/blob/master/LICENSE)_\n* [League/oauth2-client](https://oauth2-client.thephpleague.com/) - _[MIT](https://github.com/thephpleague/oauth2-client/blob/master/LICENSE)_\n* [pragmarx/google2fa](https://github.com/antonioribeiro/google2fa) - _[MIT](https://github.com/antonioribeiro/google2fa/blob/8.x/LICENSE.md)_\n* [Bacon/BaconQrCode](https://github.com/Bacon/BaconQrCode) - _[BSD-2-Clause](https://github.com/Bacon/BaconQrCode/blob/master/LICENSE)_\n* [phpseclib](https://github.com/phpseclib/phpseclib) - _[MIT](https://github.com/phpseclib/phpseclib/blob/master/LICENSE)_\n* [Clockwork](https://github.com/itsgoingd/clockwork) - _[MIT](https://github.com/itsgoingd/clockwork/blob/master/LICENSE)_\n* [PHPStan](https://phpstan.org/) \u0026 [Larastan](https://github.com/nunomaduro/larastan) - _[MIT](https://github.com/phpstan/phpstan/blob/master/LICENSE) and [MIT](https://github.com/nunomaduro/larastan/blob/master/LICENSE.md)_\n* [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) - _[BSD 3-Clause](https://github.com/squizlabs/PHP_CodeSniffer/blob/master/licence.txt)_\n* [JakeArchibald/IDB-Keyval](https://github.com/jakearchibald/idb-keyval) - _[Apache-2.0](https://github.com/jakearchibald/idb-keyval/blob/main/LICENCE)_\n\nFor a detailed breakdown of the JavaScript \u0026 PHP projects imported \u0026 used via NPM \u0026 composer package managers, along with their licenses, please see the [dev/licensing/js-library-licenses.txt](dev/licensing/js-library-licenses.txt) and [dev/licensing/php-library-licenses.txt](dev/licensing/php-library-licenses.txt) files. ","funding_links":["https://github.com/sponsors/ssddanbrown","https://ko-fi.com/ssddanbrown"],"categories":["PHP","Apps","HarmonyOS","Tools","PHP (184)","Wiki","知识管理 wiki知识库","Uncategorised","Productivity","documentation","Application Recommendation","wiki","Wiki-Server","php","Self Hosted Web Applications","Resources","成品软件","Collaboration","Uncategorized","Table of Contents"],"sub_categories":["KnowledgeBase","Windows Manager","Documentation / Knowledge Management","网络服务_其他","Uptime Monitoring","📝 Document Collaboration","Example Applications","未归类","Knowledge Bases (Notion alternatives)","Uncategorized","Wiki"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBookStackApp%2FBookStack","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FBookStackApp%2FBookStack","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FBookStackApp%2FBookStack/lists"}