Edit

Quick Start to macOS

This guide provides instructions for connecting from the NoPorts desktop application, to a machine running macOS .

Step 9 and Step 10

Complete these steps on the machine you are connecting to (MacOS)

On the machine you are connecting to

Step 9: Download and run the Installer

Open a terminal and download the installer from GitHub by running the following command:

curl -L https://github.com/atsign-foundation/noports/releases/latest/download/universal.sh -o universal.sh

To check if the installation downloaded correctly:

stat universal.sh

Make the script executable and run the script by running the command below:

chmod u+x universal.sh
./universal.sh

During installation, you’ll be prompted to enter the following items:

You may be asked to enter your password if your machine requires sudo privileges.

The install type

  • Enter device when prompted.

Your atSigns

  • Client atSign: e.g., @example01_np

  • Device atSign: e.g., @example02_np

Your device name

  • This should be the name of the machine you're currently installing on.

Step 10: Initiate atSign authorization request

Run the following command to make an authorization request:

Be sure to replace the following values:

@<REPLACE>_np with your device atSign,

<PASSCODE> with the passcode generated in Step 7,

@<REPLACE>_np_key with your device atSign,

<DEVICE_NAME> with the name of the machine you are on

~/.local/bin/at_activate enroll -a @<REPLACE>_np \
  -s <PASSCODE> \
  -p noports \
  -k ~/.atsign/keys/@<REPLACE>_np_key.atKeys \
  -d <DEVICE_NAME> \
  -n "sshnp:rw,sshrvd:rw"

Once you see this text, you're ready to continue to the next step.

Submitting enrollment request 
Enrollment ID: ---------------------
Waiting for approval; will check every 10 seconds

Step 11 to Step 14

With both machines now configured, the final steps bring us back to the machine initiating the connection.

On the machine you are connecting from

Step 11: Approve the atSign authorization request

  1. Click on Requests and approve the pending request. The request will then move to the approved enrollments list.

  2. After a few seconds, the request will also show as approved on the machine you are connecting to.

Step 12: Switch back to your client atSign (@example01_np)

  1. Click on your atSign in the top right corner of the screen. This will open a list of atSigns that are currently signed into the app.

  2. Select your client atSign in order to switch to it.

Step 13: Create a Connection Profile

  1. If you aren't already on the Connections tab, click on Connections at the top of the Screen. Then click Add New, to create a new profile.

  2. Enter the following information into the profile then click Submit.

    1. Profile Name - The name that will be displayed in the profile list.

    2. Device atSign - Your device atSign (eg example02_np).

    3. Device Name - The name of your remote device.

    4. Relay - Select the relay sever closest to you for optimum speed.

    5. Local Port - The port you will use on your local machine.

    6. Local Host - The hostname or IP address to bind to on your local machine.

    7. Remote Host - The hostname or IP address of the machine you are connecting to.

    8. Remote Port - The port that will be used on the remote machine.

For reference, we've documented our most common use cases, including MCP, SSH, RDP, SFTP, Web Server, and SMB.

Step 14: Establish a connection

Click the Connect Icon ▶️ to establish a connection with your remote device. If the connection is successful, you will see green. If you see red, hover over the icon to see reason for failure.

Last updated