1 # /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ #
14 # 50 attempts in 10 seconds
18 # 15 attempts in 5 min
22 # 2 attempts in 5 min (only succeeded attempts are taken into account)
30 # Proxies to trust to get real client IP
31 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
32 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
36 # Your database name will be "peertube"+database.suffix
46 # You can also specify a 'socket' path to a unix socket but first need to
47 # comment out hostname and port
57 # Path to sendmail command. Required if you use sendmail transport
64 disable_starttls: false
65 ca_file: null # Used for self signed certificates
66 from_address: 'admin@example.com'
74 # From the project root directory
76 tmp: 'storage/tmp/' # Use to download data (imports etc), store uploaded files before processing...
77 avatars: 'storage/avatars/'
78 videos: 'storage/videos/'
79 streaming_playlists: 'storage/streaming-playlists/'
80 redundancy: 'storage/redundancy/'
82 previews: 'storage/previews/'
83 thumbnails: 'storage/thumbnails/'
84 torrents: 'storage/torrents/'
85 captions: 'storage/captions/'
86 cache: 'storage/cache/'
87 plugins: 'storage/plugins/'
90 level: 'info' # debug/info/warning/error
98 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
99 # If enabled, the associated group will be able to "escape" from the instance follows
100 # That means they will be able to follow channels, watch videos, list videos of non followed instances
107 interval_days: 7 # Compute trending videos for the last x days
109 # Cache remote videos on your server, to help other instances to broadcast the video
110 # You can define multiple caches using different sizes/strategies
111 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
114 check_interval: '1 hour' # How often you want to check new videos to cache
115 strategies: # Just uncomment strategies you want
118 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
119 # min_lifetime: '48 hours'
120 # strategy: 'most-views' # Cache videos that have the most views
123 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
124 # min_lifetime: '48 hours'
125 # strategy: 'trending' # Cache trending videos
128 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
129 # min_lifetime: '48 hours'
130 # strategy: 'recently-added' # Cache recently added videos
131 # min_views: 10 # Having at least x views
133 # Other instances that duplicate your content
136 # 'nobody': Do not accept remote redundancies
137 # 'anybody': Accept remote redundancies from anybody
138 # 'followings': Accept redundancies from instance followings
139 accept_from: 'anybody'
143 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
147 # If you disable the tracker, you disable the P2P aspect of PeerTube
149 # Only handle requests on your videos.
150 # If you set this to false it means you have a public tracker.
151 # Then, it is possible that clients overload your instance with external torrents
153 # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
154 reject_too_many_announces: false
158 # If you want to limit users videos history
159 # -1 means there is no limitations
160 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
165 # PeerTube creates a database entry every hour for each video to track views over a period of time
166 # This is used in particular by the Trending page
167 # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
168 # -1 means no cleanup
169 # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
174 # The website PeerTube will ask for available PeerTube plugins and themes
175 # This is an unmoderated plugin index, so only install plugins/themes you trust
178 check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
179 url: 'https://packages.joinpeertube.org'
183 size: 500 # Max number of previews you want to cache
185 size: 500 # Max number of video captions/subtitles you want to cache
188 # Used to generate the root user at first startup
189 # And to receive emails from the contact form
190 email: 'admin@example.com'
197 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
198 requires_email_verification: false
200 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
205 # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
208 video_quota_daily: -1
210 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
211 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
212 # Please, do not disable transcoding since many uploaded videos will not work
215 # Allow your users to upload .mkv, .mov, .avi, .flv videos
216 allow_additional_extensions: true
217 # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
218 allow_audio_files: true
220 resolutions: # Only created if the original video has a higher resolution, uses more storage!
221 0p: false # audio-only (creates mp4 without video stream, always created when enabled)
229 # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
230 # If you also enabled the hls format, it will multiply videos storage by 2
231 # If disabled, breaks federation with PeerTube instances < 2.1
235 # /!\ Requires ffmpeg >= 4.1
236 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
237 # * Resolution change is smoother
238 # * Faster playback in particular with long videos
239 # * More stable playback (less bugs/infinite loading)
240 # If you also enabled the webtorrent format, it will multiply videos storage by 2
245 # Add ability for your users to import remote videos (from YouTube, torrent...)
247 http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
249 # You can use an HTTP/HTTPS/SOCKS proxy with youtube-dl
253 torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
257 # New videos automatically blacklisted so moderators can review before publishing
264 short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.'
265 description: 'Welcome to this PeerTube instance!' # Support markdown
266 terms: 'No terms for now.' # Support markdown
267 code_of_conduct: '' # Supports markdown
269 # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
270 moderation_information: '' # Supports markdown
272 # Why did you create this instance?
275 # Who is behind the instance? A single person? A non profit?
278 # How long do you plan to maintain this instance?
279 maintenance_lifetime: ''
281 # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
284 # If you want to explain on what type of hardware your PeerTube instance runs
285 # Example: "2 vCore, 2GB RAM..."
286 hardware_information: '' # Supports Markdown
288 # What are the main languages of your instance? To interact with your users for example
289 # Uncomment or add the languages you want
290 # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
296 # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
297 # Uncomment or add the category ids you want
298 # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
309 # - 10 # Entertainment
310 # - 11 # News & Politics
314 # - 15 # Science & Technology
319 default_client_route: '/videos/trending'
321 # Whether or not the instance is dedicated to NSFW content
322 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
323 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
325 # By default, "do_not_list" or "blur" or "display" NSFW videos
326 # Could be overridden per user with a setting
327 default_nsfw_policy: 'do_not_list'
330 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
331 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
332 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
336 # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
338 "# 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:"
341 # Cards configuration to format video in Twitter
343 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
344 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
345 # If false, we use an image link card that will redirect on your PeerTube instance
346 # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
351 # Allow or not other instances to follow yours
353 # Whether or not an administrator must manually validate a new follower
354 manual_approval: false
358 # If you want to automatically follow back new instance followers
359 # Only follows accepted followers (in case you enabled manual followers approbation)
360 # If this option is enabled, use the mute feature instead of deleting followings
361 # /!\ Don't enable this if you don't have a reactive moderation team /!\
365 # If you want to automatically follow instances of the public index
366 # If this option is enabled, use the mute feature instead of deleting followings
367 # /!\ Don't enable this if you don't have a reactive moderation team /!\
370 # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow