home · contact · privacy
Add local PeerTube config.
[config] / buster / other_files / peertube_production.yaml
1 listen:
2   hostname: 'localhost'
3   port: 9000
4
5 # Correspond to your reverse proxy server_name/listen configuration
6 webserver:
7   https: true
8   hostname: 'example.com'
9   port: 443
10
11 rates_limit:
12   api:
13     # 50 attempts in 10 seconds
14     window: 10 seconds
15     max: 50
16   login:
17     # 15 attempts in 5 min
18     window: 5 minutes
19     max: 15
20   signup:
21     # 2 attempts in 5 min (only succeeded attempts are taken into account)
22     window: 5 minutes
23     max: 2
24   ask_send_email:
25     # 3 attempts in 5 min
26     window: 5 minutes
27     max: 3
28
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
35 # Your database name will be "peertube"+database.suffix
36 database:
37   hostname: 'localhost'
38   port: 5432
39   suffix: '_prod'
40   username: 'peertube'
41   pool:
42     max: 5
43
44 # Redis server for short time storage
45 # You can also specify a 'socket' path to a unix socket but first need to
46 # comment out hostname and port
47 redis:
48   hostname: 'localhost'
49   port: 6379
50   auth: null
51   db: 0
52
53 # SMTP server to send emails
54 smtp:
55   hostname: null
56   port: 465 # If you use StartTLS: 587
57   username: null
58   password: null
59   tls: true # If you use StartTLS: false
60   disable_starttls: false
61   ca_file: null # Used for self signed certificates
62   from_address: 'admin@example.com'
63
64 email:
65   body:
66     signature: "PeerTube"
67   subject:
68     prefix: "[PeerTube]"
69
70 # From the project root directory
71 storage:
72   tmp: '/var/www/peertube/storage/tmp/' # Use to download data (imports etc), store uploaded files before processing...
73   avatars: '/var/www/peertube/storage/avatars/'
74   videos: '/var/www/peertube/storage/videos/'
75   streaming_playlists: '/var/www/peertube/storage/streaming-playlists/'
76   redundancy: '/var/www/peertube/storage/redundancy/'
77   logs: '/var/www/peertube/storage/logs/'
78   previews: '/var/www/peertube/storage/previews/'
79   thumbnails: '/var/www/peertube/storage/thumbnails/'
80   torrents: '/var/www/peertube/storage/torrents/'
81   captions: '/var/www/peertube/storage/captions/'
82   cache: '/var/www/peertube/storage/cache/'
83   plugins: '/var/www/peertube/storage/plugins/'
84
85 log:
86   level: 'info' # debug/info/warning/error
87   rotation:
88     enabled : true # Enabled by default, if disabled make sure that 'storage.logs' is pointing to a folder handled by logrotate
89     maxFileSize: 12MB
90     maxFiles: 20
91   anonymizeIP: false
92
93 search:
94   # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
95   # If enabled, the associated group will be able to "escape" from the instance follows
96   # That means they will be able to follow channels, watch videos, list videos of non followed instances
97   remote_uri:
98     users: true
99     anonymous: false
100
101 trending:
102   videos:
103     interval_days: 7 # Compute trending videos for the last x days
104
105 # Cache remote videos on your server, to help other instances to broadcast the video
106 # You can define multiple caches using different sizes/strategies
107 # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
108 redundancy:
109   videos:
110     check_interval: '1 hour' # How often you want to check new videos to cache
111     strategies: # Just uncomment strategies you want
112 #      -
113 #        size: '10GB'
114 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
115 #        min_lifetime: '48 hours'
116 #        strategy: 'most-views' # Cache videos that have the most views
117 #      -
118 #        size: '10GB'
119 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
120 #        min_lifetime: '48 hours'
121 #        strategy: 'trending' # Cache trending videos
122 #      -
123 #        size: '10GB'
124 #        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
125 #        min_lifetime: '48 hours'
126 #        strategy: 'recently-added' # Cache recently added videos
127 #        min_views: 10 # Having at least x views
128
129 csp:
130   enabled: false
131   report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk!
132   report_uri:
133
134 tracker:
135   # If you disable the tracker, you disable the P2P aspect of PeerTube
136   enabled: true
137   # Only handle requests on your videos.
138   # If you set this to false it means you have a public tracker.
139   # Then, it is possible that clients overload your instance with external torrents
140   private: true
141   # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers)
142   reject_too_many_announces: false
143
144 history:
145   videos:
146     # If you want to limit users videos history
147     # -1 means there is no limitations
148     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
149     max_age: -1
150
151 views:
152   videos:
153     # PeerTube creates a database entry every hour for each video to track views over a period of time
154     # This is used in particular by the Trending page
155     # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered)
156     # -1 means no cleanup
157     # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database)
158     remote:
159       max_age: -1
160
161 plugins:
162   # The website PeerTube will ask for available PeerTube plugins and themes
163   # This is an unmoderated plugin index, so only install plugins/themes you trust
164   index:
165     enabled: true
166     check_latest_versions_interval: '12 hours' # How often you want to check new plugins/themes versions
167     url: 'https://packages.joinpeertube.org'
168
169
170 ###############################################################################
171 #
172 # From this point, all the following keys can be overridden by the web interface
173 # (local-production.json file). If you need to change some values, prefer to
174 # use the web interface because the configuration will be automatically
175 # reloaded without any need to restart PeerTube.
176 #
177 # /!\ If you already have a local-production.json file, the modification of the
178 # following keys will have no effect /!\.
179 #
180 ###############################################################################
181
182 cache:
183   previews:
184     size: 500 # Max number of previews you want to cache
185   captions:
186     size: 500 # Max number of video captions/subtitles you want to cache
187
188 admin:
189   # Used to generate the root user at first startup
190   # And to receive emails from the contact form
191   email: 'admin@example.com'
192
193 contact_form:
194   enabled: true
195
196 signup:
197   enabled: false 
198   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
199   requires_email_verification: false
200   filters:
201     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
202       whitelist: []
203       blacklist: []
204
205 user:
206   # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
207   # -1 == unlimited
208   video_quota: -1
209   video_quota_daily: -1
210
211 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
212 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
213 # Please, do not disable transcoding since many uploaded videos will not work
214 transcoding:
215   enabled: true
216   # Allow your users to upload .mkv, .mov, .avi, .flv videos
217   allow_additional_extensions: true
218   # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file
219   allow_audio_files: true
220   threads: 1
221   resolutions: # Only created if the original video has a higher resolution, uses more storage!
222     0p: false # audio-only (creates mp4 without video stream, always created when enabled)
223     240p: false
224     360p: false
225     480p: false
226     720p: false
227     1080p: false
228     2160p: false
229
230   # Generate videos in a WebTorrent format (what we do since the first PeerTube release)
231   # If you also enabled the hls format, it will multiply videos storage by 2
232   # If disabled, breaks federation with PeerTube instances < 2.1
233   webtorrent:
234     enabled: true
235
236   # /!\ Requires ffmpeg >= 4.1
237   # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent:
238   #     * Resolution change is smoother
239   #     * Faster playback in particular with long videos
240   #     * More stable playback (less bugs/infinite loading)
241   # If you also enabled the webtorrent format, it will multiply videos storage by 2
242   hls:
243     enabled: false
244
245 import:
246   # Add ability for your users to import remote videos (from YouTube, torrent...)
247   videos:
248     http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
249       enabled: false
250       # You can use an HTTP/HTTPS/SOCKS proxy with youtube-dl
251       proxy:
252         enabled: false
253         url: ""
254     torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
255       enabled: false
256
257 auto_blacklist:
258   # New videos automatically blacklisted so moderators can review before publishing
259   videos:
260     of_users:
261       enabled: false
262
263 # Instance settings
264 instance:
265   name: 'PeerTube'
266   short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
267   description: 'Welcome to this PeerTube instance!' # Support markdown
268   terms: 'No terms for now.' # Support markdown
269   code_of_conduct: '' # Supports markdown
270
271   # Who moderates the instance? What is the policy regarding NSFW videos? Political videos? etc
272   moderation_information: '' # Supports markdown
273
274   # Why did you create this instance?
275   creation_reason: ''
276
277   # Who is behind the instance? A single person? A non profit?
278   administrator: ''
279
280   # How long do you plan to maintain this instance?
281   maintenance_lifetime: ''
282
283   # How will you pay the PeerTube instance server? With your own funds? With users donations? Advertising?
284   business_model: ''
285
286   # If you want to explain on what type of hardware your PeerTube instance runs
287   # Example: "2 vCore, 2GB RAM..."
288   hardware_information: '' # Supports Markdown
289
290   # What are the main languages of your instance? To interact with your users for example
291   # Uncomment or add the languages you want
292   # List of supported languages: https://peertube.cpy.re/api/v1/videos/languages
293   languages:
294 #    - en
295 #    - es
296 #    - fr
297
298   # You can specify the main categories of your instance (dedicated to music, gaming or politics etc)
299   # Uncomment or add the category ids you want
300   # List of supported categories: https://peertube.cpy.re/api/v1/videos/categories
301   categories:
302 #    - 1  # Music
303 #    - 2  # Films
304 #    - 3  # Vehicles
305 #    - 4  # Art
306 #    - 5  # Sports
307 #    - 6  # Travels
308 #    - 7  # Gaming
309 #    - 8  # People
310 #    - 9  # Comedy
311 #    - 10 # Entertainment
312 #    - 11 # News & Politics
313 #    - 12 # How To
314 #    - 13 # Education
315 #    - 14 # Activism
316 #    - 15 # Science & Technology
317 #    - 16 # Animals
318 #    - 17 # Kids
319 #    - 18 # Food
320
321   default_client_route: '/videos/trending'
322
323   # Whether or not the instance is dedicated to NSFW content
324   # Enabling it will allow other administrators to know that you are mainly federating sensitive content
325   # Moreover, the NSFW checkbox on video upload will be automatically checked by default
326   is_nsfw: false
327   # By default, "do_not_list" or "blur" or "display" NSFW videos
328   # Could be overridden per user with a setting
329   default_nsfw_policy: 'do_not_list'
330
331   customizations:
332     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
333     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
334   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
335   robots: |
336     User-agent: *
337     Disallow:
338   # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
339   securitytxt:
340     "# 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:"
341
342 services:
343   # Cards configuration to format video in Twitter
344   twitter:
345     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
346     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
347     # If false, we use an image link card that will redirect on your PeerTube instance
348     # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
349     whitelisted: false
350
351 followers:
352   instance:
353     # Allow or not other instances to follow yours
354     enabled: true
355     # Whether or not an administrator must manually validate a new follower
356     manual_approval: false
357
358 followings:
359   instance:
360     # If you want to automatically follow back new instance followers
361     # If this option is enabled, use the mute feature instead of deleting followings
362     # /!\ Don't enable this if you don't have a reactive moderation team /!\
363     auto_follow_back:
364       enabled: false
365
366     # If you want to automatically follow instances of the public index
367     # If this option is enabled, use the mute feature instead of deleting followings
368     # /!\ Don't enable this if you don't have a reactive moderation team /!\
369     auto_follow_index:
370       enabled: false
371       index_url: 'https://instances.joinpeertube.org'
372
373 theme:
374   default: 'default'