mirror of https://github.com/owncast/owncast.git synced 2024-10-26 06:26:03 +03:00

History

gingervitis c61e7e9c14 - start a README to document config admin later - update constants - add instanceUrl field to public details; if empty, then turn off yp.enabled. - edit YP/Directory settings; hide if instanceUrl is empty - update toggleswitch logic		2021-01-24 13:05:43 -08:00
..
constants.tsx	- start a README to document config admin later	2021-01-24 13:05:43 -08:00
edit-directory.tsx	- start a README to document config admin later - update constants - add instanceUrl field to public details; if empty, then turn off yp.enabled. - edit YP/Directory settings; hide if instanceUrl is empty - update toggleswitch logic	2021-01-24 13:05:43 -08:00
edit-tags.tsx	- start a README to document config admin later	2021-01-24 13:05:43 -08:00
form-textfield.tsx	- start a README to document config admin later	2021-01-24 13:05:43 -08:00
form-toggleswitch.tsx	- start a README to document config admin later	2021-01-24 13:05:43 -08:00
README.md	- start a README to document config admin later	2021-01-24 13:05:43 -08:00

README.md

Config

TODO: explain how to use

and how the custom form-xxxx components work together.

Misc notes

instanceDetails needs to be filled out before yp.enabled can be turned on.

Config data structure (with default values)

{
  streamKey: '',
  instanceDetails: {
    tags: [],
    nsfw: false,
  },
  yp: {
    enabled: false,
    instance: '',
  },
  videoSettings: {
    videoQualityVariants: [
      {
        audioPassthrough: false,
        videoPassthrough: false,
        videoBitrate: 0,
        audioBitrate: 0,
        framerate: 0,
      },
    ],
  }
};