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