1 # /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ #
12 # Proxies to trust to get real client IP
13 # If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
14 # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
18 # Your database name will be "peertube"+database.suffix
28 # You can also specify a 'socket' path to a unix socket but first need to
29 # comment out hostname and port
42 disable_starttls: false
43 ca_file: null # Used for self signed certificates
44 from_address: 'admin@example.com'
46 # From the project root directory
48 tmp: 'storage/tmp/' # Used to download data (imports etc), store uploaded files before processing...
49 avatars: 'storage/avatars/'
50 videos: 'storage/videos/'
51 streaming_playlists: 'storage/streaming-playlists/'
52 redundancy: 'storage/redundancy/'
54 previews: 'storage/previews/'
55 thumbnails: 'storage/thumbnails/'
56 torrents: 'storage/torrents/'
57 captions: 'storage/captions/'
58 cache: 'storage/cache/'
61 level: 'info' # debug/info/warning/error
64 # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
65 # If enabled, the associated group will be able to "escape" from the instance follows
66 # That means they will be able to follow channels, watch videos, list videos of non followed instances
73 interval_days: 7 # Compute trending videos for the last x days
75 # Cache remote videos on your server, to help other instances to broadcast the video
76 # You can define multiple caches using different sizes/strategies
77 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
80 check_interval: '1 hour' # How often you want to check new videos to cache
81 strategies: # Just uncomment strategies you want
84 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
85 # min_lifetime: '48 hours'
86 # strategy: 'most-views' # Cache videos that have the most views
89 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
90 # min_lifetime: '48 hours'
91 # strategy: 'trending' # Cache trending videos
94 # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
95 # min_lifetime: '48 hours'
96 # strategy: 'recently-added' # Cache recently added videos
97 # min_views: 10 # Having at least x views
101 report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
106 size: 500 # Max number of previews you want to cache
108 size: 500 # Max number of video captions/subtitles you want to cache
111 # Used to generate the root user at first startup
112 # And to receive emails from the contact form
113 email: 'admin@example.com'
120 limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
121 requires_email_verification: false
123 cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
128 # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
131 video_quota_daily: -1
133 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
134 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
135 # Please, do not disable transcoding since many uploaded videos will not work
138 # Allow your users to upload .mkv, .mov, .avi, .flv videos
139 allow_additional_extensions: true
141 resolutions: # Only created if the original video has a higher resolution, uses more storage!
147 # /!\ EXPERIMENTAL /!\
148 # /!\ Requires ffmpeg >= 4
149 # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
150 # * Resolution change is smoother
151 # * Faster playback in particular with long videos
152 # * More stable playback (less bugs/infinite loading)
153 # /!\ Multiply videos storage by 2 /!\
158 # Add ability for your users to import remote videos (from YouTube, torrent...)
160 http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
162 torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
166 # New videos automatically blacklisted so moderators can review before publishing
173 short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
174 description: 'Welcome to this PeerTube instance!' # Support markdown
175 terms: 'No terms for now.' # Support markdown
176 default_client_route: '/videos/trending'
177 # Whether or not the instance is dedicated to NSFW content
178 # Enabling it will allow other administrators to know that you are mainly federating sensitive content
179 # Moreover, the NSFW checkbox on video upload will be automatically checked by default
181 # By default, "do_not_list" or "blur" or "display" NSFW videos
182 # Could be overridden per user with a setting
183 default_nsfw_policy: 'do_not_list'
185 javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
186 css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
187 # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
191 # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
193 "# 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:"
196 # Cards configuration to format video in Twitter
198 username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
199 # If true, a video player will be embedded in the Twitter feed on PeerTube video share
200 # If false, we use an image link card that will redirect on your PeerTube instance
201 # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted