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