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