Welcome to the Runtipi documentation repository! Here you will find all guides, references and configuration options for the Runtipi.
The docs are built with Nextra. We use Bun as a package manager and Node.js as a runtime (Next.js and Bun don't play well together at the moment). Docs pages are written in MDX and any custom components are written in TypeScript with TSX.
Prerequisites:
- A recent Node.js version (22 recommended)
- Bun
git clone https://github.com/runtipi/runtipi-docs
cd runtipi-docs
bun installYou're ready to go!
The available scripts are:
bun devstarts the development server. Note that making changes to MDX pages will probably require a full reload.bun run buildcreates a static production build, ready to be deployed.bun lintchecks for errors in your code.bun fmtformats your code with Prettier, so it becomes... prettier.
Our documentation is always evolving, so, we constantly need to update this repository with new guides and configuration options. If you have any ideas of a guide or suggestions on how to improve them, feel free to open a pull request or create an issue. All contributions are welcome!
The documentation is licensed under the MIT License. TL;DR — You are free to use, copy, modify, merge, publish, distribute, sublicense, and sell copies of the software. However, the software is provided "as is," without warranty of any kind. You must include the original license in all copies or substantial portions of the software.