]>
Commit | Line | Data |
---|---|---|
552cc9d6 | 1 | listen: |
a4152bed | 2 | hostname: '127.0.0.1' |
552cc9d6 C |
3 | port: 9000 |
4 | ||
d8658f0f | 5 | # Correspond to your reverse proxy server_name/listen configuration (i.e., your public PeerTube instance URL) |
f1f4732f | 6 | webserver: |
d478d83d | 7 | https: true |
3737bbaf | 8 | hostname: 'example.com' |
d478d83d | 9 | port: 443 |
825a5d9c | 10 | |
c342726a | 11 | rates_limit: |
c1340a6a C |
12 | api: |
13 | # 50 attempts in 10 seconds | |
14 | window: 10 seconds | |
15 | max: 50 | |
c342726a YB |
16 | login: |
17 | # 15 attempts in 5 min | |
18 | window: 5 minutes | |
19 | max: 15 | |
c1340a6a C |
20 | signup: |
21 | # 2 attempts in 5 min (only succeeded attempts are taken into account) | |
22 | window: 5 minutes | |
23 | max: 2 | |
c342726a YB |
24 | ask_send_email: |
25 | # 3 attempts in 5 min | |
26 | window: 5 minutes | |
27 | max: 3 | |
28 | ||
490b595a C |
29 | # Proxies to trust to get real client IP |
30 | # If you run PeerTube just behind a local proxy (nginx), keep 'loopback' | |
31 | # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet) | |
32 | trust_proxy: | |
33 | - 'loopback' | |
34 | ||
97b6428a | 35 | # Your database name will be database.name OR 'peertube'+database.suffix |
825a5d9c | 36 | database: |
552cc9d6 C |
37 | hostname: 'localhost' |
38 | port: 5432 | |
b0ce7c39 | 39 | ssl: false |
feb4bdfd | 40 | suffix: '_prod' |
6c05c149 C |
41 | username: 'peertube' |
42 | password: 'peertube' | |
1c3386e8 RK |
43 | pool: |
44 | max: 5 | |
552cc9d6 | 45 | |
95540ed2 | 46 | # Redis server for short time storage |
19f7b248 | 47 | # You can also specify a 'socket' path to a unix socket but first need to |
ec2fa0d0 | 48 | # set 'hostname' and 'port' to null |
94a5ff8a C |
49 | redis: |
50 | hostname: 'localhost' | |
51 | port: 6379 | |
52 | auth: null | |
30c82f0d | 53 | db: 0 |
94a5ff8a | 54 | |
95540ed2 | 55 | # SMTP server to send emails |
ecb4e35f | 56 | smtp: |
ed3f089c IB |
57 | # smtp or sendmail |
58 | transport: smtp | |
59 | # Path to sendmail command. Required if you use sendmail transport | |
60 | sendmail: null | |
ecb4e35f | 61 | hostname: null |
6401417d | 62 | port: 465 # If you use StartTLS: 587 |
ecb4e35f C |
63 | username: null |
64 | password: null | |
6401417d | 65 | tls: true # If you use StartTLS: false |
bebf2d89 | 66 | disable_starttls: false |
ecb4e35f C |
67 | ca_file: null # Used for self signed certificates |
68 | from_address: 'admin@example.com' | |
69 | ||
dd2c2a52 C |
70 | email: |
71 | body: | |
97b6428a | 72 | signature: 'PeerTube' |
916937d7 | 73 | subject: |
97b6428a | 74 | prefix: '[PeerTube]' |
dd2c2a52 | 75 | |
3cf68b86 C |
76 | # Update default PeerTube values |
77 | # Set by API when the field is not provided and put as default value in client | |
78 | defaults: | |
79 | # Change default values when publishing a video (upload/import/go Live) | |
80 | publish: | |
81 | download_enabled: true | |
7399a79f | 82 | |
3cf68b86 C |
83 | comments_enabled: true |
84 | ||
85 | # public = 1, unlisted = 2, private = 3, internal = 4 | |
86 | privacy: 1 | |
87 | ||
88 | # CC-BY = 1, CC-SA = 2, CC-ND = 3, CC-NC = 4, CC-NC-SA = 5, CC-NC-ND = 6, Public Domain = 7 | |
89 | # You can also choose a custom licence value added by a plugin | |
90 | # No licence by default | |
91 | licence: null | |
0bc53e20 | 92 | |
a9bfa85d | 93 | p2p: |
a4152bed | 94 | # Enable P2P by default in PeerTube client |
a9bfa85d | 95 | # Can be enabled/disabled by anonymous users and logged in users |
b65de1be C |
96 | webapp: |
97 | enabled: true | |
98 | ||
a4152bed C |
99 | # Enable P2P by default in PeerTube embed |
100 | # Can be enabled/disabled by URL option | |
b65de1be C |
101 | embed: |
102 | enabled: true | |
a9bfa85d | 103 | |
552cc9d6 C |
104 | # From the project root directory |
105 | storage: | |
37ede348 | 106 | tmp: '/var/www/peertube/storage/tmp/' # Use to download data (imports etc), store uploaded files before and during processing... |
62549e6c | 107 | bin: '/var/www/peertube/storage/bin/' |
59c48d49 C |
108 | avatars: '/var/www/peertube/storage/avatars/' |
109 | videos: '/var/www/peertube/storage/videos/' | |
0b16f5f2 | 110 | streaming_playlists: '/var/www/peertube/storage/streaming-playlists/' |
aafbc63a | 111 | redundancy: '/var/www/peertube/storage/redundancy/' |
59c48d49 C |
112 | logs: '/var/www/peertube/storage/logs/' |
113 | previews: '/var/www/peertube/storage/previews/' | |
114 | thumbnails: '/var/www/peertube/storage/thumbnails/' | |
115 | torrents: '/var/www/peertube/storage/torrents/' | |
40e87e9e | 116 | captions: '/var/www/peertube/storage/captions/' |
59c48d49 | 117 | cache: '/var/www/peertube/storage/cache/' |
345da516 | 118 | plugins: '/var/www/peertube/storage/plugins/' |
94fecbc1 | 119 | # Overridable client files in client/dist/assets/images: |
c80e458a | 120 | # - logo.svg |
121 | # - favicon.png | |
122 | # - default-playlist.jpg | |
123 | # - default-avatar-account.png | |
124 | # - default-avatar-video-channel.png | |
125 | # - and icons/*.png (PWA) | |
caf2aaf4 K |
126 | # Could contain for example assets/images/favicon.png |
127 | # If the file exists, peertube will serve it | |
863c1bc6 | 128 | # If not, peertube will fallback to the default file |
caf2aaf4 | 129 | client_overrides: '/var/www/peertube/storage/client-overrides/' |
4793c343 | 130 | |
0305db28 JB |
131 | object_storage: |
132 | enabled: false | |
133 | ||
134 | # Without protocol, will default to HTTPS | |
135 | endpoint: '' # 's3.amazonaws.com' or 's3.fr-par.scw.cloud' for example | |
136 | ||
137 | region: 'us-east-1' | |
138 | ||
f9915efa | 139 | # Set this ACL on each uploaded object |
a4152bed | 140 | upload_acl: 'public-read' |
f9915efa | 141 | |
0305db28 JB |
142 | credentials: |
143 | # You can also use AWS_ACCESS_KEY_ID env variable | |
144 | access_key_id: '' | |
145 | # You can also use AWS_SECRET_ACCESS_KEY env variable | |
146 | secret_access_key: '' | |
147 | ||
148 | # Maximum amount to upload in one request to object storage | |
149 | max_upload_part: 2GB | |
150 | ||
151 | streaming_playlists: | |
152 | bucket_name: 'streaming-playlists' | |
153 | ||
154 | # Allows setting all buckets to the same value but with a different prefix | |
155 | prefix: '' # Example: 'streaming-playlists:' | |
156 | ||
157 | # Base url for object URL generation, scheme and host will be replaced by this URL | |
158 | # Useful when you want to use a CDN/external proxy | |
159 | base_url: '' # Example: 'https://mirror.example.com' | |
160 | ||
161 | # Same settings but for webtorrent videos | |
162 | videos: | |
163 | bucket_name: 'videos' | |
164 | prefix: '' | |
165 | base_url: '' | |
166 | ||
23e27dd5 | 167 | log: |
31a91119 | 168 | level: 'info' # 'debug' | 'info' | 'warn' | 'error' |
fcf4569f | 169 | rotation: |
aafbc63a | 170 | enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate |
97b6428a C |
171 | max_file_size: 12MB |
172 | max_files: 20 | |
173 | anonymize_ip: false | |
12c1e38d | 174 | log_ping_requests: true |
a4152bed | 175 | log_tracker_unknown_infohash: true |
1e743faa | 176 | prettify_sql: false |
23e27dd5 | 177 | |
630d0a1b C |
178 | # Highly experimental support of Open Telemetry |
179 | open_telemetry: | |
180 | metrics: | |
181 | enabled: false | |
182 | ||
183 | # Create a prometheus exporter server on this port so prometheus server can scrape PeerTube metrics | |
184 | prometheus_exporter: | |
185 | port: 9091 | |
186 | ||
187 | tracing: | |
188 | enabled: false | |
189 | ||
190 | # Send traces to a Jaeger compatible endpoint | |
191 | jaeger_exporter: | |
192 | endpoint: '' | |
193 | ||
9a629c6e C |
194 | trending: |
195 | videos: | |
196 | interval_days: 7 # Compute trending videos for the last x days | |
ba5d4a84 RK |
197 | algorithms: |
198 | enabled: | |
3d4e112d | 199 | - 'hot' # adaptation of Reddit's 'Hot' algorithm |
ba5d4a84 RK |
200 | - 'most-viewed' # default, used initially by PeerTube as the trending page |
201 | - 'most-liked' | |
202 | default: 'most-viewed' | |
9a629c6e | 203 | |
c48e82b5 C |
204 | # Cache remote videos on your server, to help other instances to broadcast the video |
205 | # You can define multiple caches using different sizes/strategies | |
206 | # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following | |
207 | redundancy: | |
208 | videos: | |
f9f899b9 | 209 | check_interval: '1 hour' # How often you want to check new videos to cache |
6040f87d | 210 | strategies: # Just uncomment strategies you want |
d9bdd007 C |
211 | # - |
212 | # size: '10GB' | |
e5565833 C |
213 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
214 | # min_lifetime: '48 hours' | |
d9bdd007 C |
215 | # strategy: 'most-views' # Cache videos that have the most views |
216 | # - | |
217 | # size: '10GB' | |
e5565833 C |
218 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
219 | # min_lifetime: '48 hours' | |
d9bdd007 C |
220 | # strategy: 'trending' # Cache trending videos |
221 | # - | |
222 | # size: '10GB' | |
e5565833 C |
223 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
224 | # min_lifetime: '48 hours' | |
d9bdd007 | 225 | # strategy: 'recently-added' # Cache recently added videos |
e5565833 | 226 | # min_views: 10 # Having at least x views |
c48e82b5 | 227 | |
8c9e7875 C |
228 | # Other instances that duplicate your content |
229 | remote_redundancy: | |
230 | videos: | |
231 | # 'nobody': Do not accept remote redundancies | |
232 | # 'anybody': Accept remote redundancies from anybody | |
233 | # 'followings': Accept redundancies from instance followings | |
234 | accept_from: 'anybody' | |
235 | ||
539d3f4f C |
236 | csp: |
237 | enabled: false | |
238 | report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk! | |
239 | report_uri: | |
240 | ||
8155db66 C |
241 | security: |
242 | # Set the X-Frame-Options header to help to mitigate clickjacking attacks | |
243 | frameguard: | |
244 | enabled: true | |
245 | ||
31b6ddf8 | 246 | tracker: |
a4152bed | 247 | # If you disable the tracker, you disable the P2P on your PeerTube instance |
31b6ddf8 | 248 | enabled: true |
de7f1114 C |
249 | # Only handle requests on your videos |
250 | # If you set this to false it means you have a public tracker | |
31b6ddf8 C |
251 | # Then, it is possible that clients overload your instance with external torrents |
252 | private: true | |
253 | # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers) | |
254 | reject_too_many_announces: false | |
255 | ||
8f0bc73d C |
256 | history: |
257 | videos: | |
258 | # If you want to limit users videos history | |
259 | # -1 means there is no limitations | |
260 | # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database) | |
261 | max_age: -1 | |
539d3f4f | 262 | |
cda03765 C |
263 | views: |
264 | videos: | |
265 | # PeerTube creates a database entry every hour for each video to track views over a period of time | |
266 | # This is used in particular by the Trending page | |
267 | # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered) | |
268 | # -1 means no cleanup | |
269 | # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database) | |
270 | remote: | |
acfa2e30 | 271 | max_age: '30 days' |
cda03765 | 272 | |
51353d9a C |
273 | # PeerTube buffers local video views before updating and federating the video |
274 | local_buffer_update_interval: '30 minutes' | |
275 | ||
276 | ip_view_expiration: '1 hour' | |
277 | ||
b2111066 C |
278 | # Used to get country location of views of local videos |
279 | geo_ip: | |
280 | enabled: true | |
281 | ||
282 | country: | |
283 | database_url: 'https://dbip.mirror.framasoft.org/files/dbip-country-lite-latest.mmdb' | |
284 | ||
6702a1b2 | 285 | plugins: |
aafbc63a C |
286 | # The website PeerTube will ask for available PeerTube plugins and themes |
287 | # This is an unmoderated plugin index, so only install plugins/themes you trust | |
6702a1b2 C |
288 | index: |
289 | enabled: true | |
df9a1a13 | 290 | check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions |
6702a1b2 C |
291 | url: 'https://packages.joinpeertube.org' |
292 | ||
3092e9bb LB |
293 | federation: |
294 | videos: | |
87568f93 | 295 | federate_unlisted: false |
3092e9bb | 296 | |
74d249bc C |
297 | # Add a weekly job that cleans up remote AP interactions on local videos (shares, rates and comments) |
298 | # It removes objects that do not exist anymore, and potentially fix their URLs | |
c5e53d0e | 299 | cleanup_remote_interactions: true |
74d249bc | 300 | |
32a18cbf C |
301 | peertube: |
302 | check_latest_version: | |
303 | # Check and notify admins of new PeerTube versions | |
304 | enabled: true | |
305 | # You can use a custom URL if your want, that respect the format behind https://joinpeertube.org/api/v1/versions.json | |
306 | url: 'https://joinpeertube.org/api/v1/versions.json' | |
cda03765 | 307 | |
8d8a037e JB |
308 | webadmin: |
309 | configuration: | |
cf0c8ee5 | 310 | edition: |
e89392d7 C |
311 | # Set this to false if you don't want to allow config edition in the web interface by instance admins |
312 | allowed: true | |
8d8a037e | 313 | |
db9d882c C |
314 | # XML, Atom or JSON feeds |
315 | feeds: | |
316 | videos: | |
317 | # Default number of videos displayed in feeds | |
318 | count: 20 | |
319 | ||
320 | comments: | |
321 | # Default number of comments displayed in feeds | |
322 | count: 20 | |
323 | ||
509cd56a C |
324 | ############################################################################### |
325 | # | |
db9d882c | 326 | # From this point, almost all following keys can be overridden by the web interface |
509cd56a C |
327 | # (local-production.json file). If you need to change some values, prefer to |
328 | # use the web interface because the configuration will be automatically | |
de7f1114 | 329 | # reloaded without any need to restart PeerTube |
509cd56a | 330 | # |
db9d882c C |
331 | # /!\ If you already have a local-production.json file, modification of some of |
332 | # the following keys will have no effect /!\ | |
509cd56a C |
333 | # |
334 | ############################################################################### | |
335 | ||
62ccb24e C |
336 | cache: |
337 | previews: | |
f842e810 C |
338 | size: 500 # Max number of previews you want to cache |
339 | captions: | |
340 | size: 500 # Max number of video captions/subtitles you want to cache | |
90a8bd30 C |
341 | torrents: |
342 | size: 500 # Max number of video torrents you want to cache | |
62ccb24e | 343 | |
4793c343 | 344 | admin: |
a4101923 C |
345 | # Used to generate the root user at first startup |
346 | # And to receive emails from the contact form | |
4793c343 | 347 | email: 'admin@example.com' |
e22528ac | 348 | |
a4101923 C |
349 | contact_form: |
350 | enabled: true | |
351 | ||
e22528ac C |
352 | signup: |
353 | enabled: false | |
62ccb24e | 354 | limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited |
e89392d7 | 355 | minimum_age: 16 # Used to configure the signup form |
d9eaee39 | 356 | requires_email_verification: false |
6401417d | 357 | filters: |
ff2c1fe8 RK |
358 | cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist |
359 | whitelist: [] | |
360 | blacklist: [] | |
227d02fe | 361 | |
b0f9f39e | 362 | user: |
de7f1114 C |
363 | # Default value of maximum video bytes the user can upload (does not take into account transcoded files) |
364 | # Byte format is supported ("1GB" etc) | |
b0f9f39e C |
365 | # -1 == unlimited |
366 | video_quota: -1 | |
bee0abff | 367 | video_quota_daily: -1 |
b0f9f39e | 368 | |
754b6f5f FC |
369 | video_channels: |
370 | max_per_user: 20 # Allows each user to create up to 20 video channels. | |
371 | ||
97b6428a | 372 | # If enabled, the video will be transcoded to mp4 (x264) with `faststart` flag |
de7f1114 | 373 | # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions |
09f35e2a | 374 | # Please, do not disable transcoding since many uploaded videos will not work |
227d02fe | 375 | transcoding: |
1125c40a | 376 | enabled: true |
1896bca0 | 377 | |
fccbbc1a | 378 | # Allow your users to upload .mkv, .mov, .avi, .wmv, .flv, .f4v, .3g2, .3gp, .mts, m2ts, .mxf, .nut videos |
14e2014a | 379 | allow_additional_extensions: true |
1896bca0 | 380 | |
536598cf C |
381 | # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file |
382 | allow_audio_files: true | |
1896bca0 | 383 | |
9129b769 | 384 | # Amount of threads used by ffmpeg for 1 transcoding job |
98f535a5 | 385 | threads: 1 |
9129b769 C |
386 | # Amount of transcoding jobs to execute in parallel |
387 | concurrency: 1 | |
1896bca0 C |
388 | |
389 | # Choose the transcoding profile | |
390 | # New profiles can be added by plugins | |
391 | # Available in core PeerTube: 'default' | |
392 | profile: 'default' | |
393 | ||
09f35e2a | 394 | resolutions: # Only created if the original video has a higher resolution, uses more storage! |
6ad88df8 | 395 | 0p: false # audio-only (creates mp4 without video stream, always created when enabled) |
8dd754c7 | 396 | 144p: false |
1125c40a C |
397 | 240p: false |
398 | 360p: false | |
399 | 480p: false | |
400 | 720p: false | |
401 | 1080p: false | |
b7085c71 | 402 | 1440p: false |
ad3405d0 | 403 | 2160p: false |
d7a25329 C |
404 | |
405 | # Generate videos in a WebTorrent format (what we do since the first PeerTube release) | |
406 | # If you also enabled the hls format, it will multiply videos storage by 2 | |
04cda1d7 | 407 | # If disabled, breaks federation with PeerTube instances < 2.1 |
d7a25329 | 408 | webtorrent: |
6a882428 | 409 | enabled: false |
d7a25329 | 410 | |
5d9e4eaa | 411 | # /!\ Requires ffmpeg >= 4.1 |
7f8f8bdb | 412 | # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent: |
09209296 C |
413 | # * Resolution change is smoother |
414 | # * Faster playback in particular with long videos | |
415 | # * More stable playback (less bugs/infinite loading) | |
d7a25329 | 416 | # If you also enabled the webtorrent format, it will multiply videos storage by 2 |
09209296 | 417 | hls: |
6a882428 | 418 | enabled: true |
66b16caf | 419 | |
d2345ce9 C |
420 | live: |
421 | enabled: false | |
422 | ||
423 | # Limit lives duration | |
1896bca0 | 424 | # -1 == unlimited |
c9bc850e | 425 | max_duration: -1 # For example: '5 hours' |
d2345ce9 C |
426 | |
427 | # Limit max number of live videos created on your instance | |
428 | # -1 == unlimited | |
429 | max_instance_lives: 20 | |
430 | ||
431 | # Limit max number of live videos created by a user on your instance | |
432 | # -1 == unlimited | |
433 | max_user_lives: 3 | |
434 | ||
435 | # Allow your users to save a replay of their live | |
436 | # PeerTube will transcode segments in a video file | |
437 | # If the user daily/total quota is reached, PeerTube will stop the live | |
438 | # /!\ transcoding.enabled (and not live.transcoding.enabled) has to be true to create a replay | |
439 | allow_replay: true | |
440 | ||
f443a746 C |
441 | # Allow your users to change latency settings (small latency/default/high latency) |
442 | # Small latency live streams cannot use P2P | |
443 | # High latency live streams can increase P2P ratio | |
444 | latency_setting: | |
445 | enabled: true | |
446 | ||
4f20856e | 447 | # Your firewall should accept traffic from this port in TCP if you enable live |
d2345ce9 | 448 | rtmp: |
df1db951 | 449 | enabled: true |
cfbe6be5 | 450 | |
9c5e5822 | 451 | # Listening hostname/port for RTMP server |
d322f854 C |
452 | # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4 |
453 | # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise | |
454 | hostname: null | |
cfbe6be5 C |
455 | port: 1935 |
456 | ||
9c5e5822 | 457 | # Public hostname of your RTMP server |
cfbe6be5 C |
458 | # Use null to use the same value than `webserver.hostname` |
459 | public_hostname: null | |
d2345ce9 | 460 | |
df1db951 C |
461 | rtmps: |
462 | enabled: false | |
cfbe6be5 | 463 | |
9c5e5822 | 464 | # Listening hostname/port for RTMPS server |
d322f854 C |
465 | # '::' to listen on IPv6 and IPv4, '0.0.0.0' to listen on IPv4 |
466 | # Use null to automatically listen on '::' if IPv6 is available, or '0.0.0.0' otherwise | |
467 | hostname: null | |
df1db951 | 468 | port: 1936 |
cfbe6be5 C |
469 | |
470 | # Absolute paths | |
df1db951 C |
471 | key_file: '' |
472 | cert_file: '' | |
cfbe6be5 | 473 | |
9c5e5822 | 474 | # Public hostname of your RTMPS server |
cfbe6be5 C |
475 | # Use null to use the same value than `webserver.hostname` |
476 | public_hostname: null | |
df1db951 | 477 | |
d2345ce9 C |
478 | # Allow to transcode the live streaming in multiple live resolutions |
479 | transcoding: | |
cf3e0d69 | 480 | enabled: true |
d2345ce9 C |
481 | threads: 2 |
482 | ||
1896bca0 C |
483 | # Choose the transcoding profile |
484 | # New profiles can be added by plugins | |
485 | # Available in core PeerTube: 'default' | |
486 | profile: 'default' | |
487 | ||
d2345ce9 | 488 | resolutions: |
8dd754c7 | 489 | 144p: false |
d2345ce9 C |
490 | 240p: false |
491 | 360p: false | |
492 | 480p: false | |
493 | 720p: false | |
494 | 1080p: false | |
b7085c71 | 495 | 1440p: false |
d2345ce9 C |
496 | 2160p: false |
497 | ||
92e66e04 | 498 | video_studio: |
c729caf6 | 499 | # Enable video edition by users (cut, add intro/outro, add watermark etc) |
a5a1690d | 500 | # If enabled, users can create transcoding tasks as they wish |
c729caf6 C |
501 | enabled: false |
502 | ||
5d08a6a7 C |
503 | import: |
504 | # Add ability for your users to import remote videos (from YouTube, torrent...) | |
505 | videos: | |
9129b769 C |
506 | # Amount of import jobs to execute in parallel |
507 | concurrency: 1 | |
508 | ||
3eba7ab8 C |
509 | # Set a custom video import timeout to not block import queue |
510 | timeout: '2 hours' | |
511 | ||
474542d7 C |
512 | # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html |
513 | http: | |
514 | # We recommend to use a HTTP proxy if you enable HTTP import to prevent private URL access from this server | |
515 | # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information | |
5d08a6a7 | 516 | enabled: false |
e0409585 | 517 | |
de7f1114 C |
518 | youtube_dl_release: |
519 | # Direct download URL to youtube-dl binary | |
520 | # Github releases API is also supported | |
521 | # Examples: | |
522 | # * https://api.github.com/repos/ytdl-org/youtube-dl/releases | |
523 | # * https://api.github.com/repos/yt-dlp/yt-dlp/releases | |
f7569270 C |
524 | # * https://yt-dl.org/downloads/latest/youtube-dl |
525 | url: 'https://api.github.com/repos/yt-dlp/yt-dlp/releases' | |
de7f1114 | 526 | |
f7569270 C |
527 | # Release binary name: 'yt-dlp' or 'youtube-dl' |
528 | name: 'yt-dlp' | |
de7f1114 | 529 | |
22c77786 F |
530 | # Path to the python binary to execute for youtube-dl or yt-dlp |
531 | python_path: '/usr/bin/python3' | |
532 | ||
677012b4 | 533 | # IPv6 is very strongly rate-limited on most sites supported by youtube-dl |
e0409585 C |
534 | force_ipv4: false |
535 | ||
474542d7 C |
536 | # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file) |
537 | torrent: | |
538 | # We recommend to only enable magnet URI/torrent import if you trust your users | |
539 | # See https://docs.joinpeertube.org/maintain-configuration?id=security for more information | |
a84b8fa5 | 540 | enabled: false |
5d08a6a7 | 541 | |
7ccddd7b JM |
542 | auto_blacklist: |
543 | # New videos automatically blacklisted so moderators can review before publishing | |
544 | videos: | |
545 | of_users: | |
5b9c965d C |
546 | enabled: false |
547 | ||
95540ed2 | 548 | # Instance settings |
66b16caf C |
549 | instance: |
550 | name: 'PeerTube' | |
51de2c7f | 551 | short_description: 'PeerTube, an ActivityPub-federated video streaming platform using P2P directly in your web browser.' |
8ae03c37 C |
552 | description: 'Welcome to this PeerTube instance!' # Support markdown |
553 | terms: 'No terms for now.' # Support markdown | |
554 | code_of_conduct: '' # Supports markdown | |
555 | ||
556 | # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc | |
557 | moderation_information: '' # Supports markdown | |
558 | ||
559 | # Why did you create this instance? | |
d605328a | 560 | creation_reason: '' # Supports Markdown |
8ae03c37 C |
561 | |
562 | # Who is behind the instance? A single person? A non profit? | |
d605328a | 563 | administrator: '' # Supports Markdown |
8ae03c37 C |
564 | |
565 | # How long do you plan to maintain this instance? | |
d605328a | 566 | maintenance_lifetime: '' # Supports Markdown |
8ae03c37 | 567 | |
96a4a7c3 | 568 | # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising? |
d605328a | 569 | business_model: '' # Supports Markdown |
8ae03c37 | 570 | |
be04c6fd | 571 | # If you want to explain on what type of hardware your PeerTube instance runs |
97b6428a | 572 | # Example: '2 vCore, 2GB RAM...' |
be04c6fd C |
573 | hardware_information: '' # Supports Markdown |
574 | ||
8ae03c37 C |
575 | # What are the main languages of your instance? To interact with your users for example |
576 | # Uncomment or add the languages you want | |
577 | # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages | |
578 | languages: | |
579 | # - en | |
580 | # - es | |
581 | # - fr | |
582 | ||
583 | # You can specify the main categories of your instance (dedicated to music, gaming or politics etc) | |
584 | # Uncomment or add the category ids you want | |
585 | # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories | |
586 | categories: | |
587 | # - 1 # Music | |
588 | # - 2 # Films | |
589 | # - 3 # Vehicles | |
590 | # - 4 # Art | |
591 | # - 5 # Sports | |
592 | # - 6 # Travels | |
593 | # - 7 # Gaming | |
594 | # - 8 # People | |
595 | # - 9 # Comedy | |
596 | # - 10 # Entertainment | |
597 | # - 11 # News & Politics | |
598 | # - 12 # How To | |
599 | # - 13 # Education | |
600 | # - 14 # Activism | |
601 | # - 15 # Science & Technology | |
602 | # - 16 # Animals | |
603 | # - 17 # Kids | |
604 | # - 18 # Food | |
605 | ||
901637bb | 606 | default_client_route: '/videos/trending' |
8ae03c37 | 607 | |
f8802489 C |
608 | # Whether or not the instance is dedicated to NSFW content |
609 | # Enabling it will allow other administrators to know that you are mainly federating sensitive content | |
610 | # Moreover, the NSFW checkbox on video upload will be automatically checked by default | |
611 | is_nsfw: false | |
97b6428a | 612 | # By default, `do_not_list` or `blur` or `display` NSFW videos |
0883b324 C |
613 | # Could be overridden per user with a setting |
614 | default_nsfw_policy: 'do_not_list' | |
8ae03c37 | 615 | |
00b5556c C |
616 | customizations: |
617 | javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime | |
618 | css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime | |
97b6428a | 619 | # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add `/` to `Disallow:` |
ac235c37 RK |
620 | robots: | |
621 | User-agent: * | |
df182b37 | 622 | Disallow: |
de7f1114 | 623 | # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string |
5447516b | 624 | securitytxt: |
97b6428a | 625 | '# 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:' |
8be1afa1 C |
626 | |
627 | services: | |
628 | # Cards configuration to format video in Twitter | |
629 | twitter: | |
351d5225 | 630 | username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published |
8be1afa1 C |
631 | # If true, a video player will be embedded in the Twitter feed on PeerTube video share |
632 | # If false, we use an image link card that will redirect on your PeerTube instance | |
97b6428a | 633 | # Change it to `true`, and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted |
19f7b248 | 634 | whitelisted: false |
5b9c965d C |
635 | |
636 | followers: | |
637 | instance: | |
638 | # Allow or not other instances to follow yours | |
639 | enabled: true | |
14893eb7 C |
640 | # Whether or not an administrator must manually validate a new follower |
641 | manual_approval: false | |
7cd4d2ba | 642 | |
8424c402 C |
643 | followings: |
644 | instance: | |
645 | # If you want to automatically follow back new instance followers | |
646 | # If this option is enabled, use the mute feature instead of deleting followings | |
647 | # /!\ Don't enable this if you don't have a reactive moderation team /!\ | |
648 | auto_follow_back: | |
649 | enabled: false | |
650 | ||
651 | # If you want to automatically follow instances of the public index | |
652 | # If this option is enabled, use the mute feature instead of deleting followings | |
653 | # /!\ Don't enable this if you don't have a reactive moderation team /!\ | |
654 | auto_follow_index: | |
655 | enabled: false | |
95cd31f1 C |
656 | # Host your own using https://framagit.org/framasoft/peertube/instances-peertube#peertube-auto-follow |
657 | index_url: '' | |
8424c402 | 658 | |
7cd4d2ba C |
659 | theme: |
660 | default: 'default' | |
72c33e71 C |
661 | |
662 | broadcast_message: | |
663 | enabled: false | |
664 | message: '' # Support markdown | |
665 | level: 'info' # 'info' | 'warning' | 'error' | |
666 | dismissable: false | |
5fb2e288 C |
667 | |
668 | search: | |
669 | # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance | |
670 | # If enabled, the associated group will be able to "escape" from the instance follows | |
671 | # That means they will be able to follow channels, watch videos, list videos of non followed instances | |
672 | remote_uri: | |
673 | users: true | |
674 | anonymous: false | |
675 | ||
676 | # Use a third party index instead of your local index, only for search results | |
677 | # Useful to discover content outside of your instance | |
678 | # If you enable search_index, you must enable remote_uri search for users | |
679 | # If you do not enable remote_uri search for anonymous user, your instance will redirect the user on the origin instance | |
680 | # instead of loading the video locally | |
681 | search_index: | |
682 | enabled: false | |
683 | # URL of the search index, that should use the same search API and routes | |
684 | # than PeerTube: https://docs.joinpeertube.org/api-rest-reference.html | |
685 | # You should deploy your own with https://framagit.org/framasoft/peertube/search-index, | |
686 | # and can use https://search.joinpeertube.org/ for tests, but keep in mind the latter is an unmoderated search index | |
687 | url: '' | |
688 | # You can disable local search, so users only use the search index | |
689 | disable_local_search: false | |
690 | # If you did not disable local search, you can decide to use the search index by default | |
691 | is_default_search: false | |
3cf68b86 C |
692 | |
693 | # PeerTube client/interface configuration | |
694 | client: | |
695 | videos: | |
696 | miniature: | |
697 | # By default PeerTube client displays author username | |
698 | prefer_author_display_name: false | |
2c102aac | 699 | display_author_avatar: false |
60233e90 | 700 | resumable_upload: |
701 | # Max size of upload chunks, e.g. '90MB' | |
702 | # If null, it will be calculated based on network speed | |
703 | max_chunk_size: null | |
3cf68b86 C |
704 | |
705 | menu: | |
706 | login: | |
707 | # If you enable only one external auth plugin | |
708 | # You can automatically redirect your users on this external platform when they click on the login button | |
709 | redirect_on_single_external_auth: false |