This is the source code for The JumpServer’s documentation, accessible at Docs dev

Please read CONTRIBUTING.md. Thank you ❤️

This project is built on Next.js. You can run it on your machine, provided you have Node 20+ and pnpm installed.

First, clone the repo:

git clone [email protected]:jumpservice/documentation.git

Make sure you are inside the folder:

cd documentation

Install the dependencies:

pnpm i

Then, run the project:

pnpm dev

If an error occurs during startup, try the following steps:

rm -rf .next/ node_modules/
pnpm install
pnpm dev

That’s it! Go to http://localhost:3000 to see it in action. Any change you make to a file in pages should be refreshed automatically in your browser.

The icon used in this project is licensed under the Creative Commons Attribution 4.0 International (CC BY 4.0) license.
Original icon by Iconduck - HfG Schwäbisch Gmünd.

The icons used in this project are licensed under the GNU General Public License v2.0 (GPL-2.0).
Original icons from Iconduck - Ardis.