Package: projector-installer
projector-installerInstall, configure and run JetBrains IDEs
withProjector Serveron Linux or
inWSL.Latest release|Sources|ChangelogTable of ContentsInstallationQuick startFAQSecure connectionprojector-installer config directoryAndroid Studio supportprojector command is unavailableWSL issuesprojector exits immediatelyUsing Projector as systemd serviceChange existing configurationprojector config update does not workFreeBSD supportOpenBSD supportI edited the config file manually but nothing changedSelf-generated certificate is expiredInstallationPrerequisitesTo use projector-installer you need machine with Linux (or WSL) and with Python 3.6 or higher. Before install
projector-installer make sure that:python3, pip3 and necessary packages are installed in your system.
In Debian-based distributions you can install them using the command:sudoaptinstallpython3python3-pippython3-cryptographypython3-netifaces-yIn CentOS use commands:# CentOS 8+sudodnfinstallpython3python3-pippython3-pyOpenSSLpython3-cryptographypython3-netifaces-y# CentOS 7 / Amazon Linux 2sudoyuminstallpython3python3-pippyOpenSSLpython-cryptography-yUpdate pip.For Debian-based distributions runpython3-mpipinstall-UpipFor CentOS use command:python3-mpipinstall-Upip--userMake sure that you have installed the following packages:lesslibxext6libxi6libxrender1libxtst6libfreetype6For Debian-based distributions you can install them using the command:sudoaptinstalllesslibxext6libxrender1libxtst6libfreetype6libxi6-yFor CentOS use command:sudoyuminstalllesslibXextlibXrenderlibXtstlibXifreetype-yInstall from PyPiYou can install projector-installer script from PyPi, using command:pip3installprojector-installer--userprojectorscript will be installed in~/.local/bindirectory. To make it available
on Debian-based systems run:source~/.profilefor CentOS run:source~/.bash_profileThe commandprojectorshould be available now.NOTE:If it is not so, please refer to theappropriate sectionin theFAQ.NOTE:projector script checks for updates on start. If a new version is available, you can install an update using
commandpip3 install projector-installer --upgrade --userQuick startThe first time you run projector, it will automatically download, install, configure and start IDE. Just run projector and
follow the instructions. The script will run the installed IDE with projector-server and display URLs to access it. Open
a URL in your browser and use IDE as usual.To run IDE again useprojector runTo install a new IDE runprojector installTo find out which JetBrains IDEs are supported, runprojector findTo get help projector commands runprojector --helpIf you want to know more on projector usage please refer tothisfile.FAQSecure connectionSECURITY WARNING:
Keep your projector config directory safe when using domain certificate and private key!
Do not share its content with anybody!Installer is able to make run config use HTTPS for accessing a built-in HTTP server and WSS to communicate with the
Projector server. Using a secure connection may be a good idea because some JavaScript features are not available in
insecure environments, for example:Asynchronous Clipboard API. So using Projector with
insecure protocols may limit its functionality.To enable this feature user should modify existing run config with install-certificate command.There are several options:Use certificate for the domain signed by known certification center. For this case use command:projector install-certificate config_name --certificate /path/to/cert.pem --key /path/to/privatekey.pemIn rare cases this command may fail, if installer is not able to obtain full certificate chain. In this case user should
provide intermediate certificate chain explicitly, using commandprojector install-certificate config_name --certificate /path/to/cert.pem --key /path/to/privatekey.pem --chain /path/to/chain.pemNote:Do not forget to use domain name or IP address, included to certificate to access Projector.Use self-signed certificate. For this scenario use command:projector install-certificate config_name --certificate /path/to/cert.pem --key /path/to/privatekey.pemDo not forget to add the certificate to your browser if it was not done before.Instruct the installer to autogenerate certificate for you. For this scenario, just don't include certificate and key
files to install-certificate command:projector install-certificate config_nameUsing a secure connection with autogenerated certificate requires telling the browser that it should trust the
certificate. One of the ways to do it is to do it forcefully. Open the page, see the warning about unknown certificate,
find a button like "trust it anyway", and click it. After it, you will probably get a message like "can't connect to
wss://host:port". Please change wss to https, open it in a new tab, and click the "trust" button too. After performing
these two actions, the browser should remember this connection and you won't have to perform these actions again. Just
open the initial web page and use all functionality of Projector.projector-installer config directoryprojector-installer keeps downloaded IDE and run configurations in the configuration directory. Usually configuration
directory is ~/.projector. User can specify another location for it, using option --config-directory, for example:projector --config-directory=config runAndroid Studio supportProjector installer can't support automatic Android Studio installation due to legal issues. However, installer can help
you to configure already installed Android Studio to use with Projector. To make new run config for Android Studio
use theprojector config addcommand.NOTE:Please take into account, that Projector uses JVM, bundled with IDE and supports Java 11 only. Most of Android
Studio IDE shipped with Java 1.8, so they are incompatible with Projector. However, starting from version 4.2 (still in
EAP), Google ships Java 11 with Android Studio. So Android Studio ver. 4.2 and later can be run with projector.Example:$projectorconfigadd
Enteranewconfigurationname:AndroidStudio
DoyouwanttochooseaProjector-installedIDE?[y/n]:n
EnterthepathtoIDE:/path/to/your/android-studio
...projector command is unavailableDefault instruction installsprojectorscript in directory~/.local/bin. If system can't find the script after
installation it means that the directory~/.local/binwas not included in thePATHenvironment variable.
Try the following:Restart the terminal. Ifprojectorwas the first executable installed in~/.local/bin, and the directory wasn't
exist when your login session started, it may help.In some Linux distributions the directory~/.local/binnot included in thePATHenvironment variable. In this case addexport  PATH=${PATH}:~/.local/binto your~/.profileand runsource ~/.profile.WSL issuesWSL is new technology and sometimes there are problems with network interfaces forwarding from Linux to Windows system.
For example:https://github.com/microsoft/WSL/issues/4636.If you have issues with accessing Projector running in WSL from the browser, try the following:Do not use several WSL machines in the same time. Connectivity issues rarely happens if only one WSL machine is
running. You can check state of existing WSL machines usingwsl -l -vcommand.Try commandGet-Service LxssManager | Restart-Servicein PowerShell consoleRestart your WSL environment:wsl --shutdownand start your linux console again.WARNING!Thewsl --shutdowncommand will close all Linux consoles. Save your work before stopping WSL!Using docker service with WSL2 backend can cause connectivity issues. Try to disable it and restart WSL terminal.Use address other than localhost. Usually WSL have problems forwarding localhost interface only. Try to use listening
address other than localhost. You can assign HTTP listening address during initial installation or usingprojector config editcommand.projector exits immediatelyMake sure that you installed all packages mentioned inPrerequisitessection.Check log-file (it's location shown in console when installer runs the config).Make sure that there is no another instance of same config running.Using Projector as systemd serviceStraightforward creating systemd service to automatically start Projector in the background, lead to projector zombie
process. You can avoid this using projector generated run script instead of using projector run command. For details
refer to the answer ofthisissue.Change existing configurationTo change run config (for example - change listening port or access password) use commandprojector config editprojector config update does not workProbably your run configuration uses "tested" update channel.
Try change update channel to not_tested.
You can inspect view update channel usingprojector config showcommand and
change it viaprojector config edit.FreeBSD supportprojector-installer since ver. 1.1.0 has FreeBSD support.
To run Projector on FreeBSD perform the following steps
(tested on FreeBSD-RELEASE 12.2):install python 3.7 with necessary packages:sudo pkg install python37
sudo pkg install py37-pip
sudo pkg install py37-cryptographyinstall openjdk11:sudo pkg install openjdk11Do not forget add to fstab fdeskfs and procfs:fdesk /dev/fd fdeskfs rw  0 0
proc  /proc   procfs  rw  0 0and mount them:mount -ainstall projector-installer from sources as describedherepip may fire several warning messages on incompatible cryptography module.
You can safely ignore them.add ~/.local/bin directory to PATH variable.runprojectoras usualOpenBSD supportprojector-installer since ver. 1.1.0 has OpenBSD support.
To run Projector on OpenBSD perform the following steps
(tested on OpenBSD 6.8):it is expected, that filesets xbase, xfont, xserv and xshare
are already installed in your system. If it is not so add them as described here:https://www.openbsd.org/faq/faq4.html#FilesNeededinstall python 3.7 or later:doas pkg_add pythoninstall pip:doas pkg_add py3-pipDo not forget to make the symbolic link for installed pip to  /usr/local/bin/pip.install py3-cryptography:doas pkg_add py3-cryptographyinstall openjdk11doas pkg_add jdkDo not forget to define JAVA_HOME variable and add $JAVA_HOME/bin to PATH variable.install projector-installer from sources as describedhereor install from pypi usingpip install projector-installeradd ~/.local/bin directory to PATH variable.runprojectoras usualI edited the config file manually but nothing changedIt's not recommended to manually modify config file. Please use theprojector config editcommand.
But, if you edited config.ini file, do not forget to runprojector config rebuildcommand to apply manual changes to runconfig.Self-generated certificate is expiredTo generate new certificate runprojector config rebuildcommand for desired config.