Mirroristas/owncast
2
0
Fork 0
mirror of https://github.com/owncast/owncast.git synced 2024-10-10 19:16:02 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add some info and directions to storage screen

Browse Source
This commit is contained in:
Gabe Kangas 2021-02-01 15:20:26 -08:00
parent d557788434
commit 66f15ceaff
3 changed files with 17 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
web/pages/components/config/constants.tsx
View File

@ -211,22 +211,22 @@ export const S3_TEXT_FIELDS_INFO = {
fieldName: 'acl', fieldName: 'acl',
label: 'ACL', label: 'ACL',
maxLength: 255, maxLength: 255,
placeholder: 'acl thing', placeholder: '',
tip: '', tip: 'Optional specific access control value to add to your content. Generally not required.',
}, },
bucket: { bucket: {
fieldName: 'bucket', fieldName: 'bucket',
label: 'Bucket', label: 'Bucket',
maxLength: 255, maxLength: 255,
placeholder: 'bucket 123', placeholder: 'bucket 123',
tip: '', tip: 'Create a new bucket for each Owncast instance you may be running.',
}, },
endpoint: { endpoint: {
fieldName: 'endpoint', fieldName: 'endpoint',
label: 'Endpoint', label: 'Endpoint',
maxLength: 255, maxLength: 255,
placeholder: 'endpoint 123', placeholder: 'https://your.s3.provider.endpoint.com',
tip: 'This field has a some info', tip: 'The full URL endpoint your storage provider gave you.',
}, },
region: { region: {
fieldName: 'region', fieldName: 'region',
@ -239,14 +239,14 @@ export const S3_TEXT_FIELDS_INFO = {
fieldName: 'secret', fieldName: 'secret',
label: 'Secret key', label: 'Secret key',
maxLength: 255, maxLength: 255,
placeholder: 'secret key 123', placeholder: 'your secret key',
tip: '', tip: '',
}, },
servingEndpoint: { servingEndpoint: {
fieldName: 'servingEndpoint', fieldName: 'servingEndpoint',
label: 'Serving Endpoint', label: 'Serving Endpoint',
maxLength: 255, maxLength: 255,
placeholder: 'servingEndpoint 123', placeholder: 'http://cdn.ss3.provider.endpoint.com',
tip: '', tip: 'Optional URL that content should be accessed from instead of the default. Used with CDNs and specific storage providers. Generally not required.'
}, },
}; };

5
web/pages/components/config/edit-storage.tsx
View File

@ -18,6 +18,7 @@ import {
} from '../../../utils/input-statuses'; } from '../../../utils/input-statuses';
import TextField from './form-textfield'; import TextField from './form-textfield';
import FormStatusIndicator from './form-status-indicator'; import FormStatusIndicator from './form-status-indicator';
import {isValidUrl} from '../../../utils/urls';
const { Panel } = Collapse; const { Panel } = Collapse;
@ -27,7 +28,7 @@ function checkSaveable(formValues: any, currentValues: any) {
const { endpoint, accessKey, secret, bucket, region, enabled, servingEndpoint, acl } = formValues; const { endpoint, accessKey, secret, bucket, region, enabled, servingEndpoint, acl } = formValues;
// if fields are filled out and different from what's in store, then return true // if fields are filled out and different from what's in store, then return true
if (enabled) { if (enabled) {
if (!!endpoint && !!accessKey && !!secret && !!bucket && !!region) { if (!!endpoint && isValidUrl(endpoint) && !!accessKey && !!secret && !!bucket && !!region) {
if ( if (
endpoint !== currentValues.endpoint || endpoint !== currentValues.endpoint ||
accessKey !== currentValues.accessKey || accessKey !== currentValues.accessKey ||
@ -188,7 +189,7 @@ export default function EditStorage() {
</div> </div>
<Collapse className="advanced-section"> <Collapse className="advanced-section">
<Panel header="Advanced Settings" key="1"> <Panel header="Optional Settings" key="1">
<div className="field-container"> <div className="field-container">
<TextField <TextField
{...S3_TEXT_FIELDS_INFO.acl} {...S3_TEXT_FIELDS_INFO.acl}

6
web/pages/config-storage.tsx
View File

@ -8,6 +8,12 @@ export default function ConfigStorageInfo() {
return ( return (
<> <>
<Title level={2}>Storage</Title> <Title level={2}>Storage</Title>
<p>
Owncast supports optionally using external storage providers to distribute your video. Learn more about this by visiting our <a href="https://owncast.online/docs/storage/">Storage Documentation</a>.
</p>
<p>
Configuring this incorrectly will likely cause your video to be unplayable. Double check the documentation for your storage provider on how to configure the bucket you created for Owncast.
</p>
<EditStorage /> <EditStorage />
</> </>
); );