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