Install Doctopus
Choose a setup, build your first site and find the right integration.
From this demo to your own documentation
This demo uses fictional Orbit data. The guides below document Doctopus itself: installing the tool, supplying your OpenAPI YAML or JSON, writing guides and publishing your site.
Start with the installation and usage guide. It walks through a working source installation and clearly distinguishes optional services. The renamed packages are not yet published; use the documented source workflow rather than assuming a registry release is available.
Choose your setup
- Host a static site. Build and publish a static site on your preferred host. No application server or database is needed at runtime.
- Use an existing Java application. Follow the Spring Boot installation to serve documentation from your application.
- Use an existing Node.js application. Follow the Express and Fastify installation to mount the built site in your app.
- Manage projects centrally. Follow the Server and Studio installation for projects, access and publications. This setup needs PostgreSQL and artifact storage.
- Automate approved builds. Add a Worker to the management platform on a separate build host.
Node.js and the CLI are needed at build time for every setup. Static sites and Java integrations do not need a Node process at runtime. Studio, Worker and PostgreSQL are optional for a simple documentation UI.
Find your next guide
- Installation: full walkthrough, CLI commands, and packages and releases.
- Integrations: Spring Boot and Node.js, OpenAPI import, and supported specifications.
- Authoring: write guides, configure your site, build plugins, versions, and languages.
- Playground: authentication, request bodies, parameters, and mock responses.
- Operations: Server and Studio, build management, Worker setup, deployment and recovery, offline installation, and diagnostics.
The sidebar follows these groups in reading order. Use Documentation to browse the handbook, API Reference for the fictional Orbit endpoints, or search for a topic. Each guide has its own static URL and remains readable without JavaScript.