AccessKitGlobal Config
Reference for global/app-wide configuration settings for AccessKit.
What is a Global Config?
Global Config contains settings that affect the entire AccessKit application, including style customization of the public-facing guest web application and adding site analytics.
Want help with custom styles?
If you need help with customizing the look and feel of the AccessKit
application, please contact the AccessKit team
with subject Custom Styles and we'll be happy to help or set up a custom
stylesheet for you!
Finding Global Config
Global Config can be found in the Admin Dashboard by clicking the Gear icon in the top-right corner of the page.
Global Config will always have one relevant permalink:
| Name | URL Rule | Description |
|---|---|---|
| Admin Dashboard Edit Page | https://<your-subdomain>.accesskit.cc/admin/config | The permalink for the Global Config's edit page on the admin dashboard. |
Form fields
The following fields are available when editing a Global Config.
| Field | Type | Optional | Editable | Description |
|---|---|---|---|---|
| Organization Name | string | No | Yes | The name of the organization. This will appear at the bottom of the page in the public-facing guest web application. |
| Home Back Link URL | string [url] | Yes | Yes | The URL of the home back button link, which will override the behavior of the Back button in the public-facing guest web application. Rather than navigating back to the AccessKit guest-facing web app application, the button will instead take the users to this link, e.g. pointing to your institution's primary mobile guide. |
| Home Back Link Text | string | Yes | Yes | The text to display next to the home back link, e.g. Mobile Guide. |
| Title | string | Yes | Yes | The title of the AccessKit application. This will appear in the title tag of the public-facing guest web application home page, e.g. Captions and Audio. |
| Instructions | string | Yes | Yes | The instructions to display on the public-facing guest web application home page, e.g. Select an exhibition below to access synchronzied captions and audio. |
| Geofencing/Spatial Restriction | enum [none, geofencing, netmasking] | Yes | Yes | The geofencing/spatial restriction to apply to the AccessKit application. When enabled, the site is blocked outside of either a specific geographic area or outside of a specified IP network address. |
| Google Analytics Tracking ID | string | Yes | Yes | The Google Analytics tracking ID to use for the AccessKit application. This will be used to track user interactions with the application like number of visitors, time spent on the site, and more. |
| Guest Stylesheet URL | string [url] | Yes | Yes | The URL of the guest stylesheet to use for the AccessKit application. This will be used to style the public-facing guest web application with custom overrides. |
| Favicon URL | string [url] | Yes | Yes | The URL of the favicon to use for the AccessKit application. This will be used to style the public-facing guest web application with a custom favicon. |
| Left Arrow SVG URL | string [url] | Yes | Yes | The URL of the left arrow SVG to use for the AccessKit application. This will be used to style the public-facing guest web application with a custom left arrow, used in Back buttons. |
| Custom Down Arrow SVG URL | string [url] | Yes | Yes | The URL of the custom down arrow SVG to use for the AccessKit application. This will be used to style the public-facing guest web application with a custom down arrow. |
| Custom Audio On SVG URL | string [url] | Yes | Yes | The URL of the custom audio on SVG to use for the AccessKit application. This will be used to style the public-facing guest web application with a custom audio on icon, used in the audio player. |
| Custom Audio Off SVG URL | string [url] | Yes | Yes | The URL of the custom audio off SVG to use for the AccessKit application. This will be used to style the public-facing guest web application with a custom audio off icon, used in the audio player. |
| Custom Audio Description SVG URL | string [url] | Yes | Yes | The URL of the custom audio description SVG to use for the AccessKit application. This will be used to style the public-facing guest web application with a custom Audio Description icon, used in the audio player when a Work's audio type is set to Audio Description. |
| Custom Closed Captions SVG URL | string [url] | Yes | Yes | The URL of the custom closed captions SVG to use for the AccessKit application. This will be used to style the public-facing guest web application with a custom Closed Captions icon. |
| Custom Loader SVG URL | string [url] | Yes | Yes | The URL of the custom loader SVG to use for the AccessKit application. This will be used to style the public-facing guest web application with a custom loader. |
Remember to click Update Config to commit your changes.