LogoLogo
  • NoPorts Documentation
  • Getting Started
  • Installation
    • Quick Start from macOS or Windows
      • Quick Start to macOS
      • Quick Start to Linux
      • Quick Start to Windows
    • Connecting from macOS
      • macOS to macOS
      • macOS to Linux
      • macOS to Windows
    • Connecting from Linux
      • Linux to macOS
      • Linux to Linux
      • Linux to Windows
    • Connecting from Windows
      • Windows to macOS
      • Windows to Linux
      • Windows to Windows
    • Cloud Installation Guides
      • Automated Installation on Amazon Web Services (AWS)
      • Automated Installation on Google Cloud Platform (GCP)
      • Automated Installation on Microsoft Azure
      • Automated Installation on Oracle Cloud Infrastructure (OCI)
    • OpenWrt Installation Guide
    • Manual Installation Guides
      • Device Installation
        • Tmux session
        • Standalone Binaries
        • Systemd Unit
        • Headless
      • Client Installation
    • Custom OS/Device Installs
      • IPFire
    • Installs at Scale
    • Upgrading NoPorts Software
      • NoPorts Client Upgrade
      • NoPorts Daemon Upgrade
    • Available Releases
  • Use Cases
    • SSH
    • SFTP
    • RDP
    • Web Server
    • SMB
    • Be your own VPN
  • Usage
    • npt Usage
    • sshnp Usage
      • Client Additional Configuration
    • sshnpd configuration
      • Daemon Additional Configuration
  • Integrations
    • OpenSSH Config
    • PuTTY config
  • Resources
    • How to activate an atSign
    • Reuse your client atSign on another machine
      • Generate a new set of cryptographic keys
    • How to name a device
    • How to generate SSH keys
    • Why activate the device atSign on the client?
  • Product Information
    • The NoPorts Philosophy
    • NoPorts Desktop Application
    • NoPorts Policy Service
    • Frequently Asked Questions
    • How It Works
    • Under The Hood
    • Sequence Diagram
  • Related Pages
    • Main Site
    • GitHub
Powered by GitBook
On this page
  • Step 1 to Step 3
  • Step 4 and Step 5
  • Step 6 to Step 9
Edit on GitHub
Export as PDF
  1. Installation
  2. Quick Start from macOS or Windows

Quick Start to macOS

PreviousQuick Start from macOS or WindowsNextQuick Start to Linux

Last updated 4 days ago

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

Step 1 to Step 3

Complete these steps in the NoPorts desktop application on the machine you are connecting from

On the machine you are connecting from

Step 1: Activate your device atSign

Both the client and device atSigns are activated on the machine you are connecting from. Later, you’ll grant your remote machine access to the keys stored on this machine.

  1. You'll need to switch atSigns. To sign out from the client atSign, click the Settings icon in the top right corner of the screen, then select Sign Out.

  2. Click Get Started and enter your device atSign into the text field (e.g., @pluto83_client). Leave the root domain as is, and then click Next.

  3. A one-time password (OTP) will be sent to you via email. Enter this OTP into the app and then click Confirm.

Step 2: Save a copy of your device atKeys

Your atKeys (cryptographic keys) will be used to pair your atSign with this and other devices in future. You can .

  1. Click on Save atKeys

  2. Select a memorable location on your machine and save your keys. We recommend creating a folder in your home drive called ~/.atsign/keys and storing your keys there.

Step 3: Generate a device atSign authorization passcode

Click on the key icon in the top right corner and then click on OTP. You will use this 4 character code in Step 5.

Step 4 and Step 5

After setting up the machine you're connecting from, you'll configure the machine you're connecting to.

On the machine you are connecting to

Step 4: Download and run the Installer

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.

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

Step 5: Initiate atSign authorization request

Run the following command to make an authorization request:

Be sure to replace the following values:

@<REPLACE>_device with your device atSign,

<PASSCODE> with the passcode generated in Step 3,

@<REPLACE>_device_key with your device atSign,

<DEVICE_NAME> with a unique name for the machine you are on

~/.local/bin/at_activate enroll -a @<REPLACE>_device \
  -s <PASSCODE> \
  -p noports \
  -k ~/.atsign/keys/@<REPLACE>_device_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 6 to Step 9

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 6: 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 7: Switch back to your client atSign

  1. Click Back, and then click on the Settings icon in the top right corner of the screen, then select Sign Out.

  1. Click Get Started and select your client atSign from the drop down menu, and then click Next.

Step 8: Create a Connection Profile

  1. 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.

    3. Device Name - The name assigned to 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. Remote Host - The hostname or IP address of the machine you are connecting to.

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

Step 9: 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.

learn more about these keys here