Skip to content
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.

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

add troubleshooting page for jb plugins #48

Merged
merged 1 commit into from
Oct 28, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
10 changes: 10 additions & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,16 @@ export default defineConfig({
] },
]
},
{
label: 'Plugins',
items: [
{ label: 'JetBrains IDEs',
items: [
{ label: 'Troubleshooting', link: '/guides/plugins/jetbrains/troubleshooting/' },
]
},
]
},
{ label: 'Authentication',
items: [
{ label: 'Keycloak Integration', link: '/guides/authentication/keycloak/' },
Expand Down
Binary file added src/assets/jb_jcef_disable_sandbox.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/jb_jcef_many_restart_notification.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/jb_jde_confirmation.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/jb_jde_list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/jb_jde_selection.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added src/assets/jb_popup_jcef_notification.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
42 changes: 42 additions & 0 deletions src/content/docs/guides/plugins/jetbrains/troubleshooting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
---
title: Troubleshooting
---

## Fixing the Refact.ai Plugin in JetBrains IDEs without JCEF

### Changing the JBR in JetBrains IDEs to Fix the Markdown Plugin

After installing the Refact.ai plugin in JetBrains IDEs, you may receive a notification indicating that the plugin is not functioning correctly.

![JCEF notification](../../../../../assets/jb_popup_jcef_notification.png)

To utilize chat functionality, JCEF - [Java Chromium Embedded Framework](https://plugins.jetbrains.com/docs/intellij/jcef.html) - is required. JCEF is pre-bundled in the JDK (also referred to as JBR - JetBrains Runtime) with IntelliJ IDEA versions starting from 2020.2.

The solution is to bundle the IDE with a JBR that integrates JCEF.

Fortunately, the JBR can be modified, and JetBrains provides the JBRs for download. JetBrains also offers a [guide to change JBR](https://intellij-support.jetbrains.com/hc/en-us/articles/206544879-Selecting-the-JDK-version-the-IDE-will-run-under), although compatibility with all versions of the IDE may vary.

### Choosing the Boot Java Runtime:

1. Open the menu **Help** > **Find Action…** (`⇧ Shift` + `⌘ Cmd` + `A`) and search for “Choose Boot Java Runtime for the IDE…” and execute it.
2. In the dialog, open the drop-down **Select runtime**.
Note: It is advisable to select the same JBR version that was originally set as default in the IDE.
![JDE selection](../../../../../assets/jb_jde_selection.png)
3. Either accept the default selection or choose one that includes JCEF in its title. Confirm your choice by clicking OK.
![JDE list](../../../../../assets/jb_jde_list.png)
4. After downloading and installing, you must apply the changes by selecting **Restart now**.
![JDE confirmation](../../../../../assets/jb_jde_confirmation.png)

You are now ready to enjoy the complete Refact.ai experience.

### Disabling the JCEF Sandbox

It is highly probable that you will encounter the following message after restarting the IDE:
![JCEF many restarts notification](../../../../../assets/jb_jcef_many_restart_notification.png)
To resolve this issue:
* Open the menu **Help** > **Find Action…** (`⇧ Shift` + `⌘ Cmd` + `A`) and search for “Registry…” and execute it.
* Locate the key `ide.browser.jcef.sandbox.enable` by typing the initial letters or scrolling through the list.
* Disable this key.
![JCEF disable sandbox](../../../../../assets/jb_jcef_disable_sandbox.png)
* Close the Registry Editor.
* Restart the IDE.
Loading