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 = 70
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' ]
40 const OAUTH_LIFETIME = {
41 ACCESS_TOKEN: 3600 * 4, // 4 hours
42 REFRESH_TOKEN: 1209600 // 2 weeks
45 // ---------------------------------------------------------------------------
49 PORT: config.get<number>('listen.port')
52 DBNAME: 'peertube' + config.get<string>('database.suffix'),
53 HOSTNAME: config.get<string>('database.hostname'),
54 PORT: config.get<number>('database.port'),
55 USERNAME: config.get<string>('database.username'),
56 PASSWORD: config.get<string>('database.password')
59 CERT_DIR: join(root(), config.get<string>('storage.certs')),
60 LOG_DIR: join(root(), config.get<string>('storage.logs')),
61 VIDEOS_DIR: join(root(), config.get<string>('storage.videos')),
62 THUMBNAILS_DIR: join(root(), config.get<string>('storage.thumbnails')),
63 PREVIEWS_DIR: join(root(), config.get<string>('storage.previews')),
64 TORRENTS_DIR: join(root(), config.get<string>('storage.torrents')),
65 CACHE_DIR: join(root(), config.get<string>('storage.cache'))
68 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
69 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
70 HOSTNAME: config.get<string>('webserver.hostname'),
71 PORT: config.get<number>('webserver.port'),
76 EMAIL: config.get<string>('admin.email')
79 ENABLED: config.get<boolean>('signup.enabled'),
80 LIMIT: config.get<number>('signup.limit'),
83 VIDEO_QUOTA: config.get<number>('user.video_quota')
86 ENABLED: config.get<boolean>('transcoding.enabled'),
87 THREADS: config.get<number>('transcoding.threads')
91 SIZE: config.get<number>('cache.previews.size')
95 CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
96 CONFIG.WEBSERVER.HOST = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
98 // ---------------------------------------------------------------------------
100 const CONSTRAINTS_FIELDS = {
102 USERNAME: { min: 3, max: 20 }, // Length
103 PASSWORD: { min: 6, max: 255 }, // Length
104 VIDEO_QUOTA: { min: -1 }
107 REASON: { min: 2, max: 300 } // Length
110 NAME: { min: 3, max: 50 }, // Length
111 DESCRIPTION: { min: 3, max: 250 }, // Length
112 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
113 INFO_HASH: { min: 40, max: 40 }, // Length, infohash is 20 bytes length but we represent it in hexa so 20 * 2
114 DURATION: { min: 1, max: 7200 }, // Number
115 TAGS: { min: 0, max: 3 }, // Number of total tags
116 TAG: { min: 2, max: 10 }, // Length
117 THUMBNAIL: { min: 2, max: 30 },
118 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
121 DISLIKES: { min: 0 },
122 FILE_SIZE: { min: 10, max: 1024 * 1024 * 1024 * 3 /* 3Go */ }
129 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
134 const VIDEO_CATEGORIES = {
149 15: 'Science & Technology',
155 // See https://creativecommons.org/licenses/?lang=en
156 const VIDEO_LICENCES = {
158 2: 'Attribution - Share Alike',
159 3: 'Attribution - No Derivatives',
160 4: 'Attribution - Non Commercial',
161 5: 'Attribution - Non Commercial - Share Alike',
162 6: 'Attribution - Non Commercial - No Derivatives',
163 7: 'Public Domain Dedication'
166 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
167 const VIDEO_LANGUAGES = {
184 const VIDEO_FILE_RESOLUTIONS = {
192 // ---------------------------------------------------------------------------
194 // Score a pod has when we create it as a friend
195 const FRIEND_SCORE = {
200 // ---------------------------------------------------------------------------
202 // Number of points we add/remove from a friend after a successful/bad request
208 // Time to wait between requests to the friends (10 min)
209 let REQUESTS_INTERVAL = 600000
211 // Number of requests in parallel we can make
212 const REQUESTS_IN_PARALLEL = 10
214 // To how many pods we send requests
215 const REQUESTS_LIMIT_PODS = 10
216 // How many requests we send to a pod per interval
217 const REQUESTS_LIMIT_PER_POD = 5
219 const REQUESTS_VIDEO_QADU_LIMIT_PODS = 10
220 // The QADU requests are not big
221 const REQUESTS_VIDEO_QADU_LIMIT_PER_POD = 50
223 const REQUESTS_VIDEO_EVENT_LIMIT_PODS = 10
224 // The EVENTS requests are not big
225 const REQUESTS_VIDEO_EVENT_LIMIT_PER_POD = 50
227 // Number of requests to retry for replay requests module
228 const RETRY_REQUESTS = 5
230 const REQUEST_ENDPOINTS: { [ id: string ]: RequestEndpoint } = {
234 const REQUEST_ENDPOINT_ACTIONS: { [ id: string ]: any } = {}
235 REQUEST_ENDPOINT_ACTIONS[REQUEST_ENDPOINTS.VIDEOS] = {
239 REPORT_ABUSE: 'report-abuse'
242 const REQUEST_VIDEO_QADU_ENDPOINT = 'videos/qadu'
243 const REQUEST_VIDEO_EVENT_ENDPOINT = 'videos/events'
245 const REQUEST_VIDEO_QADU_TYPES: { [ id: string ]: RequestVideoQaduType } = {
247 DISLIKES: 'dislikes',
251 const REQUEST_VIDEO_EVENT_TYPES: { [ id: string ]: RequestVideoEventType } = {
253 DISLIKES: 'dislikes',
257 const REMOTE_SCHEME = {
262 const JOB_STATES: { [ id: string ]: JobState } = {
264 PROCESSING: 'processing',
268 // How many maximum jobs we fetch from the database per cycle
269 const JOBS_FETCH_LIMIT_PER_CYCLE = 10
270 const JOBS_CONCURRENCY = 1
272 let JOBS_FETCHING_INTERVAL = 60000
274 // ---------------------------------------------------------------------------
276 const PRIVATE_CERT_NAME = 'peertube.key.pem'
277 const PUBLIC_CERT_NAME = 'peertube.pub'
278 const SIGNATURE_ALGORITHM = 'RSA-SHA256'
279 const SIGNATURE_ENCODING = 'hex'
281 // Password encryption
282 const BCRYPT_SALT_SIZE = 10
284 // ---------------------------------------------------------------------------
286 // Express static paths (router)
287 const STATIC_PATHS = {
288 PREVIEWS: '/static/previews/',
289 THUMBNAILS: '/static/thumbnails/',
290 TORRENTS: '/static/torrents/',
291 WEBSEED: '/static/webseed/'
295 let STATIC_MAX_AGE = '30d'
297 // Videos thumbnail size
298 const THUMBNAILS_SIZE = '200x110'
299 const PREVIEWS_SIZE = '640x480'
301 // Subfolders of cache directory
304 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
308 // ---------------------------------------------------------------------------
310 const USER_ROLES: { [ id: string ]: UserRole } = {
315 // ---------------------------------------------------------------------------
317 const OPENGRAPH_COMMENT = '<!-- opengraph tags -->'
319 // ---------------------------------------------------------------------------
321 // Special constants for a test instance
322 if (isTestInstance() === true) {
323 CONSTRAINTS_FIELDS.VIDEOS.DURATION.max = 14
324 FRIEND_SCORE.BASE = 20
325 REQUESTS_INTERVAL = 10000
326 JOBS_FETCHING_INTERVAL = 10000
327 REMOTE_SCHEME.HTTP = 'http'
328 REMOTE_SCHEME.WS = 'ws'
332 // ---------------------------------------------------------------------------
343 JOBS_FETCH_LIMIT_PER_CYCLE,
344 JOBS_FETCHING_INTERVAL,
345 LAST_MIGRATION_VERSION,
348 PAGINATION_COUNT_DEFAULT,
354 REQUEST_ENDPOINT_ACTIONS,
356 REQUEST_VIDEO_EVENT_ENDPOINT,
357 REQUEST_VIDEO_EVENT_TYPES,
358 REQUEST_VIDEO_QADU_ENDPOINT,
359 REQUEST_VIDEO_QADU_TYPES,
360 REQUESTS_IN_PARALLEL,
362 REQUESTS_LIMIT_PER_POD,
364 REQUESTS_VIDEO_EVENT_LIMIT_PER_POD,
365 REQUESTS_VIDEO_EVENT_LIMIT_PODS,
366 REQUESTS_VIDEO_QADU_LIMIT_PER_POD,
367 REQUESTS_VIDEO_QADU_LIMIT_PODS,
378 VIDEO_FILE_RESOLUTIONS,