BookStack alternatives and similar software solutions
Based on the "Wikis" category.
Alternatively, view BookStack alternatives based on common mentions on social networks and blogs.
7.0 4.5 BookStack VS GititA 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.
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest. Visit our partner's website for more details.
Do you think we are missing an alternative of BookStack or a related project?
A platform for storing and organising information and documentation. Details for BookStack can be found on the official website at https://www.bookstackapp.com/.
- Installation Instructions
- Demo Instance
- BookStack Blog
- Issue List
- Discord Chat
📚 Project Definition
BookStack is an opinionated wiki system 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.
BookStack is not designed as an extensible platform to be used for purposes that differ to the statement above.
In regards to development philosophy, BookStack has a relaxed, open & positive approach. At the end of the day this is free software developed and maintained by people donating their own free time.
🛣️ Road Map
Below is a high-level road map view for BookStack to provide a sense of direction of where the project is going. This can change at any point and does not reflect many features and improvements that will also be included as part of the journey along this road map. For more granular detail of what will be included in upcoming releases you can review the project milestones as defined in the "Release Process" section below.
- Platform REST API (Base Implemented, In review and roll-out)
- A REST API covering, at minimum, control of core content models (Books, Chapters, Pages) for automation and platform extension.
- Editor Alignment & Review
- Review the page editors with goal of achieving increased interoperability & feature parity while also considering collaborative editing potential.
- Permission System Review
- Improvement in how permissions are applied and a review of the efficiency of the permission & roles system.
- Installation & Deployment Process Revamp
- Creation of a streamlined & secure process for users to deploy & update BookStack with reduced development requirements (No git or composer requirement).
🚀 Release Versioning & Process
BookStack releases are each assigned a version number, such as "v0.25.2", in the format
v<phase>.<feature>.<patch>. A change only in the
patch number indicates a fairly minor release that mainly contains fixes and therefore is very unlikely to cause breakages upon update. A change in the
feature number indicates a release which will generally bring new features in addition to fixes and enhancements. These releases have a small chance of introducing breaking changes upon update so it's worth checking for any notes in the update guide. A change in the
phase indicates a much large change in BookStack that will likely incur breakages requiring manual intervention.
Each BookStack release will have a milestone created with issues & pull requests assigned to it to define what will be in that release. Milestones are built up then worked through until complete at which point, after some testing and documentation updates, the release will be deployed.
For feature releases, and some patch releases, the release will be accompanied by a post on the BookStack blog which will provide additional detail on features, changes & updates otherwise the GitHub release page will show a list of changes. You can sign up to be alerted to new BookStack blogs posts (once per week maximum) at this link.
🛠️ Development & Testing
All development on BookStack is currently done on the master branch. When it's time for a release the master branch is merged into release with built & minified CSS & JS then tagged at its version. Here are the current development requirements:
- Node.js v10.0+
# Install NPM Dependencies npm install # Build assets for development npm run build # Build and minify assets for production npm run production # Build for dev (With sourcemaps) and watch for changes npm run dev
BookStack has many integration tests that use Laravel's built-in testing capabilities which makes use of PHPUnit. There is a
mysql_testing database defined within the app config which is what is used by PHPUnit. This database is set with the database name, user name and password all defined as
bookstack-test. You will have to create that database and that set of credentials before testing.
The testing database will also need migrating and seeding beforehand. This can be done with the following commands:
php artisan migrate --database=mysql_testing php artisan db:seed --class=DummyContentSeeder --database=mysql_testing
Once done you can run
php vendor/bin/phpunit in the application root directory to run all tests.
📜 Code Standards
PHP code within BookStack is generally to PSR-2 standards. From the BookStack root folder you can run
./vendor/bin/phpcs to check code is formatted correctly and
./vendor/bin/phpcbf to auto-fix non-PSR-2 code. Please don't auto-fix code unless it's related to changes you've made otherwise you'll likely cause git conflicts.
🐋 Development using Docker
This repository ships with a Docker Compose configuration intended for development purposes. It'll build a PHP image with all needed extensions installed and start up a MySQL server and a Node image watching the UI assets.
To get started, make sure you meet the following requirements:
- Docker and Docker Compose are installed
- Your user is part of the
If all the conditions are met, you can proceed with the following steps:
APP_KEYto a random 32 char string and set
- Make sure port 8080 is unused or else change
DEV_PORTto a free port on your host.
chgrp -R docker storage. The development container will chown the
storagedirectory to the
www-datauser inside the container so BookStack can write to it. You need to change the group to your host's
dockergroup here to not lose access to the
docker-compose upand wait until the image is built and all database migrations have been done.
- You can now login with
passwordas password on
localhost:8080(or another port if specified).
If needed, You'll be able to run any artisan commands via docker-compose like so:
```shell script docker-compose run app php artisan list
*Note that all licence references and agreements mentioned in the BookStack README section above are relevant to that project's source code only.