Open Authenticator Docs

The website of Open Authenticator.
Check it out »

Website · App · Backend · Contribute

Overview

Open Authenticator Docs is the public-facing website for the Open Authenticator project. It includes :

• the main landing page ;
• platform-specific download links ;
• FAQ ;
• contact page ;
• a translation page ;
• privacy policy and terms of service.

Tip

If you like this project, consider starring it on GitHub !

Requirements

Open Authenticator Docs is powered by Nuxt, therefore, you will need to have Node.js installed.

Note

Open Authenticator Docs is designed to be statically generated and deployed to GitHub Pages. You can see the workflow in action here.

Installation

To clone the repository and install dependencies, run in a shell :

git clone https://github.com/openauthenticator-app/docs.git
cd docs
npm install

Local development

Start the development server :

npm run dev

The site will then be available at http://localhost:3000.

Build and static Generation

Create a production build :

npm run build

Generate the static version of the site :

npm run generate

Preview the production build locally :

npm run preview

Contributing

Contributions are more than welcome. For setup details, contribution rules and PR expectations, read the guidelines.

You can also help by :

• reporting bugs or suggesting features in the issue tracker ;
• submitting fixes for documentation, UI text or code.

Support the project

If you want to support Open Authenticator financially, you can use :

• Ko-fi
• PayPal
• GitHub Sponsors

License

Open Authenticator Docs is licensed under the GNU General Public License v3.0.