1 # /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ #
7 # Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL)
15 # 50 attempts in 10 seconds
19 # 15 attempts in 5 min
23 # 2 attempts in 5 min (only succeeded attempts are taken into account)
31 # Proxies to trust to get real client IP
32 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
33 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
37 # Your database name will be database.name OR "peertube"+database.suffix
48 # You can also specify a 'socket' path to a unix socket but first need to
49 # comment out hostname and port
59 # Path to sendmail command. Required if you use sendmail transport
66 disable_starttls: false
67 ca_file: null # Used for self signed certificates
68 from_address: 'admin@example.com'
76 # From the project root directory
78 tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before processing...
79 avatars: 'storage/avatars/'
80 videos: 'storage/videos/'
81 streaming_playlists: 'storage/streaming-playlists/'
82 redundancy: 'storage/redundancy/'
84 previews: 'storage/previews/'
85 thumbnails: 'storage/thumbnails/'
86 torrents: 'storage/torrents/'
87 captions: 'storage/captions/'
88 cache: 'storage/cache/'
89 plugins: 'storage/plugins/'
90 # Overridable client files : logo.svg, favicon.png and icons/*.png (PWA) in client/dist/assets/images
91 # Could contain for example assets/images/favicon.png
92 # If the file exists, peertube will serve it
93 # If not, peertube will fallback to the default fil
94 client_overrides: 'storage/client-overrides/'
97 level: 'info' # debug/info/warning/error
106 interval_days: 7 # Compute trending videos for the last x days
108 # Cache remote videos on your server, to help other instances to broadcast the video
109 # You can define multiple caches using different sizes/strategies
110 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
113 check_interval: '1 hour' # How often you want to check new videos to cache
114 strategies: # Just uncomment strategies you want
117 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
118 # min_lifetime: '48 hours'
119 # strategy: 'most-views' # Cache videos that have the most views
122 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
123 # min_lifetime: '48 hours'
124 # strategy: 'trending' # Cache trending videos
127 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
128 # min_lifetime: '48 hours'
129 # strategy: 'recently-added' # Cache recently added videos
130 # min_views: 10 # Having at least x views
132 # Other instances that duplicate your content
135 # 'nobody': Do not accept remote redundancies
136 # 'anybody': Accept remote redundancies from anybody
137 # 'followings': Accept redundancies from instance followings
138 accept_from: 'anybody'
142 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
146 # If you disable the tracker, you disable the P2P aspect of PeerTube
148 # Only handle requests on your videos.
149 # If you set this to false it means you have a public tracker.
150 # Then, it is possible that clients overload your instance with external torrents
152 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
153 reject_too_many_announces: false
157 # If you want to limit users videos history
158 # -1 means there is no limitations
159 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
164 # PeerTube creates a database entry every hour for each video to track views over a period of time
165 # This is used in particular by the Trending page
166 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
167 # -1 means no cleanup
168 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
173 # The website PeerTube will ask for available PeerTube plugins and themes
174 # This is an unmoderated plugin index, so only install plugins/themes you trust
177 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
178 url: 'https://packages.joinpeertube.org'
182 federate_unlisted: false
186 size: 500 # Max number of previews you want to cache
188 size: 500 # Max number of video captions/subtitles you want to cache
191 # Used to generate the root user at first startup
192 # And to receive emails from the contact form
193 email: 'admin@example.com'
200 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
201 requires_email_verification: false
203 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
208 # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
211 video_quota_daily: -1
213 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
214 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
215 # Please, do not disable transcoding since many uploaded videos will not work
218 # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos
219 allow_additional_extensions: true
220 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
221 allow_audio_files: true
223 resolutions: # Only created if the original video has a higher resolution, uses more storage!
224 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
233 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
234 # If you also enabled the hls format, it will multiply videos storage by 2
235 # If disabled, breaks federation with PeerTube instances < 2.1
239 # /!\ Requires ffmpeg >= 4.1
240 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
241 # * Resolution change is smoother
242 # * Faster playback in particular with long videos
243 # * More stable playback (less bugs/infinite loading)
244 # If you also enabled the webtorrent format, it will multiply videos storage by 2
251 # Limit lives duration
253 max_duration: -1 # For example: '5 hours'
255 # Limit max number of live videos created on your instance
257 max_instance_lives: 20
259 # Limit max number of live videos created by a user on your instance
263 # Allow your users to save a replay of their live
264 # PeerTube will transcode segments in a video file
265 # If the user daily/total quota is reached, PeerTube will stop the live
266 # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay
269 # Your firewall should accept traffic from this port in TCP if you enable live
273 # Allow to transcode the live streaming in multiple live resolutions
288 # Add ability for your users to import remote videos (from YouTube, torrent...)
290 http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
293 # IPv6 is very strongly rate-limited on most sites supported by youtube-dl
296 # You can use an HTTP/HTTPS/SOCKS proxy with youtube-dl
300 torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
304 # New videos automatically blacklisted so moderators can review before publishing
311 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
312 description: 'Welcome to this PeerTube instance!' # Support markdown
313 terms: 'No terms for now.' # Support markdown
314 code_of_conduct: '' # Supports markdown
316 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
317 moderation_information: '' # Supports markdown
319 # Why did you create this instance?
320 creation_reason: '' # Supports Markdown
322 # Who is behind the instance? A single person? A non profit?
323 administrator: '' # Supports Markdown
325 # How long do you plan to maintain this instance?
326 maintenance_lifetime: '' # Supports Markdown
328 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
329 business_model: '' # Supports Markdown
331 # If you want to explain on what type of hardware your PeerTube instance runs
332 # Example: "2 vCore, 2GB RAM..."
333 hardware_information: '' # Supports Markdown
335 # What are the main languages of your instance? To interact with your users for example
336 # Uncomment or add the languages you want
337 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
343 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
344 # Uncomment or add the category ids you want
345 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
356 # - 10 # Entertainment
357 # - 11 # News & Politics
361 # - 15 # Science & Technology
366 default_client_route: '/videos/trending'
368 # Whether or not the instance is dedicated to NSFW content
369 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
370 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
372 # By default, "do_not_list" or "blur" or "display" NSFW videos
373 # Could be overridden per user with a setting
374 default_nsfw_policy: 'do_not_list'
377 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
378 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
379 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
383 # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
385 "# If you would like to report a security issue\n# you may report it to:\nContact: https://github.com/Chocobozzz/PeerTube/blob/develop/SECURITY.md\nContact: mailto:"
388 # Cards configuration to format video in Twitter
390 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
391 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
392 # If false, we use an image link card that will redirect on your PeerTube instance
393 # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
398 # Allow or not other instances to follow yours
400 # Whether or not an administrator must manually validate a new follower
401 manual_approval: false
405 # If you want to automatically follow back new instance followers
406 # Only follows accepted followers (in case you enabled manual followers approbation)
407 # If this option is enabled, use the mute feature instead of deleting followings
408 # /!\ Don't enable this if you don't have a reactive moderation team /!\
412 # If you want to automatically follow instances of the public index
413 # If this option is enabled, use the mute feature instead of deleting followings
414 # /!\ Don't enable this if you don't have a reactive moderation team /!\
417 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow
425 message: '' # Support markdown
426 level: 'info' # 'info' | 'warning' | 'error'
430 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
431 # If enabled, the associated group will be able to "escape" from the instance follows
432 # That means they will be able to follow channels, watch videos, list videos of non followed instances
437 # Use a third party index instead of your local index, only for search results
438 # Useful to discover content outside of your instance
439 # If you enable search_index, you must enable remote_uri search for users
440 # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance
441 # instead of loading the video locally
444 # URL of the search index, that should use the same search API and routes
445 # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html
446 # You should deploy your own with https://framagit.org/framasoft/peertube/search-index,
447 # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index
449 # You can disable local search, so users only use the search index
450 disable_local_search: false
451 # If you did not disable local search, you can decide to use the search index by default
452 is_default_search: false