Skip to main content

Quick Start

This guide will help you get started with Portola Network.

1️⃣ Download and Install​

Download Portola App from https://portola.app.

MacOS​

  1. Download the .dmg file from https://portola.app.
  2. Open the .dmg and drag Portola App into your Applications folder.
  3. Launch the app from Applications.

Debian-based systems (Ubuntu, etc.)​

sudo dpkg -i Portola_<version>_<arch>.deb

RedHat-based systems (Fedora, CentOS, etc.)​

sudo rpm -i Portola-<version>.<arch>.rpm

2️⃣ Authenticate & Provision an Endpoint​

To use Portola App, you need to authenticate it with your account on Portola Network.

MacOS​

Ensure that Portola App is running. Open the menu bar app and select Sign In / Sign Up. This will open a browser window to authenticate Portola App to access Portola Network on your behalf. You can authenticate using password-less Email, Google, or GitHub.

Linux​

The linux app is designed to run as a systemd service. After installing the app:

  1. Get auth client credentials from the Portola App Console. Go to Console → Auth Clients.
  2. Click on Create Auth Client, fill out Endpoint ID, and hit Create.
    • Option 1. Get the Endpoint ID from the Portola App running on your linux machine. TODO.
    • Option 2. You can skip Endpoint ID to generate a wildcard client that can be used on any endpoint.
  3. Copy the Client Tenant ID, Client ID and Client Secret. These will be only displayed once.
  4. Add these credentials to the Portola App configuration file on your linux machine at /etc/portola.env:
   CLIENT_TENANT_ID=<client_tenant_id>
   CLIENT_ID=<client_id>
   CLIENT_SECRET=<client_secret>
  1. Restart the Portola App service: 
    sudo systemctl restart portola

To run Portola App as a specific user, you can update a systemd service file at /lib/systemd/system/portola.service with 'User' directive. For example, to run it as the user portola, update the service file as follows:

    [Service]
    User=portola

Then restart the service:

    sudo systemctl daemon-reload
    sudo systemctl restart portola

Note that auth client credentials only have permissions for a managed device. They cannot be used to access the Portola App Console or any other resources.

You can now see all the registered endpoints on your account in the Portola App Console at Console → Endpoints.

Congratulations 🎉, you have successfully set up Portola App.