can either link to redoc hosted elsewhere or make a local copy: - for local frontend build, just redirect to http://localhost:30870/api/redoc - for deployment, make local copy: run copy-api-docs.sh, copy locally from prod and serve at /api/ - copy-api-docs.sh copies openapi.json, redoc and logo to /api/ dir - if analytics enabled, also injects analytics scripts - for local testing, run copy-api-docs.sh and then run mkdocs serve - ci: copy from prod server - fixes #1582
1.4 KiB
1.4 KiB
| hide | ||
|---|---|---|
|
Browsertrix Docs
Browsertrix is an open source web archiving system created by Webrecorder. Sign up for Browsertrix to start archiving with zero setup, or follow our self-hosting guide to deploy Browsertrix on your own infrastructure.
Documentation
Docs are organized into the following sections:
- User Guide — Instructions on how to use Browsertrix to create and share web archives.
- Self-Hosting — Instructions on how to install, set up, and deploy self-hosted Browsertrix.
- Development — Contribute to the open source development of Browsertrix software.
- API Reference - Full API reference for interacting with the Browsertrix backend.
If you have feedback on the docs, please feel free to reach out to us.
Support
For help with a specific topic, try our community help forum.
Dedicated professional support is available with a custom subscription or support contract. Check out our plans for details.
Bugs
For bug reports or feature requests, please open a GitHub issue.