Hello, how can we help you?

We have answers for all your questions. Let’s verify all the information to find out where your shipment is.

Search

background background

Applications

Single Sign-On (SSO) with SAML in ReadyView

ReadyView supports single sign-on (SSO) with any SAML 2.0 identity provider, such as Microsoft Entra ID, Okta or Google Workspace. With SSO set up, your team signs in to ReadyView with their company account.

Things to note:

Setting up SSO requires a role with the Manage SAML Configuration permission. See Roles and Permissions in ReadyView.

Step 1 – Add ReadyView to your identity provider:

In ReadyView, navigate to Administration -> Organization -> Settings. The SAML Configuration panel lists the values your identity provider needs, each with a Copy button. Create a SAML application for ReadyView in your identity provider with these values.

Identity provider field Value
Identifier (Entity ID) Your organization ID, shown as Identifier in ReadyView
Reply URL (ACS URL) https://readyview-5ff37.firebaseapp.com/__/auth/handler
Sign-on URL Your organization's sign-in link, shown as Sign-on URL in ReadyView. It starts with https://ui.readylinks.io/login?sso=
Name ID The user's email address (in Microsoft Entra ID: user.mail)
Roles (optional) ReadyView role names in an attribute named role. Microsoft Entra ID sends app roles this way. See Roles and SSO below.

Step 2 – Set up single sign-on in ReadyView:

  1. In Administration -> Organization -> Settings, under SAML Configuration, press + Enable SAML
  2. Paste your identity provider's metadata URL and press Import. ReadyView fills in the entity ID, SSO URL and signing certificate. In Microsoft Entra ID, this is the App Federation Metadata Url
  3. Check the details and press Save

No metadata URL? Press Upload metadata file, or enter the details yourself:

ReadyView field Value from your identity provider Name in Microsoft Entra ID
Entity ID Your identity provider's entity ID, also called the issuer (not your organization ID) Microsoft Entra Identifier
SSO URL The sign-in URL Login URL
Certificate The signing certificate. Paste it or upload the file, in any format Certificate (Base64) or Certificate (Raw)

To change the details later, for example when your identity provider rotates its signing certificate, edit the fields and press Apply Changes. To stop using SSO, press Turn off single sign-on.

Step 3 – Sign in with SSO:

Share your sign-in link, the Sign-on URL from Step 1, with your team. The ReadyView application in your identity provider opens the same link.

Limit the Everyone role first. Everyone who joins through SSO gets the Everyone role, which starts with every permission. Before you share the sign-in link, limit it under Administration -> Organization -> Roles. Until you do, ReadyView shows a warning with a Review roles link under SAML Configuration and in the setup dialog. See Roles and Permissions in ReadyView.

  1. Open the sign-in link and press Continue with single sign-on
  2. Sign in with your identity provider in the pop-up window

The first time someone signs in with SSO, ReadyView adds them to your organization. If their email address already has a ReadyView password, ReadyView asks for it once to connect SSO to their account.

After the first sign-in, members can also sign in at https://ui.readylinks.io: they enter their email address and press Sign In, and ReadyView sends them to the identity provider.

Roles and SSO:

SSO handles sign-in. ReadyView roles decide what each member can do. New members get the Everyone role.

  • Everyone starts with every permission. Limit it before you share the sign-in link, for example with the View Only template, and grant more through other roles
  • Your identity provider can assign roles. Each time someone signs in, ReadyView applies the roles named in their role attribute and removes roles it no longer sends. Only roles that exist in your organization are applied, and roles assigned in ReadyView are never changed
  • To assign roles in ReadyView, use Administration -> Organization -> Roles -> Assign Members, or invite people with their roles under Administration -> Organization -> Team before they first sign in
  • Removing someone from your identity provider does not remove them from ReadyView. Remove members under Administration -> Organization -> Team. They can't rejoin through SSO until they're invited again

