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