____                  __          ____
     / __ \____  _____ ____/ /_  ____  / / /_
    / /_/ / __ `/ ___/ ___/ __ \/ __ \/ / __/
   / ____/ /_/ (__  |__  ) /_/ / /_/ / / /_
  /_/    \__,_/____/____/_,___/\____/_/\__/

The open-source password management solution for teams
(c) 2024 Passbolt SA
https://www.passbolt.com

License

Passbolt help site code is distributed under the Affero General Public License v3

Passbolt help text are distributed under Creative Common BY-SA-4.0

Logos in /static/img belongs to their respective owners and used for illustrative purpose.

Passbolt - Open source password manager for teams (c) 2024 Passbolt SA

This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License (AGPL) as published by the Free Software Foundation version 3.

The name "Passbolt" is a registered trademark of Passbolt SA, and Passbolt SA hereby declines to grant a trademark license to "Passbolt" pursuant to the GNU Affero General Public License version 3 Section 7(e), without a separate agreement with Passbolt SA.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License along with this program. If not, see GNU Affero General Public License v3.

About Passbolt help site

This repository contains the code used for the knowledge base and help section of passbolt website. Find out more about passbolt here: https://www.passbolt.com

Prerequisites

• Node.js 24.x

Getting started

git clone git@github.com:passbolt/passbolt-docs.git
cd passbolt-docs
npm install
npm run start

This will start a local development server with hot reload at http://localhost:3000.

Available scripts

Command	Description
npm run start	Start the development server
npm run build	Build for production
npm run serve	Serve the production build locally
npm run lint	Lint JS/JSX files
npm run lint:mdx	Lint MDX files
npm run lint:fix	Auto-fix lint issues in JS/JSX files
npm run lint:fix:mdx	Auto-fix lint issues in MDX files

Contributing

Help us maintaining this documentation by following our contributors guide