Troubleshooting:

  • The metadata can't be imported: check the metadata URL, or upload the metadata file instead
  • The details can't be saved: the Entity ID and SSO URL come from your identity provider, and the certificate is its signing certificate
  • "Failed SSO sign in": check that the details match your identity provider, and that the user has access to the ReadyView application
  • "SSO isn't set up for this organization": check that the sign-in link is your organization's, and that single sign-on is set up
  • The sign-in window doesn't open: allow pop-ups for ui.readylinks.io
  • "You were removed from this organization": invite the person again under Administration -> Organization -> Team
  • "Your identity provider didn't send an email address": send the user's email address as the Name ID

What is ReadyView?

ReadyView is a powerful network management tool provided by ReadyLinks, designed to offer a comprehensive and user-friendly interface for monitoring, configuring, and managing your network infrastructure. Whether you are an IT professional managing a large-scale network or a small business owner ensuring smooth operations, ReadyView provides the tools you need to maintain a robust and efficient network.

 

Key Features:

  1. Dashboard Overview:
    • Real-Time Monitoring: Access a real-time overview of your network's status, including device health, connectivity, and performance metrics.
    • Customizable Views: Tailor the dashboard to display the most relevant information for your network management needs.
  2. Device Management:
    • Add/Remove Devices: Easily add new ReadyLinks devices to your network or remove existing ones.
    • Configuration Management: Retrieve and update device configurations, including network settings, VLANs, QoS policies, and security protocols.
    • Firmware Updates: Check for and apply the latest firmware updates to ensure devices are running the most current and secure software versions.
  3. Network Configuration:
    • Templates: Create and apply configuration templates to multiple devices simultaneously, ensuring consistent settings across your network.
    • Policy Enforcement: Implement and enforce network policies to maintain security and performance standards.
    • Map View: Visualize device locations on a network map to optimize placement and troubleshoot connectivity issues.
  4. Alerts and Notifications:
    • Custom Alerts: Set up alerts for various network events, such as device disconnections or performance issues.
    • Notifications: Receive notifications via email or SMS to stay informed about critical network events.
  5. Reporting and Analytics:
    • Detailed Reports: Generate comprehensive reports on network usage, performance, and security.
    • Historical Data Analysis: Analyze historical data to identify trends and make informed decisions to optimize network performance.
  6. User Management:
    • Role-Based Access: Manage user roles and permissions to ensure secure access to network management features.
    • Authentication Integration: Integrate with existing authentication systems for streamlined and secure user access.

Benefits:

  • Improved Network Visibility:
    • Gain deep insights into your network's performance and health, enabling proactive management and troubleshooting.
  • Simplified Device Management:
    • Centralize the management of all ReadyLinks devices, reducing the complexity of network administration.
  • Enhanced Security:
    • Implement robust security measures and monitor network activities to protect against threats.
  • Scalability:
    • Easily scale your network management capabilities as your organization grows, with support for a large number of devices.

Use Cases:

  • Enterprise Networks:
    • Manage large-scale enterprise networks with ease, ensuring optimal performance and security across numerous devices.
  • Service Providers:
    • Provide efficient network management services to clients, maintaining high standards of reliability and performance.
  • Small to Medium Businesses:
    • Streamline network management processes, enabling small and medium businesses to focus on their core operations.

Getting Started:

To get started with ReadyView, visit the ReadyView Documentation for detailed information on setup, configuration, and usage. The documentation provides comprehensive guides and reference materials to help you leverage ReadyView for effective network management.

Support:

For additional assistance, visit our Support section or contact our Support Team for personalized help and guidance on using ReadyView.

ReadyView is your go-to solution for efficient and effective network management, providing the tools and insights you need to maintain a high-performing and secure network environment.

Create a network

