1 import * as config from 'config'
2 import { promisify0 } from '../helpers/core-utils'
3 import { UserModel } from '../models/account/user'
4 import { ApplicationModel } from '../models/application/application'
5 import { OAuthClientModel } from '../models/oauth/oauth-client'
6 import { parse } from 'url'
7 import { CONFIG } from './constants'
8 import { logger } from '../helpers/logger'
9 import { getServerActor } from '../helpers/utils'
11 async function checkActivityPubUrls () {
12 const actor = await getServerActor()
14 const parsed = parse(actor.url)
15 if (CONFIG.WEBSERVER.HOST !== parsed.host) {
16 const NODE_ENV = config.util.getEnv('NODE_ENV')
17 const NODE_CONFIG_DIR = config.util.getEnv('NODE_CONFIG_DIR')
20 'It seems PeerTube was started (and created some data) with another domain name. ' +
21 'This means you will not be able to federate! ' +
22 'Please use %s %s npm run update-host to fix this.',
23 NODE_CONFIG_DIR ? `NODE_CONFIG_DIR=${NODE_CONFIG_DIR}` : '',
24 NODE_ENV ? `NODE_ENV=${NODE_ENV}` : ''
29 // Some checks on configuration files
30 // Return an error message, or null if everything is okay
31 function checkConfig () {
32 const defaultNSFWPolicy = config.get<string>('instance.default_nsfw_policy')
34 if ([ 'do_not_list', 'blur', 'display' ].indexOf(defaultNSFWPolicy) === -1) {
35 return 'NSFW policy setting should be "do_not_list" or "blur" or "display" instead of ' + defaultNSFWPolicy
41 // Check the config files
42 function checkMissedConfig () {
43 const required = [ 'listen.port', 'listen.hostname',
44 'webserver.https', 'webserver.hostname', 'webserver.port',
46 'database.hostname', 'database.port', 'database.suffix', 'database.username', 'database.password', 'database.pool.max',
47 'smtp.hostname', 'smtp.port', 'smtp.username', 'smtp.password', 'smtp.tls', 'smtp.from_address',
48 'storage.avatars', 'storage.videos', 'storage.logs', 'storage.previews', 'storage.thumbnails', 'storage.torrents', 'storage.cache',
51 'cache.previews.size', 'admin.email',
52 'signup.enabled', 'signup.limit', 'signup.filters.cidr.whitelist', 'signup.filters.cidr.blacklist',
53 'transcoding.enabled', 'transcoding.threads',
54 'import.videos.http.enabled',
55 'instance.name', 'instance.short_description', 'instance.description', 'instance.terms', 'instance.default_client_route',
56 'instance.default_nsfw_policy', 'instance.robots',
57 'services.twitter.username', 'services.twitter.whitelisted'
59 const requiredAlternatives = [
61 ['redis.hostname', 'redis.port'], // alternative
65 const miss: string[] = []
67 for (const key of required) {
68 if (!config.has(key)) {
73 const missingAlternatives = requiredAlternatives.filter(
74 set => !set.find(alternative => !alternative.find(key => !config.has(key)))
78 .forEach(set => set[0].forEach(key => miss.push(key)))
83 // Check the available codecs
84 // We get CONFIG by param to not import it in this file (import orders)
85 async function checkFFmpeg (CONFIG: { TRANSCODING: { ENABLED: boolean } }) {
86 const Ffmpeg = require('fluent-ffmpeg')
87 const getAvailableCodecsPromise = promisify0(Ffmpeg.getAvailableCodecs)
88 const codecs = await getAvailableCodecsPromise()
89 const canEncode = [ 'libx264' ]
91 if (CONFIG.TRANSCODING.ENABLED === false) return undefined
93 for (const codec of canEncode) {
94 if (codecs[codec] === undefined) {
95 throw new Error('Unknown codec ' + codec + ' in FFmpeg.')
98 if (codecs[codec].canEncode !== true) {
99 throw new Error('Unavailable encode codec ' + codec + ' in FFmpeg')
103 checkFFmpegEncoders()
106 // Optional encoders, if present, can be used to improve transcoding
107 // Here we ask ffmpeg if it detects their presence on the system, so that we can later use them
108 let supportedOptionalEncoders: Map<string, boolean>
109 async function checkFFmpegEncoders (): Promise<Map<string, boolean>> {
110 if (supportedOptionalEncoders !== undefined) {
111 return supportedOptionalEncoders
114 const Ffmpeg = require('fluent-ffmpeg')
115 const getAvailableEncodersPromise = promisify0(Ffmpeg.getAvailableEncoders)
116 const encoders = await getAvailableEncodersPromise()
117 const optionalEncoders = [ 'libfdk_aac' ]
118 supportedOptionalEncoders = new Map<string, boolean>()
120 for (const encoder of optionalEncoders) {
121 supportedOptionalEncoders.set(encoder,
122 encoders[encoder] !== undefined
127 // We get db by param to not import it in this file (import orders)
128 async function clientsExist () {
129 const totalClients = await OAuthClientModel.countTotal()
131 return totalClients !== 0
134 // We get db by param to not import it in this file (import orders)
135 async function usersExist () {
136 const totalUsers = await UserModel.countTotal()
138 return totalUsers !== 0
141 // We get db by param to not import it in this file (import orders)
142 async function applicationExist () {
143 const totalApplication = await ApplicationModel.countTotal()
145 return totalApplication !== 0
148 // ---------------------------------------------------------------------------