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/actors'
5 import { ActivityPubActorType } from '../../shared/models/activitypub'
6 import { VideoPrivacy } from '../../shared/models/videos'
7 // Do not use barrels, remain constants as independent as possible
8 import { isTestInstance, root } from '../helpers/core-utils'
10 // ---------------------------------------------------------------------------
12 const LAST_MIGRATION_VERSION = 135
14 // ---------------------------------------------------------------------------
17 const API_VERSION = 'v1'
19 // Number of results by default for the pagination
20 const PAGINATION_COUNT_DEFAULT = 15
22 // Sortable columns per schema
23 const SORTABLE_COLUMNS = {
24 USERS: [ 'id', 'username', 'createdAt' ],
25 JOBS: [ 'id', 'createdAt' ],
26 VIDEO_ABUSES: [ 'id', 'createdAt' ],
27 VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
28 VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ],
29 BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
30 FOLLOWERS: [ 'createdAt' ],
31 FOLLOWING: [ 'createdAt' ]
34 const OAUTH_LIFETIME = {
35 ACCESS_TOKEN: 3600 * 4, // 4 hours
36 REFRESH_TOKEN: 1209600 // 2 weeks
39 // ---------------------------------------------------------------------------
43 PORT: config.get<number>('listen.port')
46 DBNAME: 'peertube' + config.get<string>('database.suffix'),
47 HOSTNAME: config.get<string>('database.hostname'),
48 PORT: config.get<number>('database.port'),
49 USERNAME: config.get<string>('database.username'),
50 PASSWORD: config.get<string>('database.password')
53 AVATARS_DIR: join(root(), config.get<string>('storage.avatars')),
54 LOG_DIR: join(root(), config.get<string>('storage.logs')),
55 VIDEOS_DIR: join(root(), config.get<string>('storage.videos')),
56 THUMBNAILS_DIR: join(root(), config.get<string>('storage.thumbnails')),
57 PREVIEWS_DIR: join(root(), config.get<string>('storage.previews')),
58 TORRENTS_DIR: join(root(), config.get<string>('storage.torrents')),
59 CACHE_DIR: join(root(), config.get<string>('storage.cache'))
62 SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
63 WS: config.get<boolean>('webserver.https') === true ? 'wss' : 'ws',
64 HOSTNAME: config.get<string>('webserver.hostname'),
65 PORT: config.get<number>('webserver.port'),
70 EMAIL: config.get<string>('admin.email')
73 ENABLED: config.get<boolean>('signup.enabled'),
74 LIMIT: config.get<number>('signup.limit')
77 VIDEO_QUOTA: config.get<number>('user.video_quota')
80 ENABLED: config.get<boolean>('transcoding.enabled'),
81 THREADS: config.get<number>('transcoding.threads'),
83 '240' : config.get<boolean>('transcoding.resolutions.240p'),
84 '360': config.get<boolean>('transcoding.resolutions.360p'),
85 '480': config.get<boolean>('transcoding.resolutions.480p'),
86 '720': config.get<boolean>('transcoding.resolutions.720p'),
87 '1080': config.get<boolean>('transcoding.resolutions.1080p')
92 SIZE: config.get<number>('cache.previews.size')
96 CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
97 CONFIG.WEBSERVER.HOST = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
100 ACCOUNT: join(CONFIG.STORAGE.AVATARS_DIR, 'account')
102 // ---------------------------------------------------------------------------
104 const CONSTRAINTS_FIELDS = {
106 USERNAME: { min: 3, max: 20 }, // Length
107 PASSWORD: { min: 6, max: 255 }, // Length
108 VIDEO_QUOTA: { min: -1 }
111 REASON: { min: 2, max: 300 } // Length
114 NAME: { min: 3, max: 120 }, // Length
115 DESCRIPTION: { min: 3, max: 250 }, // Length
116 URL: { min: 3, max: 2000 } // Length
119 NAME: { min: 3, max: 120 }, // Length
120 TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
121 DESCRIPTION: { min: 3, max: 3000 }, // Length
122 EXTNAME: [ '.mp4', '.ogv', '.webm' ],
123 INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
124 DURATION: { min: 1 }, // Number
125 TAGS: { min: 0, max: 5 }, // Number of total tags
126 TAG: { min: 2, max: 30 }, // Length
127 THUMBNAIL: { min: 2, max: 30 },
128 THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
131 DISLIKES: { min: 0 },
132 FILE_SIZE: { min: 10 },
133 URL: { min: 3, max: 2000 } // Length
136 PUBLIC_KEY: { min: 10, max: 5000 }, // Length
137 PRIVATE_KEY: { min: 10, max: 5000 }, // Length
138 URL: { min: 3, max: 2000 } // Length
145 const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
150 const VIDEO_CATEGORIES = {
165 15: 'Science & Technology',
171 // See https://creativecommons.org/licenses/?lang=en
172 const VIDEO_LICENCES = {
174 2: 'Attribution - Share Alike',
175 3: 'Attribution - No Derivatives',
176 4: 'Attribution - Non Commercial',
177 5: 'Attribution - Non Commercial - Share Alike',
178 6: 'Attribution - Non Commercial - No Derivatives',
179 7: 'Public Domain Dedication'
182 // See https://en.wikipedia.org/wiki/List_of_languages_by_number_of_native_speakers#Nationalencyklopedin
183 const VIDEO_LANGUAGES = {
200 const VIDEO_PRIVACIES = {
201 [VideoPrivacy.PUBLIC]: 'Public',
202 [VideoPrivacy.UNLISTED]: 'Unlisted',
203 [VideoPrivacy.PRIVATE]: 'Private'
206 const VIDEO_MIMETYPE_EXT = {
207 'video/webm': '.webm',
212 // ---------------------------------------------------------------------------
214 const SERVER_ACTOR_NAME = 'peertube'
216 const ACTIVITY_PUB = {
217 POTENTIAL_ACCEPT_HEADERS: [
218 'application/activity+json',
219 'application/ld+json'
221 ACCEPT_HEADER: 'application/activity+json, application/ld+json',
222 PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
223 COLLECTION_ITEMS_PER_PAGE: 10,
224 FETCH_PAGE_LIMIT: 100,
227 VIDEO: [ 'video/mp4', 'video/webm', 'video/ogg' ], // TODO: Merge with VIDEO_MIMETYPE_EXT
228 TORRENT: [ 'application/x-bittorrent' ],
229 MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
233 const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
236 APPLICATION: 'Application'
239 // ---------------------------------------------------------------------------
241 // Number of points we add/remove from a friend after a successful/bad request
242 const SERVERS_SCORE = {
249 const FOLLOW_STATES: { [ id: string ]: FollowState } = {
254 const REMOTE_SCHEME = {
259 const JOB_STATES: { [ id: string ]: JobState } = {
261 PROCESSING: 'processing',
265 const JOB_CATEGORIES: { [ id: string ]: JobCategory } = {
266 TRANSCODING: 'transcoding',
267 ACTIVITYPUB_HTTP: 'activitypub-http'
269 // How many maximum jobs we fetch from the database per cycle
270 const JOBS_FETCH_LIMIT_PER_CYCLE = {
275 let JOBS_FETCHING_INTERVAL = 60000
277 // ---------------------------------------------------------------------------
279 const PRIVATE_RSA_KEY_SIZE = 2048
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 = {
302 const PREVIEWS_SIZE = {
312 // Sub folders of cache directory
315 PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
319 const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
321 // ---------------------------------------------------------------------------
323 const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
325 // ---------------------------------------------------------------------------
327 // Special constants for a test instance
328 if (isTestInstance() === true) {
329 SERVERS_SCORE.BASE = 20
330 JOBS_FETCHING_INTERVAL = 1000
331 REMOTE_SCHEME.HTTP = 'http'
332 REMOTE_SCHEME.WS = 'ws'
334 ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
337 // ---------------------------------------------------------------------------
348 JOBS_FETCH_LIMIT_PER_CYCLE,
349 JOBS_FETCHING_INTERVAL,
351 LAST_MIGRATION_VERSION,
353 OPENGRAPH_AND_OEMBED_COMMENT,
354 PAGINATION_COUNT_DEFAULT,
361 PRIVATE_RSA_KEY_SIZE,
366 ACTIVITY_PUB_ACTOR_TYPES,