Skip to content

Adding docs on how to add certificates (#1153) #1313

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Adding docs on how to add certificates (#1153) #1313

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/users-guide/modules/ROOT/nav.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,3 +61,4 @@
** xref:faq/troubleshooting-mps.adoc[]
** xref:faq/diagrams-in-pdf-without-text.adoc[]
** xref:faq/could-not-find-dot-executable.adoc[]
** xref:faq/custom-tls-certificates.adoc[]
7 changes: 7 additions & 0 deletions doc/users-guide/modules/ROOT/pages/faq.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -129,3 +129,10 @@ Please consider adding a rating for the plugin in the https://plugins.jetbrains.

This plugin is based on Asciidoctor and a lot of ideas from its community.
To support Asciidoctor, please consider contributing funds via https://opencollective.com/asciidoctor[Open Collective].

=== I'm getting an error "`SSLError / certificate verify failed`"

This happens if the remote server presents a certificate which is not trusted.
Usually this happens if it uses a self-signed certificate or an unknown/private root certificate authority.

See the page about xref:faq/custom-tls-certificates.adoc[] on how to fix this.
28 changes: 28 additions & 0 deletions doc/users-guide/modules/ROOT/pages/faq/custom-tls-certificates.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
= Custom TLS certificates
:navtitle: Custom TLS certificates
:description: When connecting to TLS with custom TLS certificates, users need to add them to the truststore of the IDE.

{description}

== Symptom

When rendering an AsciiDoc document which for example connects to a Kroki diagram server that presents a self-signed certificate, the output contains an error similar to the following:

====
org.jruby.exceptions.StandardError: (SSLError) asciidoctor: FAILED: ...: Failed to load AsciiDoc document - certificate verify failed
====

== Cause: Untrusted certificate authority

This happens if the remote server presents a certificate which is not trusted.
Usually this happens if it uses a self-signed certificate or an unknown/private root certificate authority.

== How do I fix this?

Add the self-signed certificate or the matching root certificate authority to the IntelliJ's `cacerts` file.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

cacerts file is located here: INTELLIJ_HOME/jbr/lib/security/cacerts.

This solution requires write access to cacerts, which may be an issue on company maintained/protected laptops.

The easiest solution to me is to simply remove kroki-fetch-diagram: true from antora-playbook.yaml

Users can also add certificates via the menu menu:File[Settings... > Tools > Server Certificates]. See https://www.jetbrains.com/help/idea/settings-tools-server-certificates.html[the IDE's help] for details.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one doesn't work for me, similarly to "Accept non-trusted certificates automatically" - diagrams are still not rendered


== Help, it still doesn't work!

To have the maintainers investigate the issue, open a https://github.com/asciidoctor/asciidoctor-intellij-plugin/issues[GitHub issue].