Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 23 additions & 0 deletions docs/docs/v1/001-intro.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
sidebar_position: 1
slug: /v1
title: Signals v1
description: ""
displayed_sidebar: v1Sidebar
---

# sudoSignals

sudoSignals is an application monitor and remote operation service.

With Signals, a local client application communicates with an applications locally, and then acts as a bridge to a remote, web Dashboard. It's important to understand the mechanics of how Signals operates in order to best take advantage of this tool, and have a seamless remote operation experience.

## What is this resource?

This resource is the single source documentation guide for working with the sudoSignals local application, with the web Dashboard, with any [SudoMagic](https://www.sudomagic.com/) created plugins, and with the Signals API (helpful if you're going to create your own plugin).

## Where to go next:
[Getting Started](./v1/getting-started) - create an account, install sudoSignals, and configuration
[Working with Plugins](./v1/plugins) - working with plugins to remotely control your installation
[Troubleshooting](./v1/troubleshooting) - common issues, and their resolution
[API Documentation](./v1/api) - build your own sudoSignals plugin
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Service API
slug: /api/service-api
slug: /v1/api/service-api
description: "Service API reference"
---

Expand Down
4 changes: 1 addition & 3 deletions docs/docs/api/api.mdx → docs/docs/v1/api/api.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: API
sidebar_position: 5
slug: /api
slug: /v1/api
description: "Plugin API reference docs"
---

Expand All @@ -17,5 +17,3 @@ sudoSignals has an open websocket API for controlling and reporting on process b

---
<DocCardList />

<!-- links -->
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create an Account
slug: /getting-started/create-an-account
slug: /v1/getting-started/create-an-account
description: "An overview of creating your sudoSignals Account"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Install Signals
slug: /getting-started/installing-sudoSignals
slug: /v1/getting-started/installing-sudoSignals
description: "A step-by-step guide through installing sudoSignals"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Create an Installation
slug: /getting-started/create-an-installation
slug: /v1/getting-started/create-an-installation
description: "A step-by-step guide through creating your first installation"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: Remote Control
slug: /getting-started/remote-control
slug: /v1/getting-started/remote-control
description: "Remotely controlling your installations with sudoSignals"
---

# Controlling a Remote Installation

In addition to process monitoring, sudoSignals can also be used to remotely control your application. Remote operation requires that an application use a plugin to communicate directly with the Signals client, which will act as a bridge to the Dashboard.

SudoMagic has a starting set of open source plugins available for projects, with plans to continue development for additional platforms. You can see a list of all [officially supported plugins here](/plugins).
SudoMagic has a starting set of open source plugins available for projects, with plans to continue development for additional platforms. You can see a list of all [officially supported plugins here](/v1/plugins).

If you'd like to build your own plugin please review the documentation for the sudoSignals [service API](/api).
If you'd like to build your own plugin please review the documentation for the sudoSignals [service API](/v1/api).
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Configure a Process
slug: /getting-started/configure-an-installation/configure-a-process
slug: /v1/getting-started/configure-an-installation/configure-a-process
description: "Configuring a process"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Configure an Installation
sidebar_position: 5
slug: /getting-started/configure-an-installation
slug: /v1/getting-started/configure-an-installation
description: "Configuring your installation"
---

Expand Down Expand Up @@ -64,7 +64,7 @@ If you only need to know if your installation machine is online, you can click t
![Configure 006](/img/configure-installation/configure-006.png)

## Configure a Process
See the complete walkthrough on how to [Configure a Process](/getting-started/configure-an-installation/configure-a-process).
See the complete walkthrough on how to [Configure a Process](/v1/getting-started/configure-an-installation/configure-a-process).

## Configure Additional Processes (optional)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Getting Started
sidebar_position: 2
slug: /getting-started
slug: /v1/getting-started
description: "Getting started"
---

Expand All @@ -15,5 +15,3 @@ sudoSignals is an application monitor that's connected to a web dashboard.

---
<DocCardList />

<!-- links -->
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Dashboard
slug: /getting-started/view-installations/dashboard
slug: /v1/getting-started/view-installations/dashboard
description: "An overview of the features on the Dashboard"
---

Expand Down Expand Up @@ -29,7 +29,7 @@ Each process is represented as a small rectangular tile below the Start and Stop

## Controls

Controls can be accessed by using one of the [SudoMagic developed plugins](https://docs.sudosignals.com/002_plugins/), or by building your own controls by following the sudoSignals [client API](https://docs.sudosignals.com/004_api/). Depending on the environment, the [SudoMagic](https://www.sudomagic.com/) plugins are intended to be drag and drop solutions for fast integration with the sudoSignals dashboard. The TouchDesigner plugin, for example, lets you quickly mirror your controls from your TouchDesigner project in a web friendly format. Control schemas are pre-defined, and allow for your development team to focus on building compelling experiences rather than creating overly complex dashboard controls.
Controls can be accessed by using one of the [SudoMagic developed plugins](https://docs.sudosignals.com/002_plugins/), or by building your own controls by following the sudoSignals [client API](/v1/api). Depending on the environment, the [SudoMagic](https://www.sudomagic.com/) plugins are intended to be drag and drop solutions for fast integration with the sudoSignals dashboard. The TouchDesigner plugin, for example, lets you quickly mirror your controls from your TouchDesigner project in a web friendly format. Control schemas are pre-defined, and allow for your development team to focus on building compelling experiences rather than creating overly complex dashboard controls.

## Graphs and Reports

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: System Info
slug: /getting-started/view-installations/sys-info
slug: /v1/getting-started/view-installations/sys-info
description: "An overview of the features on the system info view on the Dashboard"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Logs
slug: /getting-started/view-installations/logs
slug: /v1/getting-started/view-installations/logs
description: "An overview of the Logs on the Dashboard"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Alerts
slug: /getting-started/view-installations/alerts
slug: /v1/getting-started/view-installations/alerts
description: "An overview of Alerts on the Dashboard."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Installation Settings
slug: /getting-started/view-installations/installation-settings
slug: /v1/getting-started/view-installations/installation-settings
description: "Installation settings configureation."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: View Installations
sidebar_position: 6
slug: /getting-started/view-installations
slug: /v1/getting-started/view-installations
---

import DocCardList from '@theme/DocCardList';
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
---
title: Remote Control
slug: /plugins/TouchDesigner/remote-control
slug: /v1/plugins/TouchDesigner/remote-control
description: "Setting up remote operation of your TouchDesigner network with the sudoSignals plugin"
---

# Remote Control | SudoMagic Plugin

Remotely controlling your TouchDesigner installation with the SudoMagic plugin is easy. There are a few key steps that will make sure you're set up for a successful integration:
1. Ensure you've downloaded and installed the [sudoSignals Client]
2. Configure your installation to start your project - [see the how to guide](https://docs.sudosignals.com/docs/gettingStarted/configureInstallation/configureProcess/)
2. Configure your installation to start your project - [see the how to guide](/v1/getting-started/configure-an-installation/configure-a-process/)
3. Download the [TouchDesigner sudoSignals Plugin]

## Download the Plugin
Expand All @@ -18,7 +18,7 @@ The Signals plugin can be downloaded from the [github page](https://github.com/S
## Setup sudoSignals to launch your process

Configure sudoSignals to open your project file. If you don't have a project handy, you can set sudoSignals open blank TouchDesigner project.
If you need a quick reminder about how to configure sudoSignals to open a process, review steps 6 and 7 on the [Configure Installation](https://docs.sudosignals.com/docs/gettingStarted/configureInstallation) page.
If you need a quick reminder about how to configure sudoSignals to open a process, review steps 6 and 7 on the [Configure Installation](/v1/getting-started/configure-an-installation/) page.

## Launch your TouchDesigner Process with sudoSignals

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Manual Configuration
slug: /plugins/TouchDesigner/manual-config
slug: /v1/plugins/TouchDesigner/manual-config
description: "Manually configuring the TouchDesigner plugin"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: TouchDesigner
slug: /plugins/TouchDesigner
slug: /v1/plugins/TouchDesigner
description: "An overview of the currently available sudoSignals plugins"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Getting Started
slug: /plugins/NodeJS/getting-started
slug: /v1/plugins/NodeJS/getting-started
description: "An overview of NodeJS for sudoSignals"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Logging, Reporting, and Controls
slug: /plugins/NodeJS/Node-remote-conrol
slug: /v1/plugins/NodeJS/Node-remote-conrol
description: "To unlock more advanced features of sudoSignals in a NodeJS app we have to add a few more elements. "
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: NodeJS
slug: /plugins/NodeJS
slug: /v1/plugins/NodeJS
description: "An overview of NodeJS for sudoSignals"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Plugins
sidebar_position: 3
slug: /plugins
slug: /v1/plugins
description: "An overview of the currently available sudoSignals plugins"
---

Expand All @@ -18,4 +18,3 @@ If you're interested in contributing a plugin for official support [please conta
---
<DocCardList />

<!-- links -->
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Glossary
slug: /troubleshooting/glossary
slug: /v1/troubleshooting/glossary
description: "A collection of the terminology that's used when describing sudoSignals."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sudoSignals Features
slug: /troubleshooting/account-features
slug: /v1/troubleshooting/account-features
description: "sudoSignals works with both installation licenses and a dashboard subscription."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: sudoSignals Config File
slug: /troubleshooting/config-file
slug: /v1/troubleshooting/config-file
description: "Working with a YAML file for configuration."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Installation Location
slug: /troubleshooting/installation-location
slug: /v1/troubleshooting/installation-location
description: "Where sudoSignals is typically installed on a computer."
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Config Files & Client Logs
slug: /troubleshooting/config-and-logs
slug: /v1/troubleshooting/config-and-logs
description: "Where are my user config files located on my computer?"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title: Known Issues
slug: /troubleshooting/known-issues
slug: /v1/troubleshooting/known-issues
description: "Known issues for sudoSignals"
---

Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: Troubleshooting
sidebar_position: 4
slug: /troubleshooting
slug: /v1/troubleshooting
description: "Where to get started when things go wrong"
---

Expand Down
15 changes: 8 additions & 7 deletions docs/docs/001-intro.md → docs/docs/v2/001-intro.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
---
sidebar_position: 1
slug: /
title: Home
slug: /v2
title: Signals v2
description: "Just the Docs is a responsive Jekyll theme with built-in search that is easily customizable and hosted on GitHub Pages."
displayed_sidebar: v2Sidebar
---

# sudoSignals
# sudoSignals v2

sudoSignals is an application monitor and remote operation service.

Expand All @@ -16,7 +17,7 @@ With Signals, a local client application communicates with an applications local
This resource is the single source documentation guide for working with the sudoSignals local application, with the web Dashboard, with any [SudoMagic](https://www.sudomagic.com/) created plugins, and with the Signals API (helpful if you're going to create your own plugin).

## Where to go next:
[Getting Started](./getting-started) - Create an account, install Signals, and configuration
[Working with Plugins](./plugins)- Working with plugins to remotely control your installation
[Troubleshooting](./troubleshooting) - common issues, and their resolution
[API Documentation](./api) - build your own sudoSignals plugin
[Getting Started](./v2/getting-started) - create an account, install sudoSignals, and configuration
[Working with Plugins](./v2/plugins) - working with plugins to remotely control your installation
[Troubleshooting](./v2/troubleshooting) - common issues, and their resolution
[API Documentation](./v2/api) - build your own sudoSignals plugin
Loading