shared/extra-utils/server/config-command.ts

   1 import { merge } from 'lodash'
   2 import { DeepPartial, HttpStatusCode } from '@shared/core-utils'
   3 import { About, ServerConfig } from '@shared/models'
   4 import { CustomConfig } from '../../models/server/custom-config.model'
   5 import { AbstractCommand, OverrideCommandOptions } from '../shared'
   6
   7 export class ConfigCommand extends AbstractCommand {
   8
   9   static getCustomConfigResolutions (enabled: boolean) {
  10     return {
  11       '240p': enabled,
  12       '360p': enabled,
  13       '480p': enabled,
  14       '720p': enabled,
  15       '1080p': enabled,
  16       '1440p': enabled,
  17       '2160p': enabled
  18     }
  19   }
  20
  21   getConfig (options: OverrideCommandOptions = {}) {
  22     const path = '/api/v1/config'
  23
  24     return this.getRequestBody<ServerConfig>({
  25       ...options,
  26
  27       path,
  28       implicitToken: false,
  29       defaultExpectedStatus: HttpStatusCode.OK_200
  30     })
  31   }
  32
  33   getAbout (options: OverrideCommandOptions = {}) {
  34     const path = '/api/v1/config/about'
  35
  36     return this.getRequestBody<About>({
  37       ...options,
  38
  39       path,
  40       implicitToken: false,
  41       defaultExpectedStatus: HttpStatusCode.OK_200
  42     })
  43   }
  44
  45   getCustomConfig (options: OverrideCommandOptions = {}) {
  46     const path = '/api/v1/config/custom'
  47
  48     return this.getRequestBody<CustomConfig>({
  49       ...options,
  50
  51       path,
  52       implicitToken: true,
  53       defaultExpectedStatus: HttpStatusCode.OK_200
  54     })
  55   }
  56
  57   updateCustomConfig (options: OverrideCommandOptions & {
  58     newCustomConfig: CustomConfig
  59   }) {
  60     const path = '/api/v1/config/custom'
  61
  62     return this.putBodyRequest({
  63       ...options,
  64
  65       path,
  66       fields: options.newCustomConfig,
  67       implicitToken: true,
  68       defaultExpectedStatus: HttpStatusCode.OK_200
  69     })
  70   }
  71
  72   deleteCustomConfig (options: OverrideCommandOptions = {}) {
  73     const path = '/api/v1/config/custom'
  74
  75     return this.deleteRequest({
  76       ...options,
  77
  78       path,
  79       implicitToken: true,
  80       defaultExpectedStatus: HttpStatusCode.OK_200
  81     })
  82   }
  83
  84   updateCustomSubConfig (options: OverrideCommandOptions & {
  85     newConfig: DeepPartial<CustomConfig>
  86   }) {
  87     const newCustomConfig: CustomConfig = {
  88       instance: {
  89         name: 'PeerTube updated',
  90         shortDescription: 'my short description',
  91         description: 'my super description',
  92         terms: 'my super terms',
  93         codeOfConduct: 'my super coc',
  94
  95         creationReason: 'my super creation reason',
  96         moderationInformation: 'my super moderation information',
  97         administrator: 'Kuja',
  98         maintenanceLifetime: 'forever',
  99         businessModel: 'my super business model',
 100         hardwareInformation: '2vCore 3GB RAM',
 101
 102         languages: [ 'en', 'es' ],
 103         categories: [ 1, 2 ],
 104
 105         isNSFW: true,
 106         defaultNSFWPolicy: 'blur',
 107
 108         defaultClientRoute: '/videos/recently-added',
 109
 110         customizations: {
 111           javascript: 'alert("coucou")',
 112           css: 'body { background-color: red; }'
 113         }
 114       },
 115       theme: {
 116         default: 'default'
 117       },
 118       services: {
 119         twitter: {
 120           username: '@MySuperUsername',
 121           whitelisted: true
 122         }
 123       },
 124       cache: {
 125         previews: {
 126           size: 2
 127         },
 128         captions: {
 129           size: 3
 130         },
 131         torrents: {
 132           size: 4
 133         }
 134       },
 135       signup: {
 136         enabled: false,
 137         limit: 5,
 138         requiresEmailVerification: false,
 139         minimumAge: 16
 140       },
 141       admin: {
 142         email: 'superadmin1@example.com'
 143       },
 144       contactForm: {
 145         enabled: true
 146       },
 147       user: {
 148         videoQuota: 5242881,
 149         videoQuotaDaily: 318742
 150       },
 151       transcoding: {
 152         enabled: true,
 153         allowAdditionalExtensions: true,
 154         allowAudioFiles: true,
 155         threads: 1,
 156         concurrency: 3,
 157         profile: 'default',
 158         resolutions: {
 159           '0p': false,
 160           '240p': false,
 161           '360p': true,
 162           '480p': true,
 163           '720p': false,
 164           '1080p': false,
 165           '1440p': false,
 166           '2160p': false
 167         },
 168         webtorrent: {
 169           enabled: true
 170         },
 171         hls: {
 172           enabled: false
 173         }
 174       },
 175       live: {
 176         enabled: true,
 177         allowReplay: false,
 178         maxDuration: -1,
 179         maxInstanceLives: -1,
 180         maxUserLives: 50,
 181         transcoding: {
 182           enabled: true,
 183           threads: 4,
 184           profile: 'default',
 185           resolutions: {
 186             '240p': true,
 187             '360p': true,
 188             '480p': true,
 189             '720p': true,
 190             '1080p': true,
 191             '1440p': true,
 192             '2160p': true
 193           }
 194         }
 195       },
 196       import: {
 197         videos: {
 198           concurrency: 3,
 199           http: {
 200             enabled: false
 201           },
 202           torrent: {
 203             enabled: false
 204           }
 205         }
 206       },
 207       trending: {
 208         videos: {
 209           algorithms: {
 210             enabled: [ 'best', 'hot', 'most-viewed', 'most-liked' ],
 211             default: 'hot'
 212           }
 213         }
 214       },
 215       autoBlacklist: {
 216         videos: {
 217           ofUsers: {
 218             enabled: false
 219           }
 220         }
 221       },
 222       followers: {
 223         instance: {
 224           enabled: true,
 225           manualApproval: false
 226         }
 227       },
 228       followings: {
 229         instance: {
 230           autoFollowBack: {
 231             enabled: false
 232           },
 233           autoFollowIndex: {
 234             indexUrl: 'https://instances.joinpeertube.org/api/v1/instances/hosts',
 235             enabled: false
 236           }
 237         }
 238       },
 239       broadcastMessage: {
 240         enabled: true,
 241         level: 'warning',
 242         message: 'hello',
 243         dismissable: true
 244       },
 245       search: {
 246         remoteUri: {
 247           users: true,
 248           anonymous: true
 249         },
 250         searchIndex: {
 251           enabled: true,
 252           url: 'https://search.joinpeertube.org',
 253           disableLocalSearch: true,
 254           isDefaultSearch: true
 255         }
 256       }
 257     }
 258
 259     merge(newCustomConfig, options.newConfig)
 260
 261     return this.updateCustomConfig({ ...options, newCustomConfig })
 262   }
 263 }