SSH into NimbleBox
Step 1 - To get started , you’ll need to install the NimbleBox python SDK nbox using PyPI.
1
pip install nbox
Copied!
Step 2 - The nbox stores secrets in the local file system like gcloud, aws and many others. After installation, it must be initialised in order to create ~/.nbx/secrets.json. (Secrets - Authentication Token) On the first run of nbox, you will be asked for your username and password.
1
python -m nbox status
Copied!
Now that you have authenticated yourself, and as long as the secrets are stored it will never ask your username / password again.
Step 3 - Begin by launching your instance from the dashboard or by using a command line interface.
1
python3 -m nbox instance --id_or_name=<your-instance-name> start
2
# TODO: Replace your instance name with <your-instance-name>
Copied!
Step 4 - To SSH into your instance, use the command below:
1
python3 -m nbox tunnel 8000 jupyter:8001 -i <your-instance-name>
2
# TODO: Replace your instance name with <your-instance-name>
Copied!
Notice the password in your logs
If everything goes right it will prompt you to add new host . Type “yes” and check logs to see the password, a new password is generated for every session. Your SSH terminal should open up and localhost:8001 will have the jupyter notebook running .

Adding to VSCode

  1. 1.
    Go to the extensions, search for “Remote - SSH” and install it.
Installation of Remote-SSH in VSCode
2. Type “Cmd+Shift+P” (macOS) or “Ctrl+Shift+P” (Linux). Add a new SSH host. When prompted, type the command “ssh -p 8000 [email protected]” and then select your user’s SSH folder. This is required for the first time or when the port changes.
Adding new SSH host
3. Now connect to the host and select “localhost”. When prompted, copy paste the password from your logs.
Connecting to host
4. Now click “Open Folder” and open path: “/mnt/disks/user/project”
Open file with this path
Exit and Close: For graceful exit from the tunnel press Ctrl+D and then Ctrl+C
5. To stop the instance
1
python3 -m nbox instance --id_or_name="nbox-dev" stop
Copied!

🔧 TroubleShooting

1) Forgot your password If you have forgotten your password, use the 'Forgot Your Password' link on the login page to reset it.
2) SSH Unauthenticated Navigate to your SSH known_hosts (see “/Users/.../.ssh/known_host” below) and remove line starting with [localhost]
See known hosts for your user
Remove the line starting with “[localhost]:8000”
3) Jupyter shows 404 If a 404 error occurs when visiting localhost:8000, please click on the jupyter button on the top of the page.
404 error by jupyter