Configuring signs

Signs within the signs section of the Awesign configuration (awesign.yaml) are essentially "preset" URLs that displays can be configured to show. There may be additional signs that exist on the front-end without explicitly adding them to the configuration.

Each sign must have a unique name and a path, and may optionally include a description.

A full list of all available signs, with their path that you should specify in this section of the configuration, is available in List of signs.

An example signs configuration may look like this:

signs:
  - name: sign1
    description: "A demo sign with a CSE status bar"
    path: slideshow-status/cse/demo
  - name: sign2
    path: slideshow/demo

• The name must be unique, as it is used to identify one sign in particular
• The description is optional, and is displayed in various locations in the UI to help identify the sign
• The path is a relative path to the front-end sign. It will be appended to "awesign.example.com/sign/" (Again, see List of signs)

Certain more advanced functionality requires configuring a dynamic sign in the configuration file instead of (or in addition to) configuring a simple sign like this, but this is sufficient for most use cases and recommended if you're new to Awesign configuration. If you are using more advanced dynamic signs, the path to a dynamic sign can be configured above as described in that section of List of signs.