Networks are used to geolocate and contain your devices and their configurations. You may create networks prior to receiving ReadyLinks devices.

  1. Log in to ReadyView .

  2. Navigate to the Networks tab in ReadyView and press the + button

  3. Enter the address of the network 

  4. Confirm address and other network details

  5. Press Create Network 

 

 

By default the name of the network is the address selected when the network was created. To change the name.

  1. In the ReadyView dashboard select the network to rename 

  2. Go to settings -> General

  3. Add a new name, description, and contact to the network 

  4. Press save changes  

 

 

 

Roles and Permissions in ReadyView

With ReadyView, you can add role-based access to limit what ReadyView users have access to. This can vary from who can view which networks in an organization to who can reboot a switch. This article walks you through creating and assigning roles and permissions within ReadyView.

Things to note:

By default, all users are placed into the Everyone role. Like any other role, you can change what it has access to — by default, every permission is enabled.

Limit the Everyone role first. Everyone starts with every permission, so every member can do everything until you change it. Before you invite people or turn on single sign-on, edit Everyone to keep only what every member should be able to do, for example with the View Only template, and grant more through other roles.

Users can be added to multiple roles. If a user belongs to two roles where one has a permission disabled and another has it enabled, the user will ultimately have access — the most permissive setting wins.

Roles are ranked from the top down. A member can edit, delete, and assign only the roles at or below the highest role they hold. Drag a rank number, or use the arrows, to change a role's rank.

Only permissions you hold yourself can be granted to, or removed from, a role.

Creating Roles:

  1. Navigate to: Administration -> Organization -> Roles
  2. Press Create Role
  3. Enter a name for the role you wish to create
  4. Optionally pick a template to start from: Admin, Network Admin, Technician or View Only
  5. Adjust the permissions: tick individual permissions, use a section's checkbox to grant or clear the whole section, or search for a permission by name
  6. Once completed press Save

To change a role later, including Everyone, press Edit next to it.

Assigning Roles to Users:

  1. Navigate to: Administration -> Organization -> Roles
  2. On the role you would like to add users to, press Assign Members
  3. Then press the + button
  4. Select users and then press Save
  5. Next press the Close button

You can also give people roles when you invite them under Administration -> Organization -> Team. They get those roles when they join.

Limiting what Roles have access to what networks:

  1. Navigate to the network you wish to limit access to by role
  2. Go to Settings -> Admins & Users
  3. Turn on the Private toggle
  4. Press Add Roles
  5. Select the roles you want to have access to the network and press Save
  6. Press the Save button at the bottom

Add at least one role before you make a site private. With no permitted roles, nobody in your organization could open it.

Roles and single sign-on:

If your organization uses single sign-on, your identity provider can assign roles too. See Single Sign-On (SSO) with SAML in ReadyView.

  • People who join through single sign-on get the Everyone role. While Everyone allows anything, ReadyView shows a warning with a Review roles link under Administration -> Organization -> Settings -> SAML Configuration
  • Each time someone signs in, ReadyView applies the roles named in their role attribute and removes roles it no longer sends. Only roles that exist in your organization are applied
  • Roles you assign in ReadyView are never changed by single sign-on

Troubleshooting:

  • "Permission required": none of the member's roles includes that permission. Add it to one of their roles, or assign them a role that has it
  • You can't edit, delete or assign a role: the role ranks above your highest role
  • A permission can't be selected: you can grant or remove only the permissions you hold yourself
  • A member can't open a site: the site is private and none of the member's roles is permitted. Add one of their roles under Settings -> Admins & Users
  • A member can do more than expected: one of their roles allows it, often Everyone. If any of a member's roles allows something, they can do it

Manage VLANs in ReadyView

Creating VLANs through the ReadyView dashboard automatically syncs them across all devices on the network, eliminating the need to manually configure VLANs on individual switches. With our GL-EP series switches, you can even assign an RGB value to each VLAN ID for easy visual identification.

VLAN creation is done at the network level in ReadyView

 

