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