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 } from '../../shared/models'
12 import { VideoPrivacy } from '../../shared/models/videos/video-privacy.enum'
13 import { FollowState } from '../../shared/models/accounts/follow.model'
15 // ---------------------------------------------------------------------------
17 const LAST_MIGRATION_VERSION = 120
19 // ---------------------------------------------------------------------------
22 const API_VERSION = 'v1'
24 // Number of results by default for the pagination
25 const PAGINATION_COUNT_DEFAULT = 15
27 // Sortable columns per schema
28 const SORTABLE_COLUMNS = {
29 USERS: [ 'id', 'username', 'createdAt' ],
30 JOBS: [ 'id', 'createdAt' ],
31 VIDEO_ABUSES: [ 'id', 'createdAt' ],
32 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
33 VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ],
34 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
35 FOLLOWERS: [ 'createdAt' ],
36 FOLLOWING: [ 'createdAt' ]
39 const OAUTH_LIFETIME = {
40 ACCESS_TOKEN: 3600 * 4, // 4 hours
41 REFRESH_TOKEN: 1209600 // 2 weeks
44 // ---------------------------------------------------------------------------
48 PORT: config.get<number>('listen.port')
51 DBNAME: 'peertube' + config.get<string>('database.suffix'),
52 HOSTNAME: config.get<string>('database.hostname'),
53 PORT: config.get<number>('database.port'),
54 USERNAME: config.get<string>('database.username'),
55 PASSWORD: config.get<string>('database.password')
58 AVATARS_DIR: join(root(), config.get<string>('storage.avatars')),
59 LOG_DIR: join(root(), config.get<string>('storage.logs')),
60 VIDEOS_DIR: join(root(), config.get<string>('storage.videos')),
61 THUMBNAILS_DIR: join(root(), config.get<string>('storage.thumbnails')),
62 PREVIEWS_DIR: join(root(), config.get<string>('storage.previews')),
63 TORRENTS_DIR: join(root(), config.get<string>('storage.torrents')),
64 CACHE_DIR: join(root(), config.get<string>('storage.cache'))
67 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
68 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
69 HOSTNAME: config.get<string>('webserver.hostname'),
70 PORT: config.get<number>('webserver.port'),
75 EMAIL: config.get<string>('admin.email')
78 ENABLED: config.get<boolean>('signup.enabled'),
79 LIMIT: config.get<number>('signup.limit')
82 VIDEO_QUOTA: config.get<number>('user.video_quota')
85 ENABLED: config.get<boolean>('transcoding.enabled'),
86 THREADS: config.get<number>('transcoding.threads'),
88 '240' : config.get<boolean>('transcoding.resolutions.240p'),
89 '360': config.get<boolean>('transcoding.resolutions.360p'),
90 '480': config.get<boolean>('transcoding.resolutions.480p'),
91 '720': config.get<boolean>('transcoding.resolutions.720p'),
92 '1080': config.get<boolean>('transcoding.resolutions.1080p')
97 SIZE: config.get<number>('cache.previews.size')
101 CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
102 CONFIG.WEBSERVER.HOST = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
104 const AVATARS_DIR = {
105 ACCOUNT: join(CONFIG.STORAGE.AVATARS_DIR, 'account')
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: 120 }, // Length
120 DESCRIPTION: { min: 3, max: 250 }, // Length
121 URL: { min: 3, max: 2000 } // Length
124 NAME: { min: 3, max: 120 }, // Length
125 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
126 DESCRIPTION: { min: 3, max: 3000 }, // Length
127 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
128 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
129 DURATION: { min: 1 }, // Number
130 TAGS: { min: 0, max: 5 }, // Number of total tags
131 TAG: { min: 2, max: 30 }, // Length
132 THUMBNAIL: { min: 2, max: 30 },
133 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
136 DISLIKES: { min: 0 },
137 FILE_SIZE: { min: 10 },
138 URL: { min: 3, max: 2000 } // Length
141 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
142 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
143 URL: { min: 3, max: 2000 } // Length
150 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
155 const VIDEO_CATEGORIES = {
170 15: 'Science & Technology',
176 // See https://creativecommons.org/licenses/?lang=en
177 const VIDEO_LICENCES = {
179 2: 'Attribution - Share Alike',
180 3: 'Attribution - No Derivatives',
181 4: 'Attribution - Non Commercial',
182 5: 'Attribution - Non Commercial - Share Alike',
183 6: 'Attribution - Non Commercial - No Derivatives',
184 7: 'Public Domain Dedication'
187 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
188 const VIDEO_LANGUAGES = {
205 const VIDEO_PRIVACIES = {
206 [VideoPrivacy.PUBLIC]: 'Public',
207 [VideoPrivacy.UNLISTED]: 'Unlisted',
208 [VideoPrivacy.PRIVATE]: 'Private'
211 const VIDEO_MIMETYPE_EXT = {
212 'video/webm': '.webm',
217 // ---------------------------------------------------------------------------
219 const SERVER_ACCOUNT_NAME = 'peertube'
221 const ACTIVITY_PUB = {
222 POTENTIAL_ACCEPT_HEADERS: [
223 'application/activity+json',
224 'application/ld+json'
226 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
227 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
228 COLLECTION_ITEMS_PER_PAGE: 10,
229 FETCH_PAGE_LIMIT: 100,
232 VIDEO: [ 'video/mp4', 'video/webm', 'video/ogg' ], // TODO: Merge with VIDEO_MIMETYPE_EXT
233 TORRENT: [ 'application/x-bittorrent' ],
234 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
238 // ---------------------------------------------------------------------------
240 // Number of points we add/remove from a friend after a successful/bad request
241 const SERVERS_SCORE = {
248 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
253 const REMOTE_SCHEME = {
258 const JOB_STATES: { [ id: string ]: JobState } = {
260 PROCESSING: 'processing',
264 const JOB_CATEGORIES: { [ id: string ]: JobCategory } = {
265 TRANSCODING: 'transcoding',
266 ACTIVITYPUB_HTTP: 'activitypub-http'
268 // How many maximum jobs we fetch from the database per cycle
269 const JOBS_FETCH_LIMIT_PER_CYCLE = {
274 let JOBS_FETCHING_INTERVAL = 60000
276 // ---------------------------------------------------------------------------
278 const PRIVATE_RSA_KEY_SIZE = 2048
280 // Password encryption
281 const BCRYPT_SALT_SIZE = 10
283 // ---------------------------------------------------------------------------
285 // Express static paths (router)
286 const STATIC_PATHS = {
287 PREVIEWS: '/static/previews/',
288 THUMBNAILS: '/static/thumbnails/',
289 TORRENTS: '/static/torrents/',
290 WEBSEED: '/static/webseed/'
294 let STATIC_MAX_AGE = '30d'
296 // Videos thumbnail size
297 const THUMBNAILS_SIZE = {
301 const PREVIEWS_SIZE = {
311 // Sub folders of cache directory
314 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
318 const ACCEPT_HEADERS = ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS.concat('html', 'application/json')
320 // ---------------------------------------------------------------------------
322 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
324 // ---------------------------------------------------------------------------
326 // Special constants for a test instance
327 if (isTestInstance() === true) {
328 SERVERS_SCORE.BASE = 20
329 JOBS_FETCHING_INTERVAL = 1000
330 REMOTE_SCHEME.HTTP = 'http'
331 REMOTE_SCHEME.WS = 'ws'
333 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
336 // ---------------------------------------------------------------------------
347 JOBS_FETCH_LIMIT_PER_CYCLE,
348 JOBS_FETCHING_INTERVAL,
350 LAST_MIGRATION_VERSION,
352 OPENGRAPH_AND_OEMBED_COMMENT,
353 PAGINATION_COUNT_DEFAULT,
360 PRIVATE_RSA_KEY_SIZE,