Create a new VLAN:

  1. Navigate to the network you wish to make VLANs for 
  2. Go to Settings -> Networks 
  3. Press New Virtual Network 
  4. Fill out the VLAN name, VLAN, ID, and optionally the LED color
  5. Press Add Virtual Network

 

Edit existing VLANs:

  1. Navigate to the network that has the VLAN you want to edit
  2. Go to Settings -> Networks 
  3. Click on the VLAN you want to edit 
  4. Make desired changes and press Update 

 

Deleting VLANs:

  1. Navigate to the network that has the VLAN you want to delete 
  2. Go to Settings -> Networks 
  3. Click on the VLAN you want to delete 
  4. Press Remove

 

 

Claiming devices

Log in to ReadyView using the account created earlier. Navigate to the Add Device page and select the button to add a device or multiple devices. Provide the MAC address of your device/s. Enter a comma separated series of MAC addresses or scan the MAC QR code on your device.

 

Select Claim to claim the device.



Congratulations! You've successfully claimed your ReadyLinks device.

 

Troubleshoot: Once the device is powered on and connected, it could take a few minutes for the device to connect back to the ReadyLinks cloud. If you are still having trouble claiming your device. Ensure the device is on a network with proper firewall rules configured.

What is ReadyOn?

Whether you are a tech-savvy individual looking to provide better Internet services to your building, a nationwide service provider, or something in between, ReadyOn offers a seamless solution for recognizing revenue from your networks without the cost and complexity of developing your own buy-flow and customer management system.

ReadyOn provides a pre-built, fully customizable ordering flow, enabling you to onboard new subscribers with ease. As your business grows, you can leverage the built-in customer management system to offer the necessary support to your customers.

 

Key Features:

  1. Pre-Built Ordering Flow:

    • Customizable: Tailor the ordering process to match your brand and specific business needs.
    • User-Friendly: Simplify the subscription process for new customers, reducing barriers to entry and improving customer satisfaction.
  2. Customer Management System:

    • Integrated Support: Manage customer interactions and support requests within the same platform.
    • Detailed Records: Maintain comprehensive records of customer accounts, services, and billing information.
    • Scalable: Handle an increasing number of subscribers effortlessly as your business expands.
  3. Revenue Recognition:

    • Instantaneous: Start recognizing revenue from new subscribers immediately upon sign-up.
    • Accurate Tracking: Keep track of all financial transactions and revenue streams with precision.
  4. Data Access and Integration:

    • ReadyLinks API: Access all your data through the ReadyLinks API, enabling you to integrate ReadyOn with your existing systems or develop your own custom solutions.
    • Flexible Deployment: Run ReadyOn as a stand-alone onboarding and customer management system or in parallel with your current systems for added flexibility.

Benefits:

  • Cost-Effective:

    • Eliminate the need to develop a custom buy-flow and customer management system, saving both time and resources.
  • Efficiency:

    • Streamline the subscriber onboarding process, reducing manual effort and improving overall operational efficiency.
  • Scalability:

    • Grow your business effortlessly with a system designed to handle an increasing number of customers and services.
  • Customer Satisfaction:

    • Provide a smooth and user-friendly onboarding experience, leading to higher customer satisfaction and retention.
  • Data Control:

    • Maintain control over your data with the ability to access and integrate it through the ReadyLinks API.

Use Cases:

  • Internet Service Providers:
    • Implement ReadyOn to manage subscriber onboarding and customer support, ensuring a seamless experience for new and existing customers.
  • Property Managers:
    • Use ReadyOn to offer high-quality Internet services to residents, with an easy-to-manage system for handling subscriptions and support.
  • Small to Medium Enterprises:
    • Leverage ReadyOn to efficiently manage customer subscriptions and recognize revenue, allowing you to focus on growing your business.

Getting Started:

To get started with ReadyOn, visit the ReadyOn Documentation for detailed information on setup, customization, and integration. The documentation provides comprehensive guides and reference materials to help you maximize the benefits of ReadyOn for your business.

