0% found this document useful (0 votes)

147 views11 pages

Work Inside Remote Project - IntelliJ IDEA

This document provides information about working inside a remote project in IntelliJ IDEA. Some key points: - A remote project can be opened and worked on like a local project, allowing editing, running applications, debugging, and deploying. - To set up the remote project, the SDK needs to be configured and VM options can be adjusted, especially to increase memory. - Features like GitHub integration and checking the backend control center are available in the remote session. - The remote session can be closed locally without closing it on the remote host. Multiple connections to the same or different remote hosts/IDE versions can also be created.

Uploaded by

hai1002

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

147 views11 pages

Work Inside Remote Project - IntelliJ IDEA

Uploaded by

hai1002

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 11

19/09/2022, 10:21 Work inside remote project | IntelliJ

IDEA

IntelliJ IDEA 2022.2

Remote development / Work inside remote project

Work inside remote project

Last modified: 08 August 2022

A remote project gets opened in JetBrains Client as it would be opened in your local
IntelliJ IDEA IDE. You can develop it like any other local project: edit code, run
applications, debug, and deploy.

[X]
Cookies
If youand IP addresses
want allow about
to find more us to deliver
and
the Remote improve our web content
Development and to and
processes provide you with a
architecture in
personalized experience.
Our website uses cookies and collects your IP address for these purposes.
general,
Learn more refer to Remote development overview.

JetBrains may use cookies and my IP address to collect individual statistics and to provide me with
personalized offers and ads subject to the Privacy Policy and the Terms of Use.
JetBrains may use

Add an SDK to the opened project

third-party services for this purpose. I can revoke my consent at any time by visiting the Opt-Out
page.

[Yes, I agree] [No, thanks]

https://www.jetbrains.com/help/idea/work-inside-remote-project.html 1/11
19/09/2022, 10:21 Work inside remote project | IntelliJ IDEA

When you first open a project, IntelliJ IDEA displays a notification suggesting to

add the project SDK.

1. Open the remote session.

2. From the main menu, select File | Project Structure.

3. In the Project Structure dialog, select Project, and from the available options,
configure the project's SDK.

4. Click OK to save the changes. IntelliJ IDEA downloads the configured SDK to the
remote server. The next time you open your project, the downloaded SDK will be
used automatically in the remote session.

Add VM options
You can adjust VM options for the remote project, especially if you want to increase
the -Xmx memory size when working with a larger project. You need to perform
those actions and save your changes on the remote server.

1. From the main menu, select Help | Edit Custom VM Options (On Host) .

2. Edit the idea64.vmoptions file.

For example, change the -Xmx2048 option to -Xmx3072 .

For more detailed information on VM options, refer to Advanced configuration.

3. Restart your IDE on the remote server to see the changes.

4. You may increase memory settings manually if your remote project doesn't start
properly.

[X]
Cookies and IP addresses allow us to deliver
and improve our web content and to provide you with a

Sign in to the GitHub on the remote backend

personalized experience.
Our website uses cookies and collects your IP address for these purposes.
Learn more

JetBrains may use cookies and my IP address to collect individual statistics and to provide me with
1. Press
personalized Ctrl+Alt+S
offers to open
and ads subject to the IDE settings
the Privacy Policy and select
and the Terms of Use.
JetBrains may use .Version Control | GitHub
third-party services for this purpose. I can revoke my consent at any time by visiting the Opt-Out
page.
2. Click Add Account, select the authorization method and sign in to your GitHub
[Yes, I agree] [No, thanks]
account.

https://www.jetbrains.com/help/idea/work-inside-remote-project.html 2/11
19/09/2022, 10:21 Work inside remote project | IntelliJ IDEA

Close the Remote Development session

• Click to close the remote session window.

You are returned to the JetBrains Gateway welcome screen where you can use
the Recent SSH projects page to reconnect to your remote session or stop the
running instance.

When you close the project locally, it doesn't get automatically closed
on the remote host.

[X]
Cookies and IP addresses allow us to deliver
and improve our web content and to provide you with a
personalized experience.
Our website uses cookies and collects your IP address for these purposes.
Create multiple connections
Learn more

JetBrains may use cookies and my IP address to collect individual statistics and to provide me with
personalized offers and ads subject to the Privacy Policy and the Terms of Use.
JetBrains may use
You can
third-party createfor
services multiple connections
this purpose. to the
I can revoke my same
consentremote
at any host and
time by the same
visiting version
the Opt-Out
page.of the IDE. You can also have connections with different IDE versions and remote

[Yes,hosts.
I agree] [No, thanks]

https://www.jetbrains.com/help/idea/work-inside-remote-project.html 3/11
19/09/2022, 10:21 Work inside remote project | IntelliJ IDEA

1. Connect and open a remote session.

2. Since JetBrains Gateway is constantly active once you have connected to the
remote server, you can click its icon to open the JetBrains Gateway welcome
screen and configure other connections.

If you connect to the same IDE version, then JetBrains Client will be opened as
an instance of the same process. If you connect to a different remote host or
IDE version, a different remote session will be launched.

You cannot connect to the same server from different computers. For
example, if you share a remote server with your team and want to work
on the same project, either wait until the server is free or request the
Code With Me link from the connected party to join the remote
session.

Backend control center

When you work with your remote project, you can check the status of the remote server.
That means you can check the CPU load, disk, and memory consumption on your
backend. You can also add heap size and restart the remote backend right from
JetBrains Client.

After opening your remote project, the name of your backend, memory and latency
indicators are displayed on the main toolbar.

Work with the control center window

JetBrains may use cookies and my IP address to collect individual statistics and to provide me with
personalized offers and ads subject to the Privacy Policy and the Terms of Use.
JetBrains may use
third-party services for this purpose. I can revoke my consent at any time by visiting the Opt-Out
page.1. In JetBrains Client, on the main toolbar, click the name of the remote server to

open the
[Yes, I agree] Connection Details window.
[No, thanks]

https://www.jetbrains.com/help/idea/work-inside-remote-project.html 4/11
19/09/2022, 10:21 Work inside remote project | IntelliJ IDEA

2. On the Performance tab, check the status of CPU load, memory consumptions,
and the disk space.

• Ping: this is a time indicator that shows how much time it takes to transfer
data between JetBrains Client and the remote server using RD protocol.

• CPU Load: this is an indicator of how many processes are executed by CPU.
• Memory (RAM): this is an indicator that shows the RAM state of the remote
server. If the memory limit is reached, you need to access your remote server
and increase RAM or terminate processes that consume it.

• Disk: this is an indicator of how much disk space is used by the remote server.
3. Click the Output tab to see the last 2500 symbols of the log file from the remote
server.

This information helps you to see the end of log file and potential errors or
issues that might have occurred.

[Yes, I agree] [No, thanks]

https://www.jetbrains.com/help/idea/work-inside-remote-project.html 5/11
19/09/2022, 10:21 Work inside remote project | IntelliJ IDEA

4. If you want to increase the heap memory size, click the Settings tab and in the
Maximum heap size field, add the needed amount of memory and click Save and
Restart to apply the changes. Alternatively, you can click Save if you don't want
to restart the backend immediately.

JetBrains may use cookies

If you encounter and my IP
a problem address in
working to JetBrains
collect individual statistics
Client, you and to
can open provide
a main me with
tool
personalized offers and ads subject to the Privacy Policy and the Terms of Use.
JetBrains may use
window services
third-party of the backend
for this IDE and Itry
purpose. torevoke
can fix your
my problem
consent at there.
any time by visiting the Opt-Out
page.

[Yes, I agree] [No, thanks]

https://www.jetbrains.com/help/idea/work-inside-remote-project.html 6/11
19/09/2022, 10:21 Work inside remote project | IntelliJ IDEA

Access the backend IDE UI

1. In JetBrains Client, on the main toolbar, click the name of the remote server to
open the Connection Details window.

2. In Connection Details window, click and select Show Main Window.

You can collect data and create a log file by selecting the Collect Host
and Client Logs option.

The main window of the backend IDE gets projected. Now you can use it to
access remote settings and configure various remote options if you couldn't do
that in JetBrains Client.

Keep in mind that the remote server is Linux, so the shortcuts that you
use to configure remote settings must be the Linux ones.

Manage credential storage

JetBrains may use cookies and my IP address to collect individual statistics and to provide me with
personalized offers and ads subject to the Privacy Policy and the Terms of Use.
JetBrains may use

mechanisms on a remote backend

third-party services for this purpose. I can revoke my consent at any time by visiting the Opt-Out
page.

[Yes, I agree] [No, thanks]

https://www.jetbrains.com/help/idea/work-inside-remote-project.html 7/11
19/09/2022, 10:21 Work inside remote project | IntelliJ IDEA

You can configure how to manage your passwords on the remote server and override
the default configuration.

By default, the KeePass manager is used for storing password information on the
backend as you can see in the backend password settings.

You can create a file to store the information about available and the default
authentication storage mechanisms and use it to override the ones provided by the
system.

For example, the KEEPASS mechanism keeps everything on the hard disk, which is a bit
of a downside. However, if you want to save credentials (database credentials, GitHub
tokens, and so on) between the IDE restarts, the KEEPASS mechanism should be your
choice.

On the other hand, the IN_MEMORY mechanism lets you keep everything inside the
memory of the running IDE, and clears everything on the IDE restart. Nothing gets
saved on the hard disk, which is safer.

Set up a file to store the credential storage mechanisms

for all backends
1. Create the CredentialStore directory and the following settingName files:

• defaultProvider : for the default password storage mechanism. The file will
contain one value from ( MEMORY_ONLY , KEYCHAIN , KEEPASS )

• availableProviders : for the available password storage mechanisms. The

file will contain comma-separated values from ( MEMORY_ONLY , KEYCHAIN ,
KEEPASS )

[X]
You can create the files on your local OS and copy them to the remote server or
Cookies and IP addresses allow us to deliver
and improve our web content and to provide you with a
create
personalized such files directly
experience.
Our website on
usesthe remote
cookies and server.
collects your IP address for these purposes.
Learn more
2. Add the created files to the remote server. If you created the files on your local
JetBrains may use cookies and my IP address to collect individual statistics and to provide me with
system,
personalized then
offers and you can usetothe
ads subject thefollowing command
Privacy Policy and the in the of
Terms terminal to copymay
Use.
JetBrains theuse
third-party services for this purpose. I can revoke my consent at any time by visiting the Opt-Out
page.
files to the needed location on your remote server:

[Yes, I agree]
scp [No, thanks]
source/filename [username]@[host]: destination

https://www.jetbrains.com/help/idea/work-inside-remote-project.html 8/11
19/09/2022, 10:21 Work inside remote project | IntelliJ IDEA

The location of the files on the remote backend is as follows:

• $HOME/.config/JetBrains/CredentialStore/settingName (for the user-

specific settings)

• /etc/xdg/JetBrains/CredentialStore/settingName (for the system-wide

settings)

3. After you've added the files to the remote server, the password settings will
display only the default and the available password storage providers.

[Yes, I agree] [No, thanks]

https://www.jetbrains.com/help/idea/work-inside-remote-project.html 9/11
19/09/2022, 10:21 Work inside remote project | IntelliJ IDEA

Access remote password settings

1. Open main window and click File | Settings.

2. Select Appearance Behavior | Passwords.

3. The Passwords settings page displays the default mechanisms to store your
credentials, which you can use to configure the settings.

[Yes, I agree] [No, thanks]

https://www.jetbrains.com/help/idea/work-inside-remote-project.html 10/11
19/09/2022, 10:21 Work inside remote project | IntelliJ IDEA