desktop-launcher

The Kernel

This process is started by the kernel hidden renderer process and communicates with the main process via IPC. Normally this is taken care of for you if you are using the desktop companion, but you may prefer to launch it manually if you run into issues or we don't support your platform.

Starting the Kernel Manually

jupyter notebook --NotebookApp.open_browser="False" --NotebookApp.allow_origin="*" --NotebookApp.token="CHOOSE A TOKEN VALUE"

Alternatively you can use jupyter lab:

jupyter lab --no-browser --NotebookApp.allow_origin="*" --NotebookApp.token="CHOOSE A TOKEN VALUE"

Setting the CORS Access-Control-Allow-Origin to * is generally a bad practice for security reasons. This will allow any website or malicious agent to execute code against your machine if they know what to look for. Instead, use the following origins depending on if you are in development or production:

• Development: http://localhost:4000
• Production: https://app.actuallycolab.org

Similarly, you should choose a secure value for the token to make sure malicious clients can't connect to execute code

Stopping the Kernel

Run the following command to stop the kernel process:

jupyter notebook stop

If the kernel is running on a port other than the default 8888, you can add the port to the end of the command.

To get a list of running ports you can run the following:

jupyter notebook list

Starting Development

yarn start

Debugging Prod

To run the production package with devtools and a visible kernel window:

yarn cross-env DEBUG_PROD=true yarn package

Packaging for Production

To package apps for the local platform:

yarn package

To package apps for all platforms:

yarn package:all

To notarize on macOS you need to create a file macos.cred.sh at the root of the project:

#!/bin/bash
export CI="true"
export APPLE_ID="email goes here"
export APPLE_ID_PASS="password goes here"

You may need an app specific password which you can generate on the AppleID webpage.

Then run the following command:

yarn package:notarize

Docs

See docs and guides here

Backers

Support us with monthly donations to help us continue development and keep the service free for all!

Sponsors

Become a sponsor and we'll add your logo to our README and link to you on our website!

Maintainers

• Jeff Taylor-Chang
• Bailey Tincher

License

@actually-colab/desktop-launcher is BSD-3-Clause licensed