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