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