1 import * as config from 'config'
2 import { join } from 'path'
3 import { JobCategory, JobState, VideoRateType } from '../../shared/models'
4 import { FollowState } from '../../shared/models/accounts'
5 import { VideoPrivacy } from '../../shared/models/videos'
6 // Do not use barrels, remain constants as independent as possible
7 import { isTestInstance, root } from '../helpers/core-utils'
9 // ---------------------------------------------------------------------------
11 const LAST_MIGRATION_VERSION = 120
13 // ---------------------------------------------------------------------------
16 const API_VERSION = 'v1'
18 // Number of results by default for the pagination
19 const PAGINATION_COUNT_DEFAULT = 15
21 // Sortable columns per schema
22 const SORTABLE_COLUMNS = {
23 USERS: [ 'id', 'username', 'createdAt' ],
24 JOBS: [ 'id', 'createdAt' ],
25 VIDEO_ABUSES: [ 'id', 'createdAt' ],
26 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
27 VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ],
28 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
29 FOLLOWERS: [ 'createdAt' ],
30 FOLLOWING: [ 'createdAt' ]
33 const OAUTH_LIFETIME = {
34 ACCESS_TOKEN: 3600 * 4, // 4 hours
35 REFRESH_TOKEN: 1209600 // 2 weeks
38 // ---------------------------------------------------------------------------
42 PORT: config.get<number>('listen.port')
45 DBNAME: 'peertube' + config.get<string>('database.suffix'),
46 HOSTNAME: config.get<string>('database.hostname'),
47 PORT: config.get<number>('database.port'),
48 USERNAME: config.get<string>('database.username'),
49 PASSWORD: config.get<string>('database.password')
52 AVATARS_DIR: join(root(), config.get<string>('storage.avatars')),
53 LOG_DIR: join(root(), config.get<string>('storage.logs')),
54 VIDEOS_DIR: join(root(), config.get<string>('storage.videos')),
55 THUMBNAILS_DIR: join(root(), config.get<string>('storage.thumbnails')),
56 PREVIEWS_DIR: join(root(), config.get<string>('storage.previews')),
57 TORRENTS_DIR: join(root(), config.get<string>('storage.torrents')),
58 CACHE_DIR: join(root(), config.get<string>('storage.cache'))
61 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
62 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
63 HOSTNAME: config.get<string>('webserver.hostname'),
64 PORT: config.get<number>('webserver.port'),
69 EMAIL: config.get<string>('admin.email')
72 ENABLED: config.get<boolean>('signup.enabled'),
73 LIMIT: config.get<number>('signup.limit')
76 VIDEO_QUOTA: config.get<number>('user.video_quota')
79 ENABLED: config.get<boolean>('transcoding.enabled'),
80 THREADS: config.get<number>('transcoding.threads'),
82 '240' : config.get<boolean>('transcoding.resolutions.240p'),
83 '360': config.get<boolean>('transcoding.resolutions.360p'),
84 '480': config.get<boolean>('transcoding.resolutions.480p'),
85 '720': config.get<boolean>('transcoding.resolutions.720p'),
86 '1080': config.get<boolean>('transcoding.resolutions.1080p')
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
99 ACCOUNT: join(CONFIG.STORAGE.AVATARS_DIR, 'account')
101 // ---------------------------------------------------------------------------
103 const CONSTRAINTS_FIELDS = {
105 USERNAME: { min: 3, max: 20 }, // Length
106 PASSWORD: { min: 6, max: 255 }, // Length
107 VIDEO_QUOTA: { min: -1 }
110 REASON: { min: 2, max: 300 } // Length
113 NAME: { min: 3, max: 120 }, // Length
114 DESCRIPTION: { min: 3, max: 250 }, // Length
115 URL: { min: 3, max: 2000 } // Length
118 NAME: { min: 3, max: 120 }, // Length
119 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
120 DESCRIPTION: { min: 3, max: 3000 }, // 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 }, // Number
124 TAGS: { min: 0, max: 5 }, // Number of total tags
125 TAG: { min: 2, max: 30 }, // Length
126 THUMBNAIL: { min: 2, max: 30 },
127 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
130 DISLIKES: { min: 0 },
131 FILE_SIZE: { min: 10 },
132 URL: { min: 3, max: 2000 } // Length
135 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
136 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
137 URL: { min: 3, max: 2000 } // Length
144 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
149 const VIDEO_CATEGORIES = {
164 15: 'Science & Technology',
170 // See https://creativecommons.org/licenses/?lang=en
171 const VIDEO_LICENCES = {
173 2: 'Attribution - Share Alike',
174 3: 'Attribution - No Derivatives',
175 4: 'Attribution - Non Commercial',
176 5: 'Attribution - Non Commercial - Share Alike',
177 6: 'Attribution - Non Commercial - No Derivatives',
178 7: 'Public Domain Dedication'
181 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
182 const VIDEO_LANGUAGES = {
199 const VIDEO_PRIVACIES = {
200 [VideoPrivacy.PUBLIC]: 'Public',
201 [VideoPrivacy.UNLISTED]: 'Unlisted',
202 [VideoPrivacy.PRIVATE]: 'Private'
205 const VIDEO_MIMETYPE_EXT = {
206 'video/webm': '.webm',
211 // ---------------------------------------------------------------------------
213 const SERVER_ACCOUNT_NAME = 'peertube'
215 const ACTIVITY_PUB = {
216 POTENTIAL_ACCEPT_HEADERS: [
217 'application/activity+json',
218 'application/ld+json'
220 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
221 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
222 COLLECTION_ITEMS_PER_PAGE: 10,
223 FETCH_PAGE_LIMIT: 100,
226 VIDEO: [ 'video/mp4', 'video/webm', 'video/ogg' ], // TODO: Merge with VIDEO_MIMETYPE_EXT
227 TORRENT: [ 'application/x-bittorrent' ],
228 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
232 // ---------------------------------------------------------------------------
234 // Number of points we add/remove from a friend after a successful/bad request
235 const SERVERS_SCORE = {
242 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
247 const REMOTE_SCHEME = {
252 const JOB_STATES: { [ id: string ]: JobState } = {
254 PROCESSING: 'processing',
258 const JOB_CATEGORIES: { [ id: string ]: JobCategory } = {
259 TRANSCODING: 'transcoding',
260 ACTIVITYPUB_HTTP: 'activitypub-http'
262 // How many maximum jobs we fetch from the database per cycle
263 const JOBS_FETCH_LIMIT_PER_CYCLE = {
268 let JOBS_FETCHING_INTERVAL = 60000
270 // ---------------------------------------------------------------------------
272 const PRIVATE_RSA_KEY_SIZE = 2048
274 // Password encryption
275 const BCRYPT_SALT_SIZE = 10
277 // ---------------------------------------------------------------------------
279 // Express static paths (router)
280 const STATIC_PATHS = {
281 PREVIEWS: '/static/previews/',
282 THUMBNAILS: '/static/thumbnails/',
283 TORRENTS: '/static/torrents/',
284 WEBSEED: '/static/webseed/'
288 let STATIC_MAX_AGE = '30d'
290 // Videos thumbnail size
291 const THUMBNAILS_SIZE = {
295 const PREVIEWS_SIZE = {
305 // Sub folders of cache directory
308 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
312 const ACCEPT_HEADERS = ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS.concat('html', 'application/json')
314 // ---------------------------------------------------------------------------
316 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
318 // ---------------------------------------------------------------------------
320 // Special constants for a test instance
321 if (isTestInstance() === true) {
322 SERVERS_SCORE.BASE = 20
323 JOBS_FETCHING_INTERVAL = 1000
324 REMOTE_SCHEME.HTTP = 'http'
325 REMOTE_SCHEME.WS = 'ws'
327 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
330 // ---------------------------------------------------------------------------
341 JOBS_FETCH_LIMIT_PER_CYCLE,
342 JOBS_FETCHING_INTERVAL,
344 LAST_MIGRATION_VERSION,
346 OPENGRAPH_AND_OEMBED_COMMENT,
347 PAGINATION_COUNT_DEFAULT,
354 PRIVATE_RSA_KEY_SIZE,