]>
Commit | Line | Data |
---|---|---|
552cc9d6 | 1 | listen: |
cff8b272 | 2 | hostname: 'localhost' |
552cc9d6 C |
3 | port: 9000 |
4 | ||
f37dc0dd | 5 | # Correspond to your reverse proxy server_name/listen configuration |
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 | ||
98dffd10 | 35 | # Your database name will be "peertube"+database.suffix |
825a5d9c | 36 | database: |
552cc9d6 C |
37 | hostname: 'localhost' |
38 | port: 5432 | |
feb4bdfd | 39 | suffix: '_prod' |
6c05c149 C |
40 | username: 'peertube' |
41 | password: 'peertube' | |
1c3386e8 RK |
42 | pool: |
43 | max: 5 | |
552cc9d6 | 44 | |
95540ed2 | 45 | # Redis server for short time storage |
19f7b248 RK |
46 | # You can also specify a 'socket' path to a unix socket but first need to |
47 | # comment out hostname and port | |
94a5ff8a C |
48 | redis: |
49 | hostname: 'localhost' | |
50 | port: 6379 | |
51 | auth: null | |
30c82f0d | 52 | db: 0 |
94a5ff8a | 53 | |
95540ed2 | 54 | # SMTP server to send emails |
ecb4e35f C |
55 | smtp: |
56 | hostname: null | |
6401417d | 57 | port: 465 # If you use StartTLS: 587 |
ecb4e35f C |
58 | username: null |
59 | password: null | |
6401417d | 60 | tls: true # If you use StartTLS: false |
bebf2d89 | 61 | disable_starttls: false |
ecb4e35f C |
62 | ca_file: null # Used for self signed certificates |
63 | from_address: 'admin@example.com' | |
64 | ||
dd2c2a52 C |
65 | email: |
66 | body: | |
67 | signature: "PeerTube" | |
68 | object: | |
69 | prefix: "[PeerTube]" | |
70 | ||
552cc9d6 C |
71 | # From the project root directory |
72 | storage: | |
6040f87d | 73 | tmp: '/var/www/peertube/storage/tmp/' # Used to download data (imports etc), store uploaded files before processing... |
59c48d49 C |
74 | avatars: '/var/www/peertube/storage/avatars/' |
75 | videos: '/var/www/peertube/storage/videos/' | |
0b16f5f2 | 76 | streaming_playlists: '/var/www/peertube/storage/streaming-playlists/' |
6040f87d | 77 | redundancy: '/var/www/peertube/storage/videos/' |
59c48d49 C |
78 | logs: '/var/www/peertube/storage/logs/' |
79 | previews: '/var/www/peertube/storage/previews/' | |
80 | thumbnails: '/var/www/peertube/storage/thumbnails/' | |
81 | torrents: '/var/www/peertube/storage/torrents/' | |
40e87e9e | 82 | captions: '/var/www/peertube/storage/captions/' |
59c48d49 | 83 | cache: '/var/www/peertube/storage/cache/' |
345da516 | 84 | plugins: '/var/www/peertube/storage/plugins/' |
4793c343 | 85 | |
23e27dd5 | 86 | log: |
a0922eb9 | 87 | level: 'info' # debug/info/warning/error |
fcf4569f NB |
88 | rotation: |
89 | enabled : true | |
23e27dd5 | 90 | |
1297eb5d | 91 | search: |
8d427346 C |
92 | # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance |
93 | # If enabled, the associated group will be able to "escape" from the instance follows | |
94 | # That means they will be able to follow channels, watch videos, list videos of non followed instances | |
95 | remote_uri: | |
1297eb5d C |
96 | users: true |
97 | anonymous: false | |
509cd56a | 98 | |
9a629c6e C |
99 | trending: |
100 | videos: | |
101 | interval_days: 7 # Compute trending videos for the last x days | |
102 | ||
c48e82b5 C |
103 | # Cache remote videos on your server, to help other instances to broadcast the video |
104 | # You can define multiple caches using different sizes/strategies | |
105 | # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following | |
106 | redundancy: | |
107 | videos: | |
f9f899b9 | 108 | check_interval: '1 hour' # How often you want to check new videos to cache |
6040f87d | 109 | strategies: # Just uncomment strategies you want |
d9bdd007 C |
110 | # - |
111 | # size: '10GB' | |
e5565833 C |
112 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
113 | # min_lifetime: '48 hours' | |
d9bdd007 C |
114 | # strategy: 'most-views' # Cache videos that have the most views |
115 | # - | |
116 | # size: '10GB' | |
e5565833 C |
117 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
118 | # min_lifetime: '48 hours' | |
d9bdd007 C |
119 | # strategy: 'trending' # Cache trending videos |
120 | # - | |
121 | # size: '10GB' | |
e5565833 C |
122 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
123 | # min_lifetime: '48 hours' | |
d9bdd007 | 124 | # strategy: 'recently-added' # Cache recently added videos |
e5565833 | 125 | # min_views: 10 # Having at least x views |
c48e82b5 | 126 | |
539d3f4f C |
127 | csp: |
128 | enabled: false | |
129 | report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk! | |
130 | report_uri: | |
131 | ||
31b6ddf8 C |
132 | tracker: |
133 | # If you disable the tracker, you disable the P2P aspect of PeerTube | |
134 | enabled: true | |
135 | # Only handle requests on your videos. | |
136 | # If you set this to false it means you have a public tracker. | |
137 | # Then, it is possible that clients overload your instance with external torrents | |
138 | private: true | |
139 | # Reject peers that do a lot of announces (could improve privacy of TCP/UDP peers) | |
140 | reject_too_many_announces: false | |
141 | ||
8f0bc73d C |
142 | history: |
143 | videos: | |
144 | # If you want to limit users videos history | |
145 | # -1 means there is no limitations | |
146 | # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database) | |
147 | max_age: -1 | |
539d3f4f | 148 | |
cda03765 C |
149 | views: |
150 | videos: | |
151 | # PeerTube creates a database entry every hour for each video to track views over a period of time | |
152 | # This is used in particular by the Trending page | |
153 | # PeerTube could remove old remote video views if you want to reduce your database size (video view counter will not be altered) | |
154 | # -1 means no cleanup | |
155 | # Other values could be '6 months' or '30 days' etc (PeerTube will periodically delete old entries from database) | |
156 | remote: | |
157 | max_age: -1 | |
158 | ||
6702a1b2 C |
159 | plugins: |
160 | # The website PeerTube will ask for available PeerTube plugins | |
161 | # This is an unmoderated plugin index, so only install plugins you trust | |
162 | index: | |
163 | enabled: true | |
d133f385 | 164 | check_latest_versions_interval: '1 day' # How often you want to check new plugins/themes versions |
6702a1b2 C |
165 | url: 'https://packages.joinpeertube.org' |
166 | ||
cda03765 | 167 | |
509cd56a C |
168 | ############################################################################### |
169 | # | |
f209b32a | 170 | # From this point, all the following keys can be overridden by the web interface |
509cd56a C |
171 | # (local-production.json file). If you need to change some values, prefer to |
172 | # use the web interface because the configuration will be automatically | |
173 | # reloaded without any need to restart PeerTube. | |
174 | # | |
175 | # /!\ If you already have a local-production.json file, the modification of the | |
176 | # following keys will have no effect /!\. | |
177 | # | |
178 | ############################################################################### | |
179 | ||
62ccb24e C |
180 | cache: |
181 | previews: | |
f842e810 C |
182 | size: 500 # Max number of previews you want to cache |
183 | captions: | |
184 | size: 500 # Max number of video captions/subtitles you want to cache | |
62ccb24e | 185 | |
4793c343 | 186 | admin: |
a4101923 C |
187 | # Used to generate the root user at first startup |
188 | # And to receive emails from the contact form | |
4793c343 | 189 | email: 'admin@example.com' |
e22528ac | 190 | |
a4101923 C |
191 | contact_form: |
192 | enabled: true | |
193 | ||
e22528ac C |
194 | signup: |
195 | enabled: false | |
62ccb24e | 196 | limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited |
d9eaee39 | 197 | requires_email_verification: false |
6401417d | 198 | filters: |
ff2c1fe8 RK |
199 | cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist |
200 | whitelist: [] | |
201 | blacklist: [] | |
227d02fe | 202 | |
b0f9f39e C |
203 | user: |
204 | # Default value of maximum video BYTES the user can upload (does not take into account transcoded files). | |
205 | # -1 == unlimited | |
206 | video_quota: -1 | |
bee0abff | 207 | video_quota_daily: -1 |
b0f9f39e | 208 | |
227d02fe | 209 | # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag |
09f35e2a C |
210 | # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions. |
211 | # Please, do not disable transcoding since many uploaded videos will not work | |
227d02fe | 212 | transcoding: |
1125c40a | 213 | enabled: true |
14e2014a C |
214 | # Allow your users to upload .mkv, .mov, .avi, .flv videos |
215 | allow_additional_extensions: true | |
536598cf C |
216 | # If a user uploads an audio file, PeerTube will create a video by merging the preview file and the audio file |
217 | allow_audio_files: true | |
98f535a5 | 218 | threads: 1 |
09f35e2a | 219 | resolutions: # Only created if the original video has a higher resolution, uses more storage! |
1125c40a C |
220 | 240p: false |
221 | 360p: false | |
222 | 480p: false | |
223 | 720p: false | |
224 | 1080p: false | |
ad3405d0 | 225 | 2160p: false |
09209296 | 226 | # /!\ EXPERIMENTAL /!\ |
7f8f8bdb C |
227 | # /!\ Requires ffmpeg >= 4 |
228 | # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent: | |
09209296 C |
229 | # * Resolution change is smoother |
230 | # * Faster playback in particular with long videos | |
231 | # * More stable playback (less bugs/infinite loading) | |
2ed67a7d | 232 | # /!\ Multiplies videos storage by 2 /!\ |
09209296 C |
233 | hls: |
234 | enabled: false | |
66b16caf | 235 | |
5d08a6a7 C |
236 | import: |
237 | # Add ability for your users to import remote videos (from YouTube, torrent...) | |
238 | videos: | |
239 | http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html | |
240 | enabled: false | |
a84b8fa5 C |
241 | torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file) |
242 | enabled: false | |
5d08a6a7 | 243 | |
7ccddd7b JM |
244 | auto_blacklist: |
245 | # New videos automatically blacklisted so moderators can review before publishing | |
246 | videos: | |
247 | of_users: | |
5b9c965d C |
248 | enabled: false |
249 | ||
95540ed2 | 250 | # Instance settings |
66b16caf C |
251 | instance: |
252 | name: 'PeerTube' | |
2e3a0215 | 253 | short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.' |
66b16caf C |
254 | description: '' # Support markdown |
255 | terms: '' # Support markdown | |
901637bb | 256 | default_client_route: '/videos/trending' |
f8802489 C |
257 | # Whether or not the instance is dedicated to NSFW content |
258 | # Enabling it will allow other administrators to know that you are mainly federating sensitive content | |
259 | # Moreover, the NSFW checkbox on video upload will be automatically checked by default | |
260 | is_nsfw: false | |
0883b324 C |
261 | # By default, "do_not_list" or "blur" or "display" NSFW videos |
262 | # Could be overridden per user with a setting | |
263 | default_nsfw_policy: 'do_not_list' | |
00b5556c C |
264 | customizations: |
265 | javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime | |
266 | css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime | |
78881bc4 | 267 | # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:' |
ac235c37 RK |
268 | robots: | |
269 | User-agent: * | |
df182b37 | 270 | Disallow: |
5447516b AH |
271 | # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string. |
272 | securitytxt: | |
1f4f1510 | 273 | "# 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 |
274 | |
275 | services: | |
276 | # Cards configuration to format video in Twitter | |
277 | twitter: | |
351d5225 | 278 | username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published |
8be1afa1 C |
279 | # If true, a video player will be embedded in the Twitter feed on PeerTube video share |
280 | # If false, we use an image link card that will redirect on your PeerTube instance | |
281 | # Test on https://cards-dev.twitter.com/validator to see if you are whitelisted | |
19f7b248 | 282 | whitelisted: false |
5b9c965d C |
283 | |
284 | followers: | |
285 | instance: | |
286 | # Allow or not other instances to follow yours | |
287 | enabled: true | |
14893eb7 C |
288 | # Whether or not an administrator must manually validate a new follower |
289 | manual_approval: false | |
7cd4d2ba C |
290 | |
291 | theme: | |
292 | default: 'default' |