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