This repository provides the documentation for the OpenIddict project.
Security issues and bugs should be reported privately by emailing security@openiddict.com. You should receive a response within 24 hours. If for some reason you do not, please follow up via email to ensure we received your original message.
In order to build and run the documentation locally, follow these steps:
-
Clone the Git repository including submodules:
git clone --recurse-submodules https://github.com/openiddict/openiddict-documentation.git
-
Install docfx as a global tool:
dotnet tool update -g docfx
-
Build the documentation and serve it locally:
docfx docfx.json --serve
The documentation will be available on http://localhost:8080.
If you need support, please first make sure you're sponsoring the project. Depending on the tier you selected, you can open a GitHub ticket or send an email to contact@openiddict.com for private support.
Alternatively, you can also post your question on Gitter.
Important
With OpenIddict 5.x being now generally available, the previous version, OpenIddict 4.x, stops being supported and won't receive bug fixes or security updates. As such, it is recommended to migrate to OpenIddict 5.x to continue receiving bug and security fixes.
There are, however, two exceptions to this policy:
-
ABP Framework 7.x users will still receive patches for OpenIddict 4.x for as long as ABP Framework 7.x itself is supported by Volosoft (typically a year following the release of ABP 8.x), whether they have a commercial ABP license or just use the free packages.
-
OpenIddict sponsors who have opted for a $250+/month sponsorship are now offered extended support:
- $250/month sponsors get full support for OpenIddict 4.x until June 18, 2024 (6 months).
- $500/month sponsors get full support for OpenIddict 4.x until December 18, 2024 (12 months).
- $1,000/month sponsors get full support for OpenIddict 4.x until December 18, 2025 (24 months).
OpenIddict is actively maintained by Kévin Chalet. Contributions are welcome and can be submitted using pull requests.
This project is licensed under the Apache License. This means that you can use, modify and distribute it freely. See http://www.apache.org/licenses/LICENSE-2.0.html for more details.