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 = 115
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 SEARCHABLE_COLUMNS = {
29 VIDEOS: [ 'name', 'magnetUri', 'host', 'account', 'tags' ]
32 // Sortable columns per schema
33 const SORTABLE_COLUMNS = {
34 USERS: [ 'id', 'username', 'createdAt' ],
35 JOBS: [ 'id', 'createdAt' ],
36 VIDEO_ABUSES: [ 'id', 'createdAt' ],
37 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
38 VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ],
39 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
40 FOLLOWERS: [ 'createdAt' ],
41 FOLLOWING: [ 'createdAt' ]
44 const OAUTH_LIFETIME = {
45 ACCESS_TOKEN: 3600 * 4, // 4 hours
46 REFRESH_TOKEN: 1209600 // 2 weeks
49 // ---------------------------------------------------------------------------
53 PORT: config.get<number>('listen.port')
56 DBNAME: 'peertube' + config.get<string>('database.suffix'),
57 HOSTNAME: config.get<string>('database.hostname'),
58 PORT: config.get<number>('database.port'),
59 USERNAME: config.get<string>('database.username'),
60 PASSWORD: config.get<string>('database.password')
63 AVATARS_DIR: join(root(), config.get<string>('storage.avatars')),
64 LOG_DIR: join(root(), config.get<string>('storage.logs')),
65 VIDEOS_DIR: join(root(), config.get<string>('storage.videos')),
66 THUMBNAILS_DIR: join(root(), config.get<string>('storage.thumbnails')),
67 PREVIEWS_DIR: join(root(), config.get<string>('storage.previews')),
68 TORRENTS_DIR: join(root(), config.get<string>('storage.torrents')),
69 CACHE_DIR: join(root(), config.get<string>('storage.cache'))
72 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
73 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
74 HOSTNAME: config.get<string>('webserver.hostname'),
75 PORT: config.get<number>('webserver.port'),
80 EMAIL: config.get<string>('admin.email')
83 ENABLED: config.get<boolean>('signup.enabled'),
84 LIMIT: config.get<number>('signup.limit')
87 VIDEO_QUOTA: config.get<number>('user.video_quota')
90 ENABLED: config.get<boolean>('transcoding.enabled'),
91 THREADS: config.get<number>('transcoding.threads'),
93 '240' : config.get<boolean>('transcoding.resolutions.240p'),
94 '360': config.get<boolean>('transcoding.resolutions.360p'),
95 '480': config.get<boolean>('transcoding.resolutions.480p'),
96 '720': config.get<boolean>('transcoding.resolutions.720p'),
97 '1080': config.get<boolean>('transcoding.resolutions.1080p')
102 SIZE: config.get<number>('cache.previews.size')
106 CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
107 CONFIG.WEBSERVER.HOST = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
109 const AVATARS_DIR = {
110 ACCOUNT: join(CONFIG.STORAGE.AVATARS_DIR, 'account')
112 // ---------------------------------------------------------------------------
114 const CONSTRAINTS_FIELDS = {
116 USERNAME: { min: 3, max: 20 }, // Length
117 PASSWORD: { min: 6, max: 255 }, // Length
118 VIDEO_QUOTA: { min: -1 }
121 REASON: { min: 2, max: 300 } // Length
124 NAME: { min: 3, max: 120 }, // Length
125 DESCRIPTION: { min: 3, max: 250 }, // Length
126 URL: { min: 3, max: 2000 } // Length
129 NAME: { min: 3, max: 120 }, // Length
130 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
131 DESCRIPTION: { min: 3, max: 3000 }, // Length
132 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
133 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
134 DURATION: { min: 1 }, // Number
135 TAGS: { min: 0, max: 5 }, // Number of total tags
136 TAG: { min: 2, max: 30 }, // Length
137 THUMBNAIL: { min: 2, max: 30 },
138 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
141 DISLIKES: { min: 0 },
142 FILE_SIZE: { min: 10 },
143 URL: { min: 3, max: 2000 } // Length
146 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
147 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
148 URL: { min: 3, max: 2000 } // Length
155 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
160 const VIDEO_CATEGORIES = {
175 15: 'Science & Technology',
181 // See https://creativecommons.org/licenses/?lang=en
182 const VIDEO_LICENCES = {
184 2: 'Attribution - Share Alike',
185 3: 'Attribution - No Derivatives',
186 4: 'Attribution - Non Commercial',
187 5: 'Attribution - Non Commercial - Share Alike',
188 6: 'Attribution - Non Commercial - No Derivatives',
189 7: 'Public Domain Dedication'
192 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
193 const VIDEO_LANGUAGES = {
210 const VIDEO_PRIVACIES = {
211 [VideoPrivacy.PUBLIC]: 'Public',
212 [VideoPrivacy.UNLISTED]: 'Unlisted',
213 [VideoPrivacy.PRIVATE]: 'Private'
216 const VIDEO_MIMETYPE_EXT = {
217 'video/webm': '.webm',
222 // ---------------------------------------------------------------------------
224 const SERVER_ACCOUNT_NAME = 'peertube'
226 const ACTIVITY_PUB = {
227 POTENTIAL_ACCEPT_HEADERS: [
228 'application/activity+json',
229 'application/ld+json'
231 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
232 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
233 COLLECTION_ITEMS_PER_PAGE: 10,
234 FETCH_PAGE_LIMIT: 100,
237 VIDEO: [ 'video/mp4', 'video/webm', 'video/ogg' ], // TODO: Merge with VIDEO_MIMETYPE_EXT
238 TORRENT: [ 'application/x-bittorrent' ],
239 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
243 // ---------------------------------------------------------------------------
245 // Number of points we add/remove from a friend after a successful/bad request
246 const SERVERS_SCORE = {
253 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
258 const REMOTE_SCHEME = {
263 const JOB_STATES: { [ id: string ]: JobState } = {
265 PROCESSING: 'processing',
269 const JOB_CATEGORIES: { [ id: string ]: JobCategory } = {
270 TRANSCODING: 'transcoding',
271 ACTIVITYPUB_HTTP: 'activitypub-http'
273 // How many maximum jobs we fetch from the database per cycle
274 const JOBS_FETCH_LIMIT_PER_CYCLE = {
279 let JOBS_FETCHING_INTERVAL = 60000
281 // ---------------------------------------------------------------------------
283 const PRIVATE_RSA_KEY_SIZE = 2048
285 // Password encryption
286 const BCRYPT_SALT_SIZE = 10
288 // ---------------------------------------------------------------------------
290 // Express static paths (router)
291 const STATIC_PATHS = {
292 PREVIEWS: '/static/previews/',
293 THUMBNAILS: '/static/thumbnails/',
294 TORRENTS: '/static/torrents/',
295 WEBSEED: '/static/webseed/'
299 let STATIC_MAX_AGE = '30d'
301 // Videos thumbnail size
302 const THUMBNAILS_SIZE = {
306 const PREVIEWS_SIZE = {
316 // Sub folders of cache directory
319 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
323 const ACCEPT_HEADERS = ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS.concat('html', 'application/json')
325 // ---------------------------------------------------------------------------
327 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
329 // ---------------------------------------------------------------------------
331 // Special constants for a test instance
332 if (isTestInstance() === true) {
333 SERVERS_SCORE.BASE = 20
334 JOBS_FETCHING_INTERVAL = 1000
335 REMOTE_SCHEME.HTTP = 'http'
336 REMOTE_SCHEME.WS = 'ws'
338 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
341 // ---------------------------------------------------------------------------
352 JOBS_FETCH_LIMIT_PER_CYCLE,
353 JOBS_FETCHING_INTERVAL,
355 LAST_MIGRATION_VERSION,
357 OPENGRAPH_AND_OEMBED_COMMENT,
358 PAGINATION_COUNT_DEFAULT,
366 PRIVATE_RSA_KEY_SIZE,