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,
15 } from '../../shared/models'
17 // ---------------------------------------------------------------------------
19 const LAST_MIGRATION_VERSION = 70
21 // ---------------------------------------------------------------------------
24 const API_VERSION = 'v1'
26 // Number of results by default for the pagination
27 const PAGINATION_COUNT_DEFAULT = 15
29 // Sortable columns per schema
30 const SEARCHABLE_COLUMNS = {
31 VIDEOS: [ 'name', 'magnetUri', 'host', 'author', 'tags' ]
34 // Sortable columns per schema
35 const SORTABLE_COLUMNS = {
36 USERS: [ 'id', 'username', 'createdAt' ],
37 VIDEO_ABUSES: [ 'id', 'createdAt' ],
38 VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ],
39 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ]
42 const OAUTH_LIFETIME = {
43 ACCESS_TOKEN: 3600 * 4, // 4 hours
44 REFRESH_TOKEN: 1209600 // 2 weeks
47 // ---------------------------------------------------------------------------
51 PORT: config.get<number>('listen.port')
54 DBNAME: 'peertube' + config.get<string>('database.suffix'),
55 HOSTNAME: config.get<string>('database.hostname'),
56 PORT: config.get<number>('database.port'),
57 USERNAME: config.get<string>('database.username'),
58 PASSWORD: config.get<string>('database.password')
61 CERT_DIR: join(root(), config.get<string>('storage.certs')),
62 LOG_DIR: join(root(), config.get<string>('storage.logs')),
63 VIDEOS_DIR: join(root(), config.get<string>('storage.videos')),
64 THUMBNAILS_DIR: join(root(), config.get<string>('storage.thumbnails')),
65 PREVIEWS_DIR: join(root(), config.get<string>('storage.previews')),
66 TORRENTS_DIR: join(root(), config.get<string>('storage.torrents')),
67 CACHE_DIR: join(root(), config.get<string>('storage.cache'))
70 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
71 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
72 HOSTNAME: config.get<string>('webserver.hostname'),
73 PORT: config.get<number>('webserver.port'),
78 EMAIL: config.get<string>('admin.email')
81 ENABLED: config.get<boolean>('signup.enabled'),
82 LIMIT: config.get<number>('signup.limit')
85 VIDEO_QUOTA: config.get<number>('user.video_quota')
88 ENABLED: config.get<boolean>('transcoding.enabled'),
89 THREADS: config.get<number>('transcoding.threads'),
91 '240' : config.get<boolean>('transcoding.resolutions.240p'),
92 '360': config.get<boolean>('transcoding.resolutions.360p'),
93 '480': config.get<boolean>('transcoding.resolutions.480p'),
94 '720': config.get<boolean>('transcoding.resolutions.720p'),
95 '1080': config.get<boolean>('transcoding.resolutions.1080p')
100 SIZE: config.get<number>('cache.previews.size')
104 CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
105 CONFIG.WEBSERVER.HOST = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
107 // ---------------------------------------------------------------------------
109 const CONSTRAINTS_FIELDS = {
111 USERNAME: { min: 3, max: 20 }, // Length
112 PASSWORD: { min: 6, max: 255 }, // Length
113 VIDEO_QUOTA: { min: -1 }
116 REASON: { min: 2, max: 300 } // Length
119 NAME: { min: 3, max: 50 }, // Length
120 DESCRIPTION: { min: 3, max: 250 }, // Length
121 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
122 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
123 DURATION: { min: 1, max: 7200 }, // Number
124 TAGS: { min: 0, max: 3 }, // Number of total tags
125 TAG: { min: 2, max: 10 }, // Length
126 THUMBNAIL: { min: 2, max: 30 },
127 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
130 DISLIKES: { min: 0 },
131 FILE_SIZE: { min: 10, max: 1024 * 1024 * 1024 * 3 /* 3Go */ }
138 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
143 const VIDEO_CATEGORIES = {
158 15: 'Science & Technology',
164 // See https://creativecommons.org/licenses/?lang=en
165 const VIDEO_LICENCES = {
167 2: 'Attribution - Share Alike',
168 3: 'Attribution - No Derivatives',
169 4: 'Attribution - Non Commercial',
170 5: 'Attribution - Non Commercial - Share Alike',
171 6: 'Attribution - Non Commercial - No Derivatives',
172 7: 'Public Domain Dedication'
175 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
176 const VIDEO_LANGUAGES = {
193 // TODO: use VideoResolution when https://github.com/Microsoft/TypeScript/issues/13042 is fixed
194 const VIDEO_FILE_RESOLUTIONS: { [ id: number ]: string } = {
203 // ---------------------------------------------------------------------------
205 // Score a pod has when we create it as a friend
206 const FRIEND_SCORE = {
211 // ---------------------------------------------------------------------------
213 // Number of points we add/remove from a friend after a successful/bad request
219 // Time to wait between requests to the friends (10 min)
220 let REQUESTS_INTERVAL = 600000
222 // Number of requests in parallel we can make
223 const REQUESTS_IN_PARALLEL = 10
225 // To how many pods we send requests
226 const REQUESTS_LIMIT_PODS = 10
227 // How many requests we send to a pod per interval
228 const REQUESTS_LIMIT_PER_POD = 5
230 const REQUESTS_VIDEO_QADU_LIMIT_PODS = 10
231 // The QADU requests are not big
232 const REQUESTS_VIDEO_QADU_LIMIT_PER_POD = 50
234 const REQUESTS_VIDEO_EVENT_LIMIT_PODS = 10
235 // The EVENTS requests are not big
236 const REQUESTS_VIDEO_EVENT_LIMIT_PER_POD = 50
238 // Number of requests to retry for replay requests module
239 const RETRY_REQUESTS = 5
241 const REQUEST_ENDPOINTS: { [ id: string ]: RequestEndpoint } = {
245 const REQUEST_ENDPOINT_ACTIONS: { [ id: string ]: any } = {}
246 REQUEST_ENDPOINT_ACTIONS[REQUEST_ENDPOINTS.VIDEOS] = {
250 REPORT_ABUSE: 'report-abuse'
253 const REQUEST_VIDEO_QADU_ENDPOINT = 'videos/qadu'
254 const REQUEST_VIDEO_EVENT_ENDPOINT = 'videos/events'
256 const REQUEST_VIDEO_QADU_TYPES: { [ id: string ]: RequestVideoQaduType } = {
258 DISLIKES: 'dislikes',
262 const REQUEST_VIDEO_EVENT_TYPES: { [ id: string ]: RequestVideoEventType } = {
264 DISLIKES: 'dislikes',
268 const REMOTE_SCHEME = {
273 const JOB_STATES: { [ id: string ]: JobState } = {
275 PROCESSING: 'processing',
279 // How many maximum jobs we fetch from the database per cycle
280 const JOBS_FETCH_LIMIT_PER_CYCLE = 10
281 const JOBS_CONCURRENCY = 1
283 let JOBS_FETCHING_INTERVAL = 60000
285 // ---------------------------------------------------------------------------
287 const PRIVATE_CERT_NAME = 'peertube.key.pem'
288 const PUBLIC_CERT_NAME = 'peertube.pub'
289 const SIGNATURE_ALGORITHM = 'RSA-SHA256'
290 const SIGNATURE_ENCODING = 'hex'
292 // Password encryption
293 const BCRYPT_SALT_SIZE = 10
295 // ---------------------------------------------------------------------------
297 // Express static paths (router)
298 const STATIC_PATHS = {
299 PREVIEWS: '/static/previews/',
300 THUMBNAILS: '/static/thumbnails/',
301 TORRENTS: '/static/torrents/',
302 WEBSEED: '/static/webseed/'
306 let STATIC_MAX_AGE = '30d'
308 // Videos thumbnail size
309 const THUMBNAILS_SIZE = '200x110'
310 const PREVIEWS_SIZE = '640x480'
312 // Sub folders of cache directory
315 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
319 // ---------------------------------------------------------------------------
321 const USER_ROLES: { [ id: string ]: UserRole } = {
326 // ---------------------------------------------------------------------------
328 const OPENGRAPH_COMMENT = '<!-- open graph tags -->'
330 // ---------------------------------------------------------------------------
332 // Special constants for a test instance
333 if (isTestInstance() === true) {
334 CONSTRAINTS_FIELDS.VIDEOS.DURATION.max = 14
335 FRIEND_SCORE.BASE = 20
336 REQUESTS_INTERVAL = 10000
337 JOBS_FETCHING_INTERVAL = 10000
338 REMOTE_SCHEME.HTTP = 'http'
339 REMOTE_SCHEME.WS = 'ws'
343 // ---------------------------------------------------------------------------
354 JOBS_FETCH_LIMIT_PER_CYCLE,
355 JOBS_FETCHING_INTERVAL,
356 LAST_MIGRATION_VERSION,
359 PAGINATION_COUNT_DEFAULT,
365 REQUEST_ENDPOINT_ACTIONS,
367 REQUEST_VIDEO_EVENT_ENDPOINT,
368 REQUEST_VIDEO_EVENT_TYPES,
369 REQUEST_VIDEO_QADU_ENDPOINT,
370 REQUEST_VIDEO_QADU_TYPES,
371 REQUESTS_IN_PARALLEL,
373 REQUESTS_LIMIT_PER_POD,
375 REQUESTS_VIDEO_EVENT_LIMIT_PER_POD,
376 REQUESTS_VIDEO_EVENT_LIMIT_PODS,
377 REQUESTS_VIDEO_QADU_LIMIT_PER_POD,
378 REQUESTS_VIDEO_QADU_LIMIT_PODS,
389 VIDEO_FILE_RESOLUTIONS,