1 import * as config from 'config'
2 import { join } from 'path'
4 // Do not use barrels, remain constants as independent as possible
5 import { root, isTestInstance } from '../helpers/core-utils'
10 RequestVideoEventType,
12 RemoteVideoRequestType,
14 } from '../../shared/models'
16 // ---------------------------------------------------------------------------
18 const LAST_MIGRATION_VERSION = 85
20 // ---------------------------------------------------------------------------
23 const API_VERSION = 'v1'
25 // Number of results by default for the pagination
26 const PAGINATION_COUNT_DEFAULT = 15
28 // Sortable columns per schema
29 const SEARCHABLE_COLUMNS = {
30 VIDEOS: [ 'name', 'magnetUri', 'host', 'author', 'tags' ]
33 // Sortable columns per schema
34 const SORTABLE_COLUMNS = {
35 PODS: [ 'id', 'host', 'score', 'createdAt' ],
36 USERS: [ 'id', 'username', 'createdAt' ],
37 VIDEO_ABUSES: [ 'id', 'createdAt' ],
38 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
39 VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ],
40 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ]
43 const OAUTH_LIFETIME = {
44 ACCESS_TOKEN: 3600 * 4, // 4 hours
45 REFRESH_TOKEN: 1209600 // 2 weeks
48 // ---------------------------------------------------------------------------
52 PORT: config.get<number>('listen.port')
55 DBNAME: 'peertube' + config.get<string>('database.suffix'),
56 HOSTNAME: config.get<string>('database.hostname'),
57 PORT: config.get<number>('database.port'),
58 USERNAME: config.get<string>('database.username'),
59 PASSWORD: config.get<string>('database.password')
62 CERT_DIR: join(root(), config.get<string>('storage.certs')),
63 LOG_DIR: join(root(), config.get<string>('storage.logs')),
64 VIDEOS_DIR: join(root(), config.get<string>('storage.videos')),
65 THUMBNAILS_DIR: join(root(), config.get<string>('storage.thumbnails')),
66 PREVIEWS_DIR: join(root(), config.get<string>('storage.previews')),
67 TORRENTS_DIR: join(root(), config.get<string>('storage.torrents')),
68 CACHE_DIR: join(root(), config.get<string>('storage.cache'))
71 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
72 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
73 HOSTNAME: config.get<string>('webserver.hostname'),
74 PORT: config.get<number>('webserver.port'),
79 EMAIL: config.get<string>('admin.email')
82 ENABLED: config.get<boolean>('signup.enabled'),
83 LIMIT: config.get<number>('signup.limit')
86 VIDEO_QUOTA: config.get<number>('user.video_quota')
89 ENABLED: config.get<boolean>('transcoding.enabled'),
90 THREADS: config.get<number>('transcoding.threads'),
92 '240' : config.get<boolean>('transcoding.resolutions.240p'),
93 '360': config.get<boolean>('transcoding.resolutions.360p'),
94 '480': config.get<boolean>('transcoding.resolutions.480p'),
95 '720': config.get<boolean>('transcoding.resolutions.720p'),
96 '1080': config.get<boolean>('transcoding.resolutions.1080p')
101 SIZE: config.get<number>('cache.previews.size')
105 CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
106 CONFIG.WEBSERVER.HOST = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
108 // ---------------------------------------------------------------------------
110 const CONSTRAINTS_FIELDS = {
112 USERNAME: { min: 3, max: 20 }, // Length
113 PASSWORD: { min: 6, max: 255 }, // Length
114 VIDEO_QUOTA: { min: -1 }
117 REASON: { min: 2, max: 300 } // Length
120 NAME: { min: 3, max: 120 }, // Length
121 DESCRIPTION: { min: 3, max: 250 } // Length
124 NAME: { min: 3, max: 120 }, // Length
125 DESCRIPTION: { min: 3, max: 250 }, // Length
126 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
127 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
128 DURATION: { min: 1, max: 7200 }, // Number
129 TAGS: { min: 0, max: 5 }, // Number of total tags
130 TAG: { min: 2, max: 30 }, // Length
131 THUMBNAIL: { min: 2, max: 30 },
132 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
135 DISLIKES: { min: 0 },
136 FILE_SIZE: { min: 10, max: 1024 * 1024 * 1024 * 3 /* 3Go */ }
143 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
148 const VIDEO_CATEGORIES = {
163 15: 'Science & Technology',
169 // See https://creativecommons.org/licenses/?lang=en
170 const VIDEO_LICENCES = {
172 2: 'Attribution - Share Alike',
173 3: 'Attribution - No Derivatives',
174 4: 'Attribution - Non Commercial',
175 5: 'Attribution - Non Commercial - Share Alike',
176 6: 'Attribution - Non Commercial - No Derivatives',
177 7: 'Public Domain Dedication'
180 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
181 const VIDEO_LANGUAGES = {
198 // ---------------------------------------------------------------------------
200 // Score a pod has when we create it as a friend
201 const FRIEND_SCORE = {
206 // ---------------------------------------------------------------------------
208 // Number of points we add/remove from a friend after a successful/bad request
214 // Time to wait between requests to the friends (10 min)
215 let REQUESTS_INTERVAL = 600000
217 // Number of requests in parallel we can make
218 const REQUESTS_IN_PARALLEL = 10
220 // To how many pods we send requests
221 const REQUESTS_LIMIT_PODS = 10
222 // How many requests we send to a pod per interval
223 const REQUESTS_LIMIT_PER_POD = 5
225 const REQUESTS_VIDEO_QADU_LIMIT_PODS = 10
226 // The QADU requests are not big
227 const REQUESTS_VIDEO_QADU_LIMIT_PER_POD = 50
229 const REQUESTS_VIDEO_EVENT_LIMIT_PODS = 10
230 // The EVENTS requests are not big
231 const REQUESTS_VIDEO_EVENT_LIMIT_PER_POD = 50
233 // Number of requests to retry for replay requests module
234 const RETRY_REQUESTS = 5
236 const REQUEST_ENDPOINTS: { [ id: string ]: RequestEndpoint } = {
240 const REQUEST_ENDPOINT_ACTIONS: {
242 [ id: string ]: RemoteVideoRequestType
245 REQUEST_ENDPOINT_ACTIONS[REQUEST_ENDPOINTS.VIDEOS] = {
246 ADD_VIDEO: 'add-video',
247 UPDATE_VIDEO: 'update-video',
248 REMOVE_VIDEO: 'remove-video',
249 ADD_CHANNEL: 'add-channel',
250 UPDATE_CHANNEL: 'update-channel',
251 REMOVE_CHANNEL: 'remove-channel',
252 ADD_AUTHOR: 'add-author',
253 REMOVE_AUTHOR: 'remove-author',
254 REPORT_ABUSE: 'report-abuse'
257 const REQUEST_VIDEO_QADU_ENDPOINT = 'videos/qadu'
258 const REQUEST_VIDEO_EVENT_ENDPOINT = 'videos/events'
260 const REQUEST_VIDEO_QADU_TYPES: { [ id: string ]: RequestVideoQaduType } = {
262 DISLIKES: 'dislikes',
266 const REQUEST_VIDEO_EVENT_TYPES: { [ id: string ]: RequestVideoEventType } = {
268 DISLIKES: 'dislikes',
272 const REMOTE_SCHEME = {
277 const JOB_STATES: { [ id: string ]: JobState } = {
279 PROCESSING: 'processing',
283 // How many maximum jobs we fetch from the database per cycle
284 const JOBS_FETCH_LIMIT_PER_CYCLE = 10
286 let JOBS_FETCHING_INTERVAL = 60000
288 // ---------------------------------------------------------------------------
290 const PRIVATE_CERT_NAME = 'peertube.key.pem'
291 const PUBLIC_CERT_NAME = 'peertube.pub'
292 const SIGNATURE_ALGORITHM = 'RSA-SHA256'
293 const SIGNATURE_ENCODING = 'hex'
295 // Password encryption
296 const BCRYPT_SALT_SIZE = 10
298 // ---------------------------------------------------------------------------
300 // Express static paths (router)
301 const STATIC_PATHS = {
302 PREVIEWS: '/static/previews/',
303 THUMBNAILS: '/static/thumbnails/',
304 TORRENTS: '/static/torrents/',
305 WEBSEED: '/static/webseed/'
309 let STATIC_MAX_AGE = '30d'
311 // Videos thumbnail size
312 const THUMBNAILS_SIZE = {
316 const PREVIEWS_SIZE = {
326 // Sub folders of cache directory
329 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
333 // ---------------------------------------------------------------------------
335 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
337 // ---------------------------------------------------------------------------
339 // Special constants for a test instance
340 if (isTestInstance() === true) {
341 CONSTRAINTS_FIELDS.VIDEOS.DURATION.max = 14
342 FRIEND_SCORE.BASE = 20
343 REQUESTS_INTERVAL = 10000
344 JOBS_FETCHING_INTERVAL = 10000
345 REMOTE_SCHEME.HTTP = 'http'
346 REMOTE_SCHEME.WS = 'ws'
350 // ---------------------------------------------------------------------------
361 JOBS_FETCH_LIMIT_PER_CYCLE,
362 JOBS_FETCHING_INTERVAL,
363 LAST_MIGRATION_VERSION,
365 OPENGRAPH_AND_OEMBED_COMMENT,
366 PAGINATION_COUNT_DEFAULT,
372 REQUEST_ENDPOINT_ACTIONS,
374 REQUEST_VIDEO_EVENT_ENDPOINT,
375 REQUEST_VIDEO_EVENT_TYPES,
376 REQUEST_VIDEO_QADU_ENDPOINT,
377 REQUEST_VIDEO_QADU_TYPES,
378 REQUESTS_IN_PARALLEL,
380 REQUESTS_LIMIT_PER_POD,
382 REQUESTS_VIDEO_EVENT_LIMIT_PER_POD,
383 REQUESTS_VIDEO_EVENT_LIMIT_PODS,
384 REQUESTS_VIDEO_QADU_LIMIT_PER_POD,
385 REQUESTS_VIDEO_QADU_LIMIT_PODS,