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'
11 RequestVideoEventType,
14 } from '../../shared/models'
16 // ---------------------------------------------------------------------------
18 const LAST_MIGRATION_VERSION = 75
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 USERS: [ 'id', 'username', 'createdAt' ],
36 VIDEO_ABUSES: [ 'id', 'createdAt' ],
37 VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ],
38 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ]
41 const OAUTH_LIFETIME = {
42 ACCESS_TOKEN: 3600 * 4, // 4 hours
43 REFRESH_TOKEN: 1209600 // 2 weeks
46 // ---------------------------------------------------------------------------
50 PORT: config.get<number>('listen.port')
53 DBNAME: 'peertube' + config.get<string>('database.suffix'),
54 HOSTNAME: config.get<string>('database.hostname'),
55 PORT: config.get<number>('database.port'),
56 USERNAME: config.get<string>('database.username'),
57 PASSWORD: config.get<string>('database.password')
60 CERT_DIR: join(root(), config.get<string>('storage.certs')),
61 LOG_DIR: join(root(), config.get<string>('storage.logs')),
62 VIDEOS_DIR: join(root(), config.get<string>('storage.videos')),
63 THUMBNAILS_DIR: join(root(), config.get<string>('storage.thumbnails')),
64 PREVIEWS_DIR: join(root(), config.get<string>('storage.previews')),
65 TORRENTS_DIR: join(root(), config.get<string>('storage.torrents')),
66 CACHE_DIR: join(root(), config.get<string>('storage.cache'))
69 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
70 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
71 HOSTNAME: config.get<string>('webserver.hostname'),
72 PORT: config.get<number>('webserver.port'),
77 EMAIL: config.get<string>('admin.email')
80 ENABLED: config.get<boolean>('signup.enabled'),
81 LIMIT: config.get<number>('signup.limit')
84 VIDEO_QUOTA: config.get<number>('user.video_quota')
87 ENABLED: config.get<boolean>('transcoding.enabled'),
88 THREADS: config.get<number>('transcoding.threads'),
90 '240' : config.get<boolean>('transcoding.resolutions.240p'),
91 '360': config.get<boolean>('transcoding.resolutions.360p'),
92 '480': config.get<boolean>('transcoding.resolutions.480p'),
93 '720': config.get<boolean>('transcoding.resolutions.720p'),
94 '1080': config.get<boolean>('transcoding.resolutions.1080p')
99 SIZE: config.get<number>('cache.previews.size')
103 CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
104 CONFIG.WEBSERVER.HOST = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
106 // ---------------------------------------------------------------------------
108 const CONSTRAINTS_FIELDS = {
110 USERNAME: { min: 3, max: 20 }, // Length
111 PASSWORD: { min: 6, max: 255 }, // Length
112 VIDEO_QUOTA: { min: -1 }
115 REASON: { min: 2, max: 300 } // Length
118 NAME: { min: 3, max: 50 }, // Length
119 DESCRIPTION: { min: 3, max: 250 }, // Length
120 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
121 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
122 DURATION: { min: 1, max: 7200 }, // Number
123 TAGS: { min: 0, max: 3 }, // Number of total tags
124 TAG: { min: 2, max: 10 }, // Length
125 THUMBNAIL: { min: 2, max: 30 },
126 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
129 DISLIKES: { min: 0 },
130 FILE_SIZE: { min: 10, max: 1024 * 1024 * 1024 * 3 /* 3Go */ }
137 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
142 const VIDEO_CATEGORIES = {
157 15: 'Science & Technology',
163 // See https://creativecommons.org/licenses/?lang=en
164 const VIDEO_LICENCES = {
166 2: 'Attribution - Share Alike',
167 3: 'Attribution - No Derivatives',
168 4: 'Attribution - Non Commercial',
169 5: 'Attribution - Non Commercial - Share Alike',
170 6: 'Attribution - Non Commercial - No Derivatives',
171 7: 'Public Domain Dedication'
174 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
175 const VIDEO_LANGUAGES = {
192 // TODO: use VideoResolution when https://github.com/Microsoft/TypeScript/issues/13042 is fixed
193 const VIDEO_FILE_RESOLUTIONS: { [ id: number ]: string } = {
202 // ---------------------------------------------------------------------------
204 // Score a pod has when we create it as a friend
205 const FRIEND_SCORE = {
210 // ---------------------------------------------------------------------------
212 // Number of points we add/remove from a friend after a successful/bad request
218 // Time to wait between requests to the friends (10 min)
219 let REQUESTS_INTERVAL = 600000
221 // Number of requests in parallel we can make
222 const REQUESTS_IN_PARALLEL = 10
224 // To how many pods we send requests
225 const REQUESTS_LIMIT_PODS = 10
226 // How many requests we send to a pod per interval
227 const REQUESTS_LIMIT_PER_POD = 5
229 const REQUESTS_VIDEO_QADU_LIMIT_PODS = 10
230 // The QADU requests are not big
231 const REQUESTS_VIDEO_QADU_LIMIT_PER_POD = 50
233 const REQUESTS_VIDEO_EVENT_LIMIT_PODS = 10
234 // The EVENTS requests are not big
235 const REQUESTS_VIDEO_EVENT_LIMIT_PER_POD = 50
237 // Number of requests to retry for replay requests module
238 const RETRY_REQUESTS = 5
240 const REQUEST_ENDPOINTS: { [ id: string ]: RequestEndpoint } = {
244 const REQUEST_ENDPOINT_ACTIONS: { [ id: string ]: any } = {}
245 REQUEST_ENDPOINT_ACTIONS[REQUEST_ENDPOINTS.VIDEOS] = {
249 REPORT_ABUSE: 'report-abuse'
252 const REQUEST_VIDEO_QADU_ENDPOINT = 'videos/qadu'
253 const REQUEST_VIDEO_EVENT_ENDPOINT = 'videos/events'
255 const REQUEST_VIDEO_QADU_TYPES: { [ id: string ]: RequestVideoQaduType } = {
257 DISLIKES: 'dislikes',
261 const REQUEST_VIDEO_EVENT_TYPES: { [ id: string ]: RequestVideoEventType } = {
263 DISLIKES: 'dislikes',
267 const REMOTE_SCHEME = {
272 const JOB_STATES: { [ id: string ]: JobState } = {
274 PROCESSING: 'processing',
278 // How many maximum jobs we fetch from the database per cycle
279 const JOBS_FETCH_LIMIT_PER_CYCLE = 10
280 const JOBS_CONCURRENCY = 1
282 let JOBS_FETCHING_INTERVAL = 60000
284 // ---------------------------------------------------------------------------
286 const PRIVATE_CERT_NAME = 'peertube.key.pem'
287 const PUBLIC_CERT_NAME = 'peertube.pub'
288 const SIGNATURE_ALGORITHM = 'RSA-SHA256'
289 const SIGNATURE_ENCODING = 'hex'
291 // Password encryption
292 const BCRYPT_SALT_SIZE = 10
294 // ---------------------------------------------------------------------------
296 // Express static paths (router)
297 const STATIC_PATHS = {
298 PREVIEWS: '/static/previews/',
299 THUMBNAILS: '/static/thumbnails/',
300 TORRENTS: '/static/torrents/',
301 WEBSEED: '/static/webseed/'
305 let STATIC_MAX_AGE = '30d'
307 // Videos thumbnail size
308 const THUMBNAILS_SIZE = '200x110'
309 const PREVIEWS_SIZE = '640x480'
311 // Sub folders of cache directory
314 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
318 // ---------------------------------------------------------------------------
320 const USER_ROLES: { [ id: string ]: UserRole } = {
325 // ---------------------------------------------------------------------------
327 const OPENGRAPH_COMMENT = '<!-- open graph tags -->'
329 // ---------------------------------------------------------------------------
331 // Special constants for a test instance
332 if (isTestInstance() === true) {
333 CONSTRAINTS_FIELDS.VIDEOS.DURATION.max = 14
334 FRIEND_SCORE.BASE = 20
335 REQUESTS_INTERVAL = 10000
336 JOBS_FETCHING_INTERVAL = 10000
337 REMOTE_SCHEME.HTTP = 'http'
338 REMOTE_SCHEME.WS = 'ws'
342 // ---------------------------------------------------------------------------
353 JOBS_FETCH_LIMIT_PER_CYCLE,
354 JOBS_FETCHING_INTERVAL,
355 LAST_MIGRATION_VERSION,
358 PAGINATION_COUNT_DEFAULT,
364 REQUEST_ENDPOINT_ACTIONS,
366 REQUEST_VIDEO_EVENT_ENDPOINT,
367 REQUEST_VIDEO_EVENT_TYPES,
368 REQUEST_VIDEO_QADU_ENDPOINT,
369 REQUEST_VIDEO_QADU_TYPES,
370 REQUESTS_IN_PARALLEL,
372 REQUESTS_LIMIT_PER_POD,
374 REQUESTS_VIDEO_EVENT_LIMIT_PER_POD,
375 REQUESTS_VIDEO_EVENT_LIMIT_PODS,
376 REQUESTS_VIDEO_QADU_LIMIT_PER_POD,
377 REQUESTS_VIDEO_QADU_LIMIT_PODS,
388 VIDEO_FILE_RESOLUTIONS,