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