Support:

For additional assistance, visit our Support section or contact our Support Team for personalized help and guidance on using ReadyOn.

ReadyOn simplifies subscriber onboarding and customer management, enabling you to recognize revenue quickly and efficiently while providing excellent support to your customers.

Set up an account

You can sign up on the profile page within ReadyView. On the page there is a section you can click to sign up and create your service provide account. ReadyOn partners with Stripe to provide secure and reliable payment processing.

 

Here are the things you will need to register as a ReadyOn provider:

  • Company address
  • Business type (Individual or Company)
  • Business information (Name, EIN/SSN, Address)
  • Business owner information
  • Banking information to receive payments
  • Customer support information

ReadyOn enabled networks

Once you are a registered ReadyOn provider, you can start to create networks and enable them to sell your services!

 

As a ReadyOn provider, you can load serviceable addresses into your networks for your customers to select from at the time of order. Serviceable addresses are a core concept of ReadyOn enabled networks; they represent the addresses where you can provide your service. These are the same addresses that appear for your customers on your ReadyOn buyflow.

 

Add serviceable addresses

  1. Create a network
  2. Navigate to the ReadyOn section of the network page
  3. Select the address from the list
  4. Manage the address with options like: adding a service offering, enabling customer activation from your custom ReadyOn buy flow, adding suites, etc...

Customers

A Customer is a recipient of the services provided by your business. You can create recurring charges and track subscriptions that belong to the same customer.

 

Customer lookup

Quickly lookup your customer accounts to gather useful information and records.

  1. In your ReadyView dashboard, navigate to the ReadyOn dashboard page.
  2. Under the Customer section, click the search icon on the customer table.
  3. Enter your search query to filter your customers.

Subscriptions

A Subscription allows you to charge a customer on a recurring basis. A subscription can be assigned to a port of a device in ReadyView to track usage and simplify support.

 

Subscription lookup
  1. In your ReadyView dashboard, navigate to the ReadyOn dashboard page.
  2. Under the Subscription section, click the search icon on the subscription table.
  3. Enter your search query to filter your subscriptions.
Subscription management
  1. In your ReadyView dashboard, navigate to the ReadyOn dashboard page.
  2. Select the customer with the subscription you would like to manage to navigate to the customer details page.
  3. Under the Subscriptions section, click the Manage button.
  4. Pause/Resume or cancel individual subscription items in the subscription management window.
Subscription assignment

Assigning a subscription to a device in ReadyView allows you to track specific customer usage and simplify your support tasks.

  1. Find the device where you would like to assign your customer's subscription.
  2. Under the ports section, click on the port where you would like to assign the subscription.
  3. Select the port setting icon to bring up the assignment window.
  4. Under unassigned subscriptions, select the subscription you would like to assign to the port.
Subscription status
trialing The subscription is currently in a trial period. The subscription transitions automatically to active when the first payment is made.
active The subscription is in good standing and the most recent payment is successful.
incomplete A successful payment needs to be made within 23 hours to activate the subscription. Or the payment requires action, like customer authentication. Subscriptions can also be incomplete if there’s a pending payment. In that case, the invoice status would be open_payment_pending and the payment status would be processing.
incomplete_expired The initial payment on the subscription failed and no successful payment was made within 23 hours of creating the subscription. These subscriptions don’t bill customers. This status exists so you can track customers that failed to activate their subscriptions.
past_due Payment on the latest finalized invoice either failed or wasn’t attempted. The subscription continues to create invoices. Your subscription settings determine the subscription’s next state. If the invoice is still unpaid after all retries have been attempted, you can configure the subscription to move to canceled, unpaid, or leave it as past_due. To move the subscription to active, pay the most recent invoice before its due date.
canceled The subscription has been canceled. During cancellation, automatic collection for all unpaid invoices is disabled. This is a terminal state that can’t be updated.
unpaid The latest invoice hasn’t been paid but the subscription remains in place. The latest invoice remains open and invoices continue to be generated but payments aren’t attempted. Access to your product can be automatically revoked when the subscription is unpaid since payments were already attempted and retried when it was past_due. To move the subscription to active, pay the most recent invoice before its due date.

 

Payments

A Payment allows you to charge a credit or debit card. You can retrieve and refund individual payments as well as view all payments associated with a customer. Payments are identified by a unique, random ID. You are able to view all payments made by a customer under their customer details page in ReadyView.

 

Create a payment
  1. In your ReadyView dashboard, navigate to the customer details page of the customer you would like to charge.
  2. Under the payments section of the customer details page, select the create button.
  3. Enter the payment details.

ReadyLinks API

See all articles

What is ReadyLinks API?

The ReadyLinks API provides a comprehensive and flexible interface for integrating and automating the management of ReadyLinks network devices. This API enables developers and network administrators to programmatically access and control various functionalities offered by ReadyLinks, facilitating seamless integration with existing systems and workflows.

 

Key Features:

  1. Device Management:

    • Add/Remove Devices: Programmatically add new ReadyLinks devices to your network or remove existing ones.
    • Configuration: Retrieve and update device configurations, including network settings, VLANs, and QoS policies.
    • Firmware Updates: Check for and apply firmware updates to ensure devices are running the latest software versions.
  2. Monitoring and Reporting:

    • Real-Time Monitoring: Access real-time status and performance metrics for all devices within your network.
    • Logs and Events: Retrieve logs and event data for troubleshooting and analysis.
    • Analytics: Generate and export detailed reports on network performance, usage statistics, and security events.
  3. User Management:

    • Access Control: Manage user roles and permissions, ensuring secure access to network management features.
    • Authentication: Integrate with authentication systems to provide secure and streamlined user access.
  4. Network Configuration:

    • Templates: Create, update, and apply configuration templates to multiple devices.
    • Policy Enforcement: Implement and enforce network policies programmatically across all devices.
    • Custom Scripts: Execute custom scripts on devices for advanced configuration and automation tasks.

Benefits:

  • Automation:

    • Streamline routine network management tasks through automation, reducing manual effort and the risk of errors.
    • Schedule regular maintenance tasks such as firmware updates and configuration backups.
  • Integration:

    • Seamlessly integrate ReadyLinks network management capabilities with your existing IT infrastructure and systems.
    • Utilize the API to build custom applications and dashboards tailored to your organization’s specific needs.
  • Scalability:

    • Easily scale your network management capabilities as your network grows, with the ability to manage a large number of devices programmatically.
    • Ensure consistent configurations and policies across all devices, enhancing network stability and performance.
  • Flexibility:

    • Customize the API usage to fit your unique network requirements and workflows.
    • Leverage the API to develop innovative solutions that enhance your network management capabilities.

Use Cases:

  • Automated Deployment:

    • Automatically add and configure new devices as they are connected to the network, ensuring they are ready for use immediately.
  • Proactive Monitoring:

    • Set up automated monitoring and alerting systems to detect and respond to network issues in real-time.
  • Custom Management Tools:

    • Develop custom tools and interfaces that provide enhanced visibility and control over your network infrastructure.
  • Policy Enforcement:

    • Programmatically enforce network policies and configurations, ensuring compliance with organizational standards.

Getting Started:

To get started with the ReadyLinks API, visit the ReadyLinks API Documentation for detailed information on available endpoints, authentication methods, and usage examples. The documentation provides comprehensive guides and reference materials to help you integrate and utilize the API effectively.

Support:

For additional assistance, visit our Support section or contact our Support Team for personalized help and guidance on using the ReadyLinks API.

The ReadyLinks API is a powerful tool that empowers you to take full control of your network, enabling efficient, scalable, and automated network management.