-import config = require('config')
-import { join } from 'path'
+import { IConfig } from 'config'
+import { dirname, join } from 'path'
+import { JobType, VideoRateType } from '../../shared/models'
+import { ActivityPubActorType } from '../../shared/models/activitypub'
+import { FollowState } from '../../shared/models/actors'
+import { VideoPrivacy } from '../../shared/models/videos'
+// Do not use barrels, remain constants as independent as possible
+import { buildPath, isTestInstance, root, sanitizeHost, sanitizeUrl } from '../helpers/core-utils'
+
+// Use a variable to reload the configuration if we need
+let config: IConfig = require('config')
// ---------------------------------------------------------------------------
-const LAST_MIGRATION_VERSION = 50
+const LAST_MIGRATION_VERSION = 195
// ---------------------------------------------------------------------------
// Number of results by default for the pagination
const PAGINATION_COUNT_DEFAULT = 15
-// Sortable columns per schema
-const SEARCHABLE_COLUMNS = {
- VIDEOS: [ 'name', 'magnetUri', 'host', 'author', 'tags' ]
-}
-
// Sortable columns per schema
const SORTABLE_COLUMNS = {
USERS: [ 'id', 'username', 'createdAt' ],
+ ACCOUNTS: [ 'createdAt' ],
+ JOBS: [ 'createdAt' ],
VIDEO_ABUSES: [ 'id', 'createdAt' ],
- VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ]
+ VIDEO_CHANNELS: [ 'id', 'name', 'updatedAt', 'createdAt' ],
+ VIDEOS: [ 'name', 'duration', 'createdAt', 'views', 'likes' ],
+ VIDEO_COMMENT_THREADS: [ 'createdAt' ],
+ BLACKLISTS: [ 'id', 'name', 'duration', 'views', 'likes', 'dislikes', 'uuid', 'createdAt' ],
+ FOLLOWERS: [ 'createdAt' ],
+ FOLLOWING: [ 'createdAt' ]
}
const OAUTH_LIFETIME = {
// ---------------------------------------------------------------------------
+// Number of points we add/remove after a successful/bad request
+const ACTOR_FOLLOW_SCORE = {
+ PENALTY: -10,
+ BONUS: 10,
+ BASE: 1000,
+ MAX: 10000
+}
+
+const FOLLOW_STATES: { [ id: string ]: FollowState } = {
+ PENDING: 'pending',
+ ACCEPTED: 'accepted'
+}
+
+const REMOTE_SCHEME = {
+ HTTP: 'https',
+ WS: 'wss'
+}
+
+const JOB_ATTEMPTS: { [ id in JobType ]: number } = {
+ 'activitypub-http-broadcast': 5,
+ 'activitypub-http-unicast': 5,
+ 'activitypub-http-fetcher': 5,
+ 'video-file': 1,
+ 'email': 5
+}
+const JOB_CONCURRENCY: { [ id in JobType ]: number } = {
+ 'activitypub-http-broadcast': 1,
+ 'activitypub-http-unicast': 5,
+ 'activitypub-http-fetcher': 1,
+ 'video-file': 1,
+ 'email': 5
+}
+// 2 days
+const JOB_COMPLETED_LIFETIME = 60000 * 60 * 24 * 2
+
+// 1 hour
+let SCHEDULER_INTERVAL = 60000 * 60
+
+// ---------------------------------------------------------------------------
+
const CONFIG = {
+ CUSTOM_FILE: getLocalConfigFilePath(),
LISTEN: {
PORT: config.get<number>('listen.port')
},
USERNAME: config.get<string>('database.username'),
PASSWORD: config.get<string>('database.password')
},
+ REDIS: {
+ HOSTNAME: config.get<string>('redis.hostname'),
+ PORT: config.get<number>('redis.port'),
+ AUTH: config.get<string>('redis.auth')
+ },
+ SMTP: {
+ HOSTNAME: config.get<string>('smtp.hostname'),
+ PORT: config.get<number>('smtp.port'),
+ USERNAME: config.get<string>('smtp.username'),
+ PASSWORD: config.get<string>('smtp.password'),
+ TLS: config.get<boolean>('smtp.tls'),
+ CA_FILE: config.get<string>('smtp.ca_file'),
+ FROM_ADDRESS: config.get<string>('smtp.from_address')
+ },
STORAGE: {
- CERT_DIR: join(__dirname, '..', '..', config.get<string>('storage.certs')),
- LOG_DIR: join(__dirname, '..', '..', config.get<string>('storage.logs')),
- VIDEOS_DIR: join(__dirname, '..', '..', config.get<string>('storage.videos')),
- THUMBNAILS_DIR: join(__dirname, '..', '..', config.get<string>('storage.thumbnails')),
- PREVIEWS_DIR: join(__dirname, '..', '..', config.get<string>('storage.previews')),
- TORRENTS_DIR: join(__dirname, '..', '..', config.get<string>('storage.torrents'))
+ AVATARS_DIR: buildPath(config.get<string>('storage.avatars')),
+ LOG_DIR: buildPath(config.get<string>('storage.logs')),
+ VIDEOS_DIR: buildPath(config.get<string>('storage.videos')),
+ THUMBNAILS_DIR: buildPath(config.get<string>('storage.thumbnails')),
+ PREVIEWS_DIR: buildPath(config.get<string>('storage.previews')),
+ TORRENTS_DIR: buildPath(config.get<string>('storage.torrents')),
+ CACHE_DIR: buildPath(config.get<string>('storage.cache'))
},
WEBSERVER: {
SCHEME: config.get<boolean>('webserver.https') === true ? 'https' : 'http',
URL: '',
HOST: ''
},
+ LOG: {
+ LEVEL: config.get<string>('log.level')
+ },
ADMIN: {
- EMAIL: config.get<string>('admin.email')
+ get EMAIL () { return config.get<string>('admin.email') }
},
SIGNUP: {
- ENABLED: config.get<boolean>('signup.enabled')
+ get ENABLED () { return config.get<boolean>('signup.enabled') },
+ get LIMIT () { return config.get<number>('signup.limit') }
+ },
+ USER: {
+ get VIDEO_QUOTA () { return config.get<number>('user.video_quota') }
},
TRANSCODING: {
- ENABLED: config.get<boolean>('transcoding.enabled'),
- THREADS: config.get<number>('transcoding.threads')
+ get ENABLED () { return config.get<boolean>('transcoding.enabled') },
+ get THREADS () { return config.get<number>('transcoding.threads') },
+ RESOLUTIONS: {
+ get '240p' () { return config.get<boolean>('transcoding.resolutions.240p') },
+ get '360p' () { return config.get<boolean>('transcoding.resolutions.360p') },
+ get '480p' () { return config.get<boolean>('transcoding.resolutions.480p') },
+ get '720p' () { return config.get<boolean>('transcoding.resolutions.720p') },
+ get '1080p' () { return config.get<boolean>('transcoding.resolutions.1080p') }
+ }
+ },
+ CACHE: {
+ PREVIEWS: {
+ get SIZE () { return config.get<number>('cache.previews.size') }
+ }
+ },
+ INSTANCE: {
+ get NAME () { return config.get<string>('instance.name') },
+ get DESCRIPTION () { return config.get<string>('instance.description') },
+ get TERMS () { return config.get<string>('instance.terms') },
+ get DEFAULT_CLIENT_ROUTE () { return config.get<string>('instance.default_client_route') },
+ CUSTOMIZATIONS: {
+ get JAVASCRIPT () { return config.get<string>('instance.customizations.javascript') },
+ get CSS () { return config.get<string>('instance.customizations.css') }
+ }
}
}
-CONFIG.WEBSERVER.URL = CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
-CONFIG.WEBSERVER.HOST = CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT
// ---------------------------------------------------------------------------
const CONSTRAINTS_FIELDS = {
USERS: {
USERNAME: { min: 3, max: 20 }, // Length
- PASSWORD: { min: 6, max: 255 } // Length
+ PASSWORD: { min: 6, max: 255 }, // Length
+ DESCRIPTION: { min: 3, max: 250 }, // Length
+ VIDEO_QUOTA: { min: -1 }
},
VIDEO_ABUSES: {
REASON: { min: 2, max: 300 } // Length
},
- VIDEOS: {
- NAME: { min: 3, max: 50 }, // Length
+ VIDEO_CHANNELS: {
+ NAME: { min: 3, max: 120 }, // Length
DESCRIPTION: { min: 3, max: 250 }, // Length
+ SUPPORT: { min: 3, max: 300 }, // Length
+ URL: { min: 3, max: 2000 } // Length
+ },
+ VIDEOS: {
+ NAME: { min: 3, max: 120 }, // Length
+ TRUNCATED_DESCRIPTION: { min: 3, max: 250 }, // Length
+ DESCRIPTION: { min: 3, max: 10000 }, // Length
+ SUPPORT: { min: 3, max: 300 }, // Length
+ IMAGE: {
+ EXTNAME: [ '.jpg', '.jpeg' ],
+ FILE_SIZE: {
+ max: 2 * 1024 * 1024 // 2MB
+ }
+ },
EXTNAME: [ '.mp4', '.ogv', '.webm' ],
- INFO_HASH: { min: 40, max: 40 }, // Length, infohash is 20 bytes length but we represent it in hexa so 20 * 2
- DURATION: { min: 1, max: 7200 }, // Number
- TAGS: { min: 0, max: 3 }, // Number of total tags
- TAG: { min: 2, max: 10 }, // Length
+ INFO_HASH: { min: 40, max: 40 }, // Length, info hash is 20 bytes length but we represent it in hexadecimal so 20 * 2
+ DURATION: { min: 1 }, // Number
+ TAGS: { min: 0, max: 5 }, // Number of total tags
+ TAG: { min: 2, max: 30 }, // Length
THUMBNAIL: { min: 2, max: 30 },
THUMBNAIL_DATA: { min: 0, max: 20000 }, // Bytes
VIEWS: { min: 0 },
LIKES: { min: 0 },
- DISLIKES: { min: 0 }
+ DISLIKES: { min: 0 },
+ FILE_SIZE: { min: 10 },
+ URL: { min: 3, max: 2000 } // Length
+ },
+ ACTORS: {
+ PUBLIC_KEY: { min: 10, max: 5000 }, // Length
+ PRIVATE_KEY: { min: 10, max: 5000 }, // Length
+ URL: { min: 3, max: 2000 }, // Length
+ AVATAR: {
+ EXTNAME: [ '.png', '.jpeg', '.jpg' ],
+ FILE_SIZE: {
+ max: 2 * 1024 * 1024 // 2MB
+ }
+ }
},
VIDEO_EVENTS: {
COUNT: { min: 0 }
+ },
+ VIDEO_COMMENTS: {
+ TEXT: { min: 2, max: 3000 }, // Length
+ URL: { min: 3, max: 2000 } // Length
+ },
+ VIDEO_SHARE: {
+ URL: { min: 3, max: 2000 } // Length
}
}
-const VIDEO_RATE_TYPES = {
+let VIDEO_VIEW_LIFETIME = 60000 * 60 // 1 hour
+const MAX_VIDEO_TRANSCODING_FPS = 30
+
+const VIDEO_RATE_TYPES: { [ id: string ]: VideoRateType } = {
LIKE: 'like',
DISLIKE: 'dislike'
}
9: 'Comedy',
10: 'Entertainment',
11: 'News',
- 12: 'Howto',
+ 12: 'How To',
13: 'Education',
14: 'Activism',
15: 'Science & Technology',
11: 'German',
12: 'Korean',
13: 'French',
- 14: 'Italien'
+ 14: 'Italian'
}
-// ---------------------------------------------------------------------------
-
-// Score a pod has when we create it as a friend
-const FRIEND_SCORE = {
- BASE: 100,
- MAX: 1000
+const VIDEO_PRIVACIES = {
+ [VideoPrivacy.PUBLIC]: 'Public',
+ [VideoPrivacy.UNLISTED]: 'Unlisted',
+ [VideoPrivacy.PRIVATE]: 'Private'
}
-// ---------------------------------------------------------------------------
-
-// Number of points we add/remove from a friend after a successful/bad request
-const PODS_SCORE = {
- MALUS: -10,
- BONUS: 10
+const VIDEO_MIMETYPE_EXT = {
+ 'video/webm': '.webm',
+ 'video/ogg': '.ogv',
+ 'video/mp4': '.mp4'
}
-// Time to wait between requests to the friends (10 min)
-let REQUESTS_INTERVAL = 600000
-
-// Number of requests in parallel we can make
-const REQUESTS_IN_PARALLEL = 10
-
-// To how many pods we send requests
-const REQUESTS_LIMIT_PODS = 10
-// How many requests we send to a pod per interval
-const REQUESTS_LIMIT_PER_POD = 5
-
-const REQUESTS_VIDEO_QADU_LIMIT_PODS = 10
-// The QADU requests are not big
-const REQUESTS_VIDEO_QADU_LIMIT_PER_POD = 50
-
-const REQUESTS_VIDEO_EVENT_LIMIT_PODS = 10
-// The EVENTS requests are not big
-const REQUESTS_VIDEO_EVENT_LIMIT_PER_POD = 50
-
-// Number of requests to retry for replay requests module
-const RETRY_REQUESTS = 5
-
-const REQUEST_ENDPOINTS = {
- VIDEOS: 'videos'
-}
-
-const REQUEST_ENDPOINT_ACTIONS = {}
-REQUEST_ENDPOINT_ACTIONS[REQUEST_ENDPOINTS.VIDEOS] = {
- ADD: 'add',
- UPDATE: 'update',
- REMOVE: 'remove',
- REPORT_ABUSE: 'report-abuse'
-}
-
-const REQUEST_VIDEO_QADU_ENDPOINT = 'videos/qadu'
-const REQUEST_VIDEO_EVENT_ENDPOINT = 'videos/events'
-
-const REQUEST_VIDEO_QADU_TYPES = {
- LIKES: 'likes',
- DISLIKES: 'dislikes',
- VIEWS: 'views'
+const IMAGE_MIMETYPE_EXT = {
+ 'image/png': '.png',
+ 'image/jpg': '.jpg',
+ 'image/jpeg': '.jpg'
}
-const REQUEST_VIDEO_EVENT_TYPES = {
- LIKES: 'likes',
- DISLIKES: 'dislikes',
- VIEWS: 'views'
-}
+// ---------------------------------------------------------------------------
-const REMOTE_SCHEME = {
- HTTP: 'https',
- WS: 'wss'
+const SERVER_ACTOR_NAME = 'peertube'
+
+const ACTIVITY_PUB = {
+ POTENTIAL_ACCEPT_HEADERS: [
+ 'application/activity+json',
+ 'application/ld+json',
+ 'application/ld+json; profile="https://www.w3.org/ns/activitystreams"'
+ ],
+ ACCEPT_HEADER: 'application/activity+json, application/ld+json',
+ PUBLIC: 'https://www.w3.org/ns/activitystreams#Public',
+ COLLECTION_ITEMS_PER_PAGE: 10,
+ FETCH_PAGE_LIMIT: 100,
+ URL_MIME_TYPES: {
+ VIDEO: Object.keys(VIDEO_MIMETYPE_EXT),
+ TORRENT: [ 'application/x-bittorrent' ],
+ MAGNET: [ 'application/x-bittorrent;x-scheme-handler/magnet' ]
+ },
+ MAX_RECURSION_COMMENTS: 100,
+ ACTOR_REFRESH_INTERVAL: 3600 * 24 * 1000 // 1 day
}
-const JOB_STATES = {
- PENDING: 'pending',
- PROCESSING: 'processing',
- ERROR: 'error',
- SUCCESS: 'success'
+const ACTIVITY_PUB_ACTOR_TYPES: { [ id: string ]: ActivityPubActorType } = {
+ GROUP: 'Group',
+ PERSON: 'Person',
+ APPLICATION: 'Application'
}
-// How many maximum jobs we fetch from the database per cycle
-const JOBS_FETCH_LIMIT_PER_CYCLE = 10
-const JOBS_CONCURRENCY = 1
-// 1 minutes
-let JOBS_FETCHING_INTERVAL = 60000
// ---------------------------------------------------------------------------
-const PRIVATE_CERT_NAME = 'peertube.key.pem'
-const PUBLIC_CERT_NAME = 'peertube.pub'
-const SIGNATURE_ALGORITHM = 'RSA-SHA256'
-const SIGNATURE_ENCODING = 'hex'
+const PRIVATE_RSA_KEY_SIZE = 2048
// Password encryption
const BCRYPT_SALT_SIZE = 10
+const USER_PASSWORD_RESET_LIFETIME = 60000 * 5 // 5 minutes
+
// ---------------------------------------------------------------------------
// Express static paths (router)
PREVIEWS: '/static/previews/',
THUMBNAILS: '/static/thumbnails/',
TORRENTS: '/static/torrents/',
- WEBSEED: '/static/webseed/'
+ WEBSEED: '/static/webseed/',
+ AVATARS: '/static/avatars/'
}
// Cache control
let STATIC_MAX_AGE = '30d'
// Videos thumbnail size
-const THUMBNAILS_SIZE = '200x110'
-const PREVIEWS_SIZE = '640x480'
+const THUMBNAILS_SIZE = {
+ width: 200,
+ height: 110
+}
+const PREVIEWS_SIZE = {
+ width: 560,
+ height: 315
+}
+const AVATARS_SIZE = {
+ width: 120,
+ height: 120
+}
-// ---------------------------------------------------------------------------
+const EMBED_SIZE = {
+ width: 560,
+ height: 315
+}
-const USER_ROLES = {
- ADMIN: 'admin',
- USER: 'user'
+// Sub folders of cache directory
+const CACHE = {
+ DIRECTORIES: {
+ PREVIEWS: join(CONFIG.STORAGE.CACHE_DIR, 'previews')
+ }
}
+const ACCEPT_HEADERS = [ 'html', 'application/json' ].concat(ACTIVITY_PUB.POTENTIAL_ACCEPT_HEADERS)
+
+// ---------------------------------------------------------------------------
+
+const OPENGRAPH_AND_OEMBED_COMMENT = '<!-- open graph and oembed tags -->'
+
// ---------------------------------------------------------------------------
// Special constants for a test instance
if (isTestInstance() === true) {
- CONSTRAINTS_FIELDS.VIDEOS.DURATION.max = 14
- FRIEND_SCORE.BASE = 20
- REQUESTS_INTERVAL = 10000
- JOBS_FETCHING_INTERVAL = 10000
+ ACTOR_FOLLOW_SCORE.BASE = 20
REMOTE_SCHEME.HTTP = 'http'
REMOTE_SCHEME.WS = 'ws'
STATIC_MAX_AGE = '0'
+ ACTIVITY_PUB.COLLECTION_ITEMS_PER_PAGE = 2
+ ACTIVITY_PUB.ACTOR_REFRESH_INTERVAL = 10 * 1000 // 10 seconds
+ CONSTRAINTS_FIELDS.ACTORS.AVATAR.FILE_SIZE.max = 100 * 1024 // 100KB
+ SCHEDULER_INTERVAL = 10000
+ VIDEO_VIEW_LIFETIME = 1000 // 1 second
}
+updateWebserverConfig()
+
// ---------------------------------------------------------------------------
export {
API_VERSION,
+ AVATARS_SIZE,
+ ACCEPT_HEADERS,
BCRYPT_SALT_SIZE,
+ CACHE,
CONFIG,
CONSTRAINTS_FIELDS,
- FRIEND_SCORE,
- JOBS_FETCHING_INTERVAL,
- JOB_STATES,
- JOBS_CONCURRENCY,
- JOBS_FETCH_LIMIT_PER_CYCLE,
+ EMBED_SIZE,
+ JOB_CONCURRENCY,
+ JOB_ATTEMPTS,
LAST_MIGRATION_VERSION,
OAUTH_LIFETIME,
+ OPENGRAPH_AND_OEMBED_COMMENT,
PAGINATION_COUNT_DEFAULT,
- PODS_SCORE,
+ ACTOR_FOLLOW_SCORE,
PREVIEWS_SIZE,
- PRIVATE_CERT_NAME,
- PUBLIC_CERT_NAME,
REMOTE_SCHEME,
- REQUEST_ENDPOINT_ACTIONS,
- REQUEST_ENDPOINTS,
- REQUEST_VIDEO_EVENT_ENDPOINT,
- REQUEST_VIDEO_EVENT_TYPES,
- REQUEST_VIDEO_QADU_ENDPOINT,
- REQUEST_VIDEO_QADU_TYPES,
- REQUESTS_IN_PARALLEL,
- REQUESTS_INTERVAL,
- REQUESTS_LIMIT_PER_POD,
- REQUESTS_LIMIT_PODS,
- REQUESTS_VIDEO_EVENT_LIMIT_PER_POD,
- REQUESTS_VIDEO_EVENT_LIMIT_PODS,
- REQUESTS_VIDEO_QADU_LIMIT_PER_POD,
- REQUESTS_VIDEO_QADU_LIMIT_PODS,
- RETRY_REQUESTS,
- SEARCHABLE_COLUMNS,
- SIGNATURE_ALGORITHM,
- SIGNATURE_ENCODING,
+ FOLLOW_STATES,
+ SERVER_ACTOR_NAME,
+ PRIVATE_RSA_KEY_SIZE,
SORTABLE_COLUMNS,
STATIC_MAX_AGE,
STATIC_PATHS,
+ ACTIVITY_PUB,
+ ACTIVITY_PUB_ACTOR_TYPES,
THUMBNAILS_SIZE,
- USER_ROLES,
VIDEO_CATEGORIES,
VIDEO_LANGUAGES,
+ VIDEO_PRIVACIES,
VIDEO_LICENCES,
- VIDEO_RATE_TYPES
+ VIDEO_RATE_TYPES,
+ VIDEO_MIMETYPE_EXT,
+ MAX_VIDEO_TRANSCODING_FPS,
+ USER_PASSWORD_RESET_LIFETIME,
+ IMAGE_MIMETYPE_EXT,
+ SCHEDULER_INTERVAL,
+ JOB_COMPLETED_LIFETIME,
+ VIDEO_VIEW_LIFETIME
}
// ---------------------------------------------------------------------------
-// This method exists in utils module but we want to let the constants module independent
-function isTestInstance () {
- return (process.env.NODE_ENV === 'test')
+function getLocalConfigFilePath () {
+ const configSources = config.util.getConfigSources()
+ if (configSources.length === 0) throw new Error('Invalid config source.')
+
+ let filename = 'local'
+ if (process.env.NODE_ENV) filename += `-${process.env.NODE_ENV}`
+ if (process.env.NODE_APP_INSTANCE) filename += `-${process.env.NODE_APP_INSTANCE}`
+
+ return join(dirname(configSources[ 0 ].name), filename + '.json')
+}
+
+function updateWebserverConfig () {
+ CONFIG.WEBSERVER.URL = sanitizeUrl(CONFIG.WEBSERVER.SCHEME + '://' + CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT)
+ CONFIG.WEBSERVER.HOST = sanitizeHost(CONFIG.WEBSERVER.HOSTNAME + ':' + CONFIG.WEBSERVER.PORT, REMOTE_SCHEME.HTTP)
+}
+
+export function reloadConfig () {
+
+ function directory () {
+ if (process.env.NODE_CONFIG_DIR) {
+ return process.env.NODE_CONFIG_DIR
+ }
+
+ return join(root(), 'config')
+ }
+
+ function purge () {
+ for (const fileName in require.cache) {
+ if (-1 === fileName.indexOf(directory())) {
+ continue
+ }
+
+ delete require.cache[fileName]
+ }
+
+ delete require.cache[require.resolve('config')]
+ }
+
+ purge()
+
+ config = require('config')
+
+ updateWebserverConfig()
}