default.yaml 32 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941
  1. # /!\ DO NOT UPDATE THIS FILE, USE production.yaml instead /!\ #
  2. listen:
  3. hostname: '127.0.0.1'
  4. port: 9000
  5. # Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
  6. webserver:
  7. https: false
  8. hostname: 'localhost'
  9. port: 9000
  10. # Secrets you need to generate the first time you run PeerTube
  11. secrets:
  12. # Generate one using `openssl rand -hex 32`
  13. peertube: ''
  14. rates_limit:
  15. api:
  16. # 50 attempts in 10 seconds
  17. window: 10 seconds
  18. max: 50
  19. login:
  20. # 15 attempts in 5 min
  21. window: 5 minutes
  22. max: 15
  23. signup:
  24. # 2 attempts in 5 min (only succeeded attempts are taken into account)
  25. window: 5 minutes
  26. max: 2
  27. ask_send_email:
  28. # 3 attempts in 5 min
  29. window: 5 minutes
  30. max: 3
  31. receive_client_log:
  32. # 10 attempts in 10 min
  33. window: 10 minutes
  34. max: 10
  35. plugins:
  36. # 500 attempts in 10 seconds (we also serve plugin static files)
  37. window: 10 seconds
  38. max: 500
  39. well_known:
  40. # 200 attempts in 10 seconds
  41. window: 10 seconds
  42. max: 200
  43. feeds:
  44. # 50 attempts in 10 seconds
  45. window: 10 seconds
  46. max: 50
  47. activity_pub:
  48. # 500 attempts in 10 seconds (we can have many AP requests)
  49. window: 10 seconds
  50. max: 500
  51. client: # HTML files generated by PeerTube
  52. # 500 attempts in 10 seconds (to not break crawlers)
  53. window: 10 seconds
  54. max: 500
  55. oauth2:
  56. token_lifetime:
  57. access_token: '1 day'
  58. refresh_token: '2 weeks'
  59. # Proxies to trust to get real client IP
  60. # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
  61. # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
  62. trust_proxy:
  63. - 'loopback'
  64. # Your database name will be database.name OR 'peertube'+database.suffix
  65. database:
  66. hostname: '127.0.0.1'
  67. port: 5432
  68. ssl: false
  69. suffix: '_dev'
  70. username: 'peertube'
  71. password: 'peertube'
  72. pool:
  73. max: 5
  74. # Redis server for short time storage
  75. # You can also specify a 'socket' path to a unix socket but first need to
  76. # set 'hostname' and 'port' to null
  77. redis:
  78. hostname: '127.0.0.1'
  79. port: 6379
  80. auth: null # Used by both standalone and sentinel
  81. db: 0
  82. sentinel:
  83. enabled: false
  84. enable_tls: false
  85. master_name: ''
  86. sentinels:
  87. - hostname: ''
  88. port: 26379
  89. # SMTP server to send emails
  90. smtp:
  91. # smtp or sendmail
  92. transport: smtp
  93. # Path to sendmail command. Required if you use sendmail transport
  94. sendmail: null
  95. hostname: null
  96. port: 465 # If you use StartTLS: 587
  97. username: null
  98. password: null
  99. tls: true # If you use StartTLS: false
  100. disable_starttls: false
  101. ca_file: null # Used for self signed certificates
  102. from_address: 'admin@example.com'
  103. email:
  104. body:
  105. signature: 'PeerTube'
  106. subject:
  107. prefix: '[PeerTube]'
  108. # Update default PeerTube values
  109. # Set by API when the field is not provided and put as default value in client
  110. defaults:
  111. # Change default values when publishing a video (upload/import/go Live)
  112. publish:
  113. download_enabled: true
  114. comments_enabled: true
  115. # public = 1, unlisted = 2, private = 3, internal = 4
  116. privacy: 1
  117. # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7
  118. # You can also choose a custom licence value added by a plugin
  119. # No licence by default
  120. licence: null
  121. p2p:
  122. # Enable P2P by default in PeerTube client
  123. # Can be enabled/disabled by anonymous users and logged in users
  124. webapp:
  125. enabled: true
  126. # Enable P2P by default in PeerTube embed
  127. # Can be enabled/disabled by URL option
  128. embed:
  129. enabled: true
  130. # From the project root directory
  131. storage:
  132. tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing...
  133. tmp_persistent: 'storage/tmp-persistent/' # As tmp but the directory is not cleaned up between PeerTube restarts
  134. bin: 'storage/bin/'
  135. avatars: 'storage/avatars/'
  136. web_videos: 'storage/web-videos/'
  137. streaming_playlists: 'storage/streaming-playlists/'
  138. original_video_files: 'storage/original-video-files/'
  139. redundancy: 'storage/redundancy/'
  140. logs: 'storage/logs/'
  141. previews: 'storage/previews/'
  142. thumbnails: 'storage/thumbnails/'
  143. storyboards: 'storage/storyboards/'
  144. torrents: 'storage/torrents/'
  145. captions: 'storage/captions/'
  146. cache: 'storage/cache/'
  147. plugins: 'storage/plugins/'
  148. well_known: 'storage/well-known/'
  149. # Overridable client files in client/dist/assets/images:
  150. # - logo.svg
  151. # - favicon.png
  152. # - default-playlist.jpg
  153. # - default-avatar-account.png
  154. # - default-avatar-video-channel.png
  155. # - and icons/*.png (PWA)
  156. # Could contain for example assets/images/favicon.png
  157. # If the file exists, peertube will serve it
  158. # If not, peertube will fallback to the default file
  159. client_overrides: 'storage/client-overrides/'
  160. static_files:
  161. # Require and check user authentication when accessing private files (internal/private video files)
  162. private_files_require_auth: true
  163. object_storage:
  164. enabled: false
  165. # Without protocol, will default to HTTPS
  166. # Your S3 provider must support virtual hosting of buckets as PeerTube doesn't support path style requests
  167. endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example
  168. region: 'us-east-1'
  169. upload_acl:
  170. # Set this ACL on each uploaded object of public/unlisted videos
  171. # Use null if your S3 provider does not support object ACL
  172. public: 'public-read'
  173. # Set this ACL on each uploaded object of private/internal videos
  174. # PeerTube can proxify requests to private objects so your users can access them
  175. # Use null if your S3 provider does not support object ACL
  176. private: 'private'
  177. proxy:
  178. # If private files (private/internal video files) have a private ACL, users can't access directly the ressource
  179. # PeerTube can proxify requests between your object storage service and your users
  180. # If you disable PeerTube proxy, ensure you use your own proxy that is able to access the private files
  181. # Or you can also set a public ACL for private files in object storage if you don't want to use a proxy
  182. proxify_private_files: true
  183. credentials:
  184. # You can also use AWS_ACCESS_KEY_ID env variable
  185. access_key_id: ''
  186. # You can also use AWS_SECRET_ACCESS_KEY env variable
  187. secret_access_key: ''
  188. # Maximum amount to upload in one request to object storage
  189. max_upload_part: 100MB
  190. streaming_playlists:
  191. bucket_name: 'streaming-playlists'
  192. # Allows setting all buckets to the same value but with a different prefix
  193. prefix: '' # Example: 'streaming-playlists:'
  194. # Base url for object URL generation, scheme and host will be replaced by this URL
  195. # Useful when you want to use a CDN/external proxy
  196. base_url: '' # Example: 'https://mirror.example.com'
  197. # PeerTube makes many small requests to the object storage provider to upload/delete/update live chunks
  198. # which can be a problem depending on your object storage provider
  199. # You can also choose to disable this feature to reduce live streams latency
  200. # Live stream replays are not affected by this setting, so they are uploaded in object storage as regular VOD videos
  201. store_live_streams: true
  202. web_videos:
  203. bucket_name: 'web-videos'
  204. prefix: ''
  205. base_url: ''
  206. user_exports:
  207. bucket_name: 'user-exports'
  208. prefix: ''
  209. base_url: ''
  210. # Same settings but for original video files
  211. original_video_files:
  212. bucket_name: 'original-video-files'
  213. prefix: ''
  214. base_url: ''
  215. log:
  216. level: 'info' # 'debug' | 'info' | 'warn' | 'error'
  217. rotation:
  218. enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
  219. max_file_size: 12MB
  220. max_files: 20
  221. anonymize_ip: false
  222. log_ping_requests: true
  223. log_tracker_unknown_infohash: true
  224. # If you have many concurrent requests, you can disable HTTP requests logging to reduce PeerTube CPU load
  225. log_http_requests: true
  226. prettify_sql: false
  227. # Accept warn/error logs coming from the client
  228. accept_client_log: true
  229. # Support of Open Telemetry metrics and tracing
  230. # For more information: https://docs.joinpeertube.org/maintain/observability
  231. open_telemetry:
  232. metrics:
  233. enabled: false
  234. # How often viewers send playback stats to server
  235. playback_stats_interval: '15 seconds'
  236. http_request_duration:
  237. # You can disable HTTP request duration metric that can have a high tag cardinality
  238. enabled: false
  239. # Create a prometheus exporter server on this port so prometheus server can scrape PeerTube metrics
  240. prometheus_exporter:
  241. hostname: '127.0.0.1'
  242. port: 9091
  243. tracing:
  244. # If tracing is enabled, you must provide --experimental-loader=@opentelemetry/instrumentation/hook.mjs flag to the node binary
  245. enabled: false
  246. # Send traces to a Jaeger compatible endpoint
  247. jaeger_exporter:
  248. endpoint: ''
  249. trending:
  250. videos:
  251. interval_days: 7 # Compute trending videos for the last x days for 'most-viewed' algorithm
  252. algorithms:
  253. enabled:
  254. - 'hot' # Adaptation of Reddit's 'Hot' algorithm
  255. - 'most-viewed' # Number of views in the last x days
  256. - 'most-liked' # Global views since the upload of the video
  257. default: 'most-viewed'
  258. # Cache remote videos on your server, to help other instances to broadcast the video
  259. # You can define multiple caches using different sizes/strategies
  260. # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
  261. redundancy:
  262. videos:
  263. check_interval: '1 hour' # How often you want to check new videos to cache
  264. strategies: # Just uncomment strategies you want
  265. # -
  266. # size: '10GB'
  267. # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
  268. # min_lifetime: '48 hours'
  269. # strategy: 'most-views' # Cache videos that have the most views
  270. # -
  271. # size: '10GB'
  272. # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
  273. # min_lifetime: '48 hours'
  274. # strategy: 'trending' # Cache trending videos
  275. # -
  276. # size: '10GB'
  277. # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
  278. # min_lifetime: '48 hours'
  279. # strategy: 'recently-added' # Cache recently added videos
  280. # min_views: 10 # Having at least x views
  281. # Other instances that duplicate your content
  282. remote_redundancy:
  283. videos:
  284. # 'nobody': Do not accept remote redundancies
  285. # 'anybody': Accept remote redundancies from anybody
  286. # 'followings': Accept redundancies from instance followings
  287. accept_from: 'anybody'
  288. csp:
  289. enabled: false
  290. report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
  291. report_uri:
  292. security:
  293. # Set the X-Frame-Options header to help to mitigate clickjacking attacks
  294. frameguard:
  295. enabled: true
  296. # Set x-powered-by HTTP header to "PeerTube"
  297. # Can help remote software to know this is a PeerTube instance
  298. powered_by_header:
  299. enabled: true
  300. tracker:
  301. # If you disable the tracker, you disable the P2P on your PeerTube instance
  302. enabled: true
  303. # Only handle requests on your videos
  304. # If you set this to false it means you have a public tracker
  305. # Then, it is possible that clients overload your instance with external torrents
  306. private: true
  307. # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
  308. reject_too_many_announces: false
  309. history:
  310. videos:
  311. # If you want to limit users videos history
  312. # -1 means there is no limitations
  313. # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
  314. max_age: -1
  315. views:
  316. videos:
  317. # PeerTube creates a database entry every hour for each video to track views over a period of time
  318. # This is used in particular by the Trending page
  319. # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
  320. # -1 means no cleanup
  321. # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
  322. remote:
  323. max_age: '30 days'
  324. # PeerTube buffers local video views before updating and federating the video
  325. local_buffer_update_interval: '30 minutes'
  326. ip_view_expiration: '1 hour'
  327. # How often the web browser sends "is watching" information to the server
  328. # Increase the value or set null to disable it if you plan to have many viewers
  329. watching_interval:
  330. # Non logged-in viewers
  331. anonymous: '5 seconds'
  332. # Logged-in users of your instance
  333. # Unlike anonymous viewers, this endpoint is also used to store the "last watched video timecode" for your users
  334. # Increasing this value reduces the accuracy of the video resume
  335. users: '5 seconds'
  336. # Used to get country location of views of local videos
  337. geo_ip:
  338. enabled: true
  339. country:
  340. database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb'
  341. city:
  342. database_url: 'https://dbip.mirror.framasoft.org/files/dbip-city-lite-latest.mmdb'
  343. plugins:
  344. # The website PeerTube will ask for available PeerTube plugins and themes
  345. # This is an unmoderated plugin index, so only install plugins/themes you trust
  346. index:
  347. enabled: true
  348. check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
  349. url: 'https://packages.joinpeertube.org'
  350. federation:
  351. # Some federated software such as Mastodon may require an HTTP signature to access content
  352. sign_federated_fetches: true
  353. videos:
  354. federate_unlisted: false
  355. # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments)
  356. # It removes objects that do not exist anymore, and potentially fix their URLs
  357. cleanup_remote_interactions: true
  358. peertube:
  359. check_latest_version:
  360. # Check and notify admins of new PeerTube versions
  361. enabled: true
  362. # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json
  363. url: 'https://joinpeertube.org/api/v1/versions.json'
  364. webadmin:
  365. configuration:
  366. edition:
  367. # Set this to false if you don't want to allow config edition in the web interface by instance admins
  368. allowed: true
  369. # XML, Atom or JSON feeds
  370. feeds:
  371. videos:
  372. # Default number of videos displayed in feeds
  373. count: 20
  374. comments:
  375. # Default number of comments displayed in feeds
  376. count: 20
  377. remote_runners:
  378. # Consider jobs that are processed by a remote runner as stalled after this period of time without any update
  379. stalled_jobs:
  380. live: '30 seconds'
  381. vod: '2 minutes'
  382. thumbnails:
  383. # When automatically generating a thumbnail from the video
  384. generation_from_video:
  385. # How many frames to analyze at the middle of the video to select the most appropriate one
  386. # Increasing this value will increase CPU and memory usage when generating the thumbnail, especially for high video resolution
  387. # Minimum value is 2
  388. frames_to_analyze: 50
  389. stats:
  390. # Display registration requests stats (average response time, total requests...)
  391. registration_requests:
  392. enabled: true
  393. # Display abuses stats (average response time, total abuses...)
  394. abuses:
  395. enabled: true
  396. total_moderators:
  397. enabled: true
  398. total_admins:
  399. enabled: true
  400. cache:
  401. previews:
  402. size: 500 # Max number of previews you want to cache
  403. captions:
  404. size: 500 # Max number of video captions/subtitles you want to cache
  405. torrents:
  406. size: 500 # Max number of video torrents you want to cache
  407. storyboards:
  408. size: 500 # Max number of video storyboards you want to cache
  409. admin:
  410. # Used to generate the root user at first startup
  411. # And to receive emails from the contact form
  412. email: 'admin@example.com'
  413. contact_form:
  414. enabled: true
  415. signup:
  416. enabled: false
  417. limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
  418. minimum_age: 16 # Used to configure the signup form
  419. # Users fill a form to register so moderators can accept/reject the registration
  420. requires_approval: true
  421. requires_email_verification: false
  422. filters:
  423. cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
  424. whitelist: []
  425. blacklist: []
  426. user:
  427. history:
  428. videos:
  429. # Enable or disable video history by default for new users.
  430. enabled: true
  431. # Default value of maximum video bytes the user can upload
  432. # Does not take into account transcoded files or account export archives (that can include user uploaded files)
  433. # Byte format is supported ("1GB" etc)
  434. # -1 == unlimited
  435. video_quota: -1
  436. video_quota_daily: -1
  437. default_channel_name: 'Main $1 channel' # The placeholder $1 is used to represent the user's username
  438. video_channels:
  439. max_per_user: 20 # Allows each user to create up to 20 video channels.
  440. # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag
  441. # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions
  442. # Please, do not disable transcoding since many uploaded videos will not work
  443. transcoding:
  444. enabled: true
  445. original_file:
  446. # If false the uploaded file is deleted after transcoding
  447. # If yes it is not deleted but moved in a dedicated folder or object storage
  448. keep: false
  449. # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
  450. allow_additional_extensions: true
  451. # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
  452. allow_audio_files: true
  453. # Enable remote runners to transcode your videos
  454. # If enabled, your instance won't transcode the videos itself
  455. # At least 1 remote runner must be configured to transcode your videos
  456. remote_runners:
  457. enabled: false
  458. # Amount of threads used by ffmpeg for 1 local transcoding job
  459. threads: 1
  460. # Amount of local transcoding jobs to execute in parallel
  461. concurrency: 1
  462. # Choose the local transcoding profile
  463. # New profiles can be added by plugins
  464. # Available in core PeerTube: 'default'
  465. profile: 'default'
  466. resolutions: # Only created if the original video has a higher resolution, uses more storage!
  467. 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
  468. 144p: false
  469. 240p: false
  470. 360p: false
  471. 480p: false
  472. 720p: false
  473. 1080p: false
  474. 1440p: false
  475. 2160p: false
  476. # Transcode and keep original resolution, even if it's above your maximum enabled resolution
  477. always_transcode_original_resolution: true
  478. # Generate videos in a web compatible format
  479. # If you also enabled the hls format, it will multiply videos storage by 2
  480. # If disabled, breaks federation with PeerTube instances < 2.1
  481. web_videos:
  482. enabled: false
  483. # /!\ Requires ffmpeg >= 4.1
  484. # Generate HLS playlists and fragmented MP4 files. Better playback than with Web Videos:
  485. # * Resolution change is smoother
  486. # * Faster playback in particular with long videos
  487. # * More stable playback (less bugs/infinite loading)
  488. # If you also enabled the web videos format, it will multiply videos storage by 2
  489. hls:
  490. enabled: true
  491. live:
  492. enabled: false
  493. # Limit lives duration
  494. # -1 == unlimited
  495. max_duration: -1 # For example: '5 hours'
  496. # Limit max number of live videos created on your instance
  497. # -1 == unlimited
  498. max_instance_lives: 20
  499. # Limit max number of live videos created by a user on your instance
  500. # -1 == unlimited
  501. max_user_lives: 3
  502. # Allow your users to save a replay of their live
  503. # PeerTube will transcode segments in a video file
  504. # If the user daily/total quota is reached, PeerTube will stop the live
  505. # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
  506. allow_replay: true
  507. # Allow your users to change latency settings (small latency/default/high latency)
  508. # Small latency live streams cannot use P2P
  509. # High latency live streams can increase P2P ratio
  510. latency_setting:
  511. enabled: true
  512. # Your firewall should accept traffic from this port in TCP if you enable live
  513. rtmp:
  514. enabled: true
  515. # Listening hostname/port for RTMP server
  516. # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
  517. # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
  518. hostname: null
  519. port: 1935
  520. # Public hostname of your RTMP server
  521. # Use null to use the same value than `webserver.hostname`
  522. public_hostname: null
  523. rtmps:
  524. enabled: false
  525. # Listening hostname/port for RTMPS server
  526. # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4
  527. # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise
  528. hostname: null
  529. port: 1936
  530. # Absolute paths
  531. key_file: ''
  532. cert_file: ''
  533. # Public hostname of your RTMPS server
  534. # Use null to use the same value than `webserver.hostname`
  535. public_hostname: null
  536. # Allow to transcode the live streaming in multiple live resolutions
  537. transcoding:
  538. enabled: true
  539. # Enable remote runners to transcode your videos
  540. # If enabled, your instance won't transcode the videos itself
  541. # At least 1 remote runner must be configured to transcode your videos
  542. remote_runners:
  543. enabled: false
  544. # Amount of threads used by ffmpeg per live when using local transcoding
  545. threads: 2
  546. # Choose the local transcoding profile
  547. # New profiles can be added by plugins
  548. # Available in core PeerTube: 'default'
  549. profile: 'default'
  550. resolutions:
  551. 144p: false
  552. 240p: false
  553. 360p: false
  554. 480p: false
  555. 720p: false
  556. 1080p: false
  557. 1440p: false
  558. 2160p: false
  559. # Also transcode original resolution, even if it's above your maximum enabled resolution
  560. always_transcode_original_resolution: true
  561. video_studio:
  562. # Enable video edition by users (cut, add intro/outro, add watermark etc)
  563. # If enabled, users can create transcoding tasks as they wish
  564. enabled: false
  565. # Enable remote runners to transcode studio tasks
  566. # If enabled, your instance won't transcode the videos itself
  567. # At least 1 remote runner must be configured to transcode your videos
  568. remote_runners:
  569. enabled: false
  570. video_file:
  571. update:
  572. # Add ability for users to replace the video file of an existing video
  573. enabled: false
  574. import:
  575. # Add ability for your users to import remote videos (from YouTube, torrent...)
  576. videos:
  577. # Amount of import jobs to execute in parallel
  578. concurrency: 1
  579. # Set a custom video import timeout to not block import queue
  580. timeout: '2 hours'
  581. # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
  582. http:
  583. # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server
  584. # See https://docs.joinpeertube.org/maintain/configuration#security for more information
  585. enabled: false
  586. youtube_dl_release:
  587. # Direct download URL to youtube-dl binary
  588. # Github releases API is also supported
  589. # Examples:
  590. # * https://api.github.com/repos/ytdl-org/youtube-dl/releases
  591. # * https://api.github.com/repos/yt-dlp/yt-dlp/releases
  592. # * https://yt-dl.org/downloads/latest/youtube-dl
  593. url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases'
  594. # Release binary name: 'yt-dlp' or 'youtube-dl'
  595. name: 'yt-dlp'
  596. # Path to the python binary to execute for youtube-dl or yt-dlp
  597. python_path: '/usr/bin/python3'
  598. # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
  599. force_ipv4: false
  600. # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
  601. torrent:
  602. # We recommend to only enable magnet URI/torrent import if you trust your users
  603. # See https://docs.joinpeertube.org/maintain/configuration#security for more information
  604. enabled: false
  605. # Add ability for your users to synchronize their channels with external channels, playlists, etc
  606. video_channel_synchronization:
  607. enabled: false
  608. max_per_user: 10
  609. check_interval: 1 hour
  610. # Number of latest published videos to check and to potentially import when syncing a channel
  611. videos_limit_per_synchronization: 10
  612. # Max number of videos to import when the user asks for full sync
  613. full_sync_videos_limit: 1000
  614. users:
  615. # Video quota is checked on import so the user doesn't upload a too big archive file
  616. # Video quota (daily quota is not taken into account) is also checked for each video when PeerTube is processing the import
  617. enabled: true
  618. export:
  619. users:
  620. # Allow users to export their PeerTube data in a .zip for backup or re-import
  621. # Only one export at a time is allowed per user
  622. enabled: true
  623. # Max size of the current user quota to accept or not the export
  624. # Goal of this setting is to not store too big archive file on your server disk
  625. max_user_video_quota: 10GB
  626. # How long PeerTube should keep the user export
  627. export_expiration: '2 days'
  628. auto_blacklist:
  629. # New videos automatically blacklisted so moderators can review before publishing
  630. videos:
  631. of_users:
  632. enabled: false
  633. # Instance settings
  634. instance:
  635. name: 'PeerTube'
  636. short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
  637. description: 'Welcome to this PeerTube instance!' # Support markdown
  638. terms: 'No terms for now.' # Support markdown
  639. code_of_conduct: '' # Supports markdown
  640. # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
  641. moderation_information: '' # Supports markdown
  642. # Why did you create this instance?
  643. creation_reason: '' # Supports Markdown
  644. # Who is behind the instance? A single person? A non profit?
  645. administrator: '' # Supports Markdown
  646. # How long do you plan to maintain this instance?
  647. maintenance_lifetime: '' # Supports Markdown
  648. # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
  649. business_model: '' # Supports Markdown
  650. # If you want to explain on what type of hardware your PeerTube instance runs
  651. # Example: '2 vCore, 2GB RAM...'
  652. hardware_information: '' # Supports Markdown
  653. # What are the main languages of your instance? To interact with your users for example
  654. # Uncomment or add the languages you want
  655. # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
  656. languages:
  657. # - en
  658. # - es
  659. # - fr
  660. # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
  661. # Uncomment or add the category ids you want
  662. # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
  663. categories:
  664. # - 1 # Music
  665. # - 2 # Films
  666. # - 3 # Vehicles
  667. # - 4 # Art
  668. # - 5 # Sports
  669. # - 6 # Travels
  670. # - 7 # Gaming
  671. # - 8 # People
  672. # - 9 # Comedy
  673. # - 10 # Entertainment
  674. # - 11 # News & Politics
  675. # - 12 # How To
  676. # - 13 # Education
  677. # - 14 # Activism
  678. # - 15 # Science & Technology
  679. # - 16 # Animals
  680. # - 17 # Kids
  681. # - 18 # Food
  682. default_client_route: '/videos/trending'
  683. # Whether or not the instance is dedicated to NSFW content
  684. # Enabling it will allow other administrators to know that you are mainly federating sensitive content
  685. # Moreover, the NSFW checkbox on video upload will be automatically checked by default
  686. is_nsfw: false
  687. # By default, `do_not_list` or `blur` or `display` NSFW videos
  688. # Could be overridden per user with a setting
  689. default_nsfw_policy: 'do_not_list'
  690. customizations:
  691. javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
  692. css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
  693. # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:`
  694. robots: |
  695. User-agent: *
  696. Disallow:
  697. # /.well-known/security.txt rules. This endpoint is cached, so you may have to wait a few hours before viewing your changes
  698. # To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string
  699. securitytxt: |
  700. Contact: https://github.com/Chocobozzz/PeerTube/blob/develop/SECURITY.md
  701. Expires: 2025-12-31T11:00:00.000Z'
  702. services:
  703. # Cards configuration to format video in Twitter/X
  704. # All other social media (Facebook, Mastodon, etc.) are supported out of the box
  705. twitter:
  706. # Indicates the Twitter/X account for the website or platform where the content was published
  707. # This is just an information injected in HTML that is required by Twitter/X
  708. username: '@Chocobozzz'
  709. followers:
  710. instance:
  711. # Allow or not other instances to follow yours
  712. enabled: true
  713. # Whether or not an administrator must manually validate a new follower
  714. manual_approval: false
  715. followings:
  716. instance:
  717. # If you want to automatically follow back new instance followers
  718. # If this option is enabled, use the mute feature instead of deleting followings
  719. # /!\ Don't enable this if you don't have a reactive moderation team /!\
  720. auto_follow_back:
  721. enabled: false
  722. # If you want to automatically follow instances of the public index
  723. # If this option is enabled, use the mute feature instead of deleting followings
  724. # /!\ Don't enable this if you don't have a reactive moderation team /!\
  725. auto_follow_index:
  726. enabled: false
  727. # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
  728. index_url: ''
  729. theme:
  730. default: 'default'
  731. broadcast_message:
  732. enabled: false
  733. message: '' # Support markdown
  734. level: 'info' # 'info' | 'warning' | 'error'
  735. dismissable: false
  736. search:
  737. # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
  738. # If enabled, the associated group will be able to "escape" from the instance follows
  739. # That means they will be able to follow channels, watch videos, list videos of non followed instances
  740. remote_uri:
  741. users: true
  742. anonymous: false
  743. # Use a third party index instead of your local index, only for search results
  744. # Useful to discover content outside of your instance
  745. # If you enable search_index, you must enable remote_uri search for users
  746. # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
  747. # instead of loading the video locally
  748. search_index:
  749. enabled: false
  750. # URL of the search index, that should use the same search API and routes
  751. # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
  752. # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
  753. # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
  754. url: ''
  755. # You can disable local search in the client, so users only use the search index
  756. disable_local_search: false
  757. # If you did not disable local search in the client, you can decide to use the search index by default
  758. is_default_search: false
  759. # PeerTube client/interface configuration
  760. client:
  761. videos:
  762. miniature:
  763. # By default PeerTube client displays author username
  764. prefer_author_display_name: false
  765. display_author_avatar: false
  766. resumable_upload:
  767. # Max size of upload chunks, e.g. '90MB'
  768. # If null, it will be calculated based on network speed
  769. max_chunk_size: null
  770. menu:
  771. login:
  772. # If you enable only one external auth plugin
  773. # You can automatically redirect your users on this external platform when they click on the login button
  774. redirect_on_single_external_auth: false
  775. storyboards:
  776. # Generate storyboards of local videos using ffmpeg so users can see the video preview in the player while scrubbing the video
  777. enabled: true