]>
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 | ||
7 | webserver: | |
8 | https: false | |
3737bbaf | 9 | hostname: 'localhost' |
8c308c2b C |
10 | port: 9000 |
11 | ||
490b595a C |
12 | # Proxies to trust to get real client IP |
13 | # If you run PeerTube just behind a local proxy (nginx), keep 'loopback' | |
14 | # If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet) | |
15 | trust_proxy: | |
16 | - 'loopback' | |
17 | ||
98dffd10 | 18 | # Your database name will be "peertube"+database.suffix |
8c308c2b | 19 | database: |
3737bbaf | 20 | hostname: 'localhost' |
feb4bdfd C |
21 | port: 5432 |
22 | suffix: '_dev' | |
55fa55a9 C |
23 | username: 'peertube' |
24 | password: 'peertube' | |
1c3386e8 RK |
25 | pool: |
26 | max: 5 | |
8c308c2b | 27 | |
19f7b248 RK |
28 | # You can also specify a 'socket' path to a unix socket but first need to |
29 | # comment out hostname and port | |
94a5ff8a C |
30 | redis: |
31 | hostname: 'localhost' | |
32 | port: 6379 | |
33 | auth: null | |
30c82f0d | 34 | db: 0 |
94a5ff8a | 35 | |
ecb4e35f C |
36 | smtp: |
37 | hostname: null | |
38 | port: 465 | |
39 | username: null | |
40 | password: null | |
41 | tls: true | |
bebf2d89 | 42 | disable_starttls: false |
ecb4e35f C |
43 | ca_file: null # Used for self signed certificates |
44 | from_address: 'admin@example.com' | |
45 | ||
8c308c2b C |
46 | # From the project root directory |
47 | storage: | |
6040f87d | 48 | tmp: 'storage/tmp/' # Used to download data (imports etc), store uploaded files before processing... |
6b2ef589 | 49 | avatars: 'storage/avatars/' |
6b2ef589 | 50 | videos: 'storage/videos/' |
9c6ca37f | 51 | streaming_playlists: 'storage/streaming-playlists/' |
6040f87d | 52 | redundancy: 'storage/redundancy/' |
6b2ef589 C |
53 | logs: 'storage/logs/' |
54 | previews: 'storage/previews/' | |
55 | thumbnails: 'storage/thumbnails/' | |
56 | torrents: 'storage/torrents/' | |
40e87e9e | 57 | captions: 'storage/captions/' |
6b2ef589 | 58 | cache: 'storage/cache/' |
f981dae8 | 59 | |
23e27dd5 | 60 | log: |
a0922eb9 | 61 | level: 'info' # debug/info/warning/error |
23e27dd5 | 62 | |
1297eb5d | 63 | search: |
8d427346 C |
64 | # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance |
65 | # If enabled, the associated group will be able to "escape" from the instance follows | |
66 | # That means they will be able to follow channels, watch videos, list videos of non followed instances | |
67 | remote_uri: | |
1297eb5d C |
68 | users: true |
69 | anonymous: false | |
70 | ||
9a629c6e C |
71 | trending: |
72 | videos: | |
73 | interval_days: 7 # Compute trending videos for the last x days | |
74 | ||
c48e82b5 C |
75 | # Cache remote videos on your server, to help other instances to broadcast the video |
76 | # You can define multiple caches using different sizes/strategies | |
77 | # Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following | |
78 | redundancy: | |
79 | videos: | |
f9f899b9 | 80 | check_interval: '1 hour' # How often you want to check new videos to cache |
6040f87d | 81 | strategies: # Just uncomment strategies you want |
d9bdd007 C |
82 | # - |
83 | # size: '10GB' | |
e5565833 C |
84 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
85 | # min_lifetime: '48 hours' | |
d9bdd007 C |
86 | # strategy: 'most-views' # Cache videos that have the most views |
87 | # - | |
88 | # size: '10GB' | |
e5565833 C |
89 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
90 | # min_lifetime: '48 hours' | |
d9bdd007 C |
91 | # strategy: 'trending' # Cache trending videos |
92 | # - | |
93 | # size: '10GB' | |
e5565833 C |
94 | # # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances) |
95 | # min_lifetime: '48 hours' | |
d9bdd007 | 96 | # strategy: 'recently-added' # Cache recently added videos |
e5565833 | 97 | # min_views: 10 # Having at least x views |
c48e82b5 | 98 | |
539d3f4f C |
99 | csp: |
100 | enabled: false | |
101 | report_only: true # CSP directives are still being tested, so disable the report only mode at your own risk! | |
102 | report_uri: | |
103 | ||
f981dae8 C |
104 | cache: |
105 | previews: | |
f842e810 | 106 | size: 500 # Max number of previews you want to cache |
40e87e9e | 107 | captions: |
f842e810 | 108 | size: 500 # Max number of video captions/subtitles you want to cache |
4793c343 C |
109 | |
110 | admin: | |
a4101923 C |
111 | # Used to generate the root user at first startup |
112 | # And to receive emails from the contact form | |
113 | email: 'admin@example.com' | |
114 | ||
115 | contact_form: | |
116 | enabled: true | |
e22528ac C |
117 | |
118 | signup: | |
119 | enabled: false | |
291e8d3e | 120 | limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited |
d9eaee39 | 121 | requires_email_verification: false |
6401417d | 122 | filters: |
ff2c1fe8 RK |
123 | cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist |
124 | whitelist: [] | |
125 | blacklist: [] | |
227d02fe | 126 | |
b0f9f39e C |
127 | user: |
128 | # Default value of maximum video BYTES the user can upload (does not take into account transcoded files). | |
129 | # -1 == unlimited | |
130 | video_quota: -1 | |
bee0abff | 131 | video_quota_daily: -1 |
b0f9f39e | 132 | |
227d02fe | 133 | # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag |
40298b02 | 134 | # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions. |
09f35e2a | 135 | # Please, do not disable transcoding since many uploaded videos will not work |
227d02fe | 136 | transcoding: |
1125c40a | 137 | enabled: true |
14e2014a C |
138 | # Allow your users to upload .mkv, .mov, .avi, .flv videos |
139 | allow_additional_extensions: true | |
98f535a5 | 140 | threads: 1 |
09f35e2a | 141 | resolutions: # Only created if the original video has a higher resolution, uses more storage! |
1125c40a C |
142 | 240p: false |
143 | 360p: false | |
144 | 480p: false | |
145 | 720p: false | |
146 | 1080p: false | |
09209296 | 147 | # /!\ EXPERIMENTAL /!\ |
7f8f8bdb C |
148 | # /!\ Requires ffmpeg >= 4 |
149 | # Generate HLS playlists and fragmented MP4 files. Better playback than with WebTorrent: | |
09209296 C |
150 | # * Resolution change is smoother |
151 | # * Faster playback in particular with long videos | |
152 | # * More stable playback (less bugs/infinite loading) | |
7f8f8bdb | 153 | # /!\ Multiply videos storage by 2 /!\ |
09209296 C |
154 | hls: |
155 | enabled: false | |
66b16caf | 156 | |
fbad87b0 C |
157 | import: |
158 | # Add ability for your users to import remote videos (from YouTube, torrent...) | |
159 | videos: | |
160 | http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html | |
5d08a6a7 | 161 | enabled: false |
a84b8fa5 C |
162 | torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file) |
163 | enabled: false | |
fbad87b0 | 164 | |
7ccddd7b JM |
165 | auto_blacklist: |
166 | # New videos automatically blacklisted so moderators can review before publishing | |
167 | videos: | |
168 | of_users: | |
169 | enabled: false | |
170 | ||
66b16caf C |
171 | instance: |
172 | name: 'PeerTube' | |
2e3a0215 | 173 | short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.' |
bf874e33 C |
174 | description: 'Welcome to this PeerTube instance!' # Support markdown |
175 | terms: 'No terms for now.' # Support markdown | |
901637bb | 176 | default_client_route: '/videos/trending' |
f8802489 C |
177 | # Whether or not the instance is dedicated to NSFW content |
178 | # Enabling it will allow other administrators to know that you are mainly federating sensitive content | |
179 | # Moreover, the NSFW checkbox on video upload will be automatically checked by default | |
180 | is_nsfw: false | |
0883b324 C |
181 | # By default, "do_not_list" or "blur" or "display" NSFW videos |
182 | # Could be overridden per user with a setting | |
183 | default_nsfw_policy: 'do_not_list' | |
00b5556c C |
184 | customizations: |
185 | javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime | |
186 | css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime | |
78881bc4 | 187 | # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:' |
ac235c37 RK |
188 | robots: | |
189 | User-agent: * | |
df182b37 | 190 | Disallow: |
5447516b AH |
191 | # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string. |
192 | securitytxt: | |
1f4f1510 | 193 | "# 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 |
194 | |
195 | services: | |
196 | # Cards configuration to format video in Twitter | |
197 | twitter: | |
351d5225 | 198 | username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published |
8be1afa1 C |
199 | # If true, a video player will be embedded in the Twitter feed on PeerTube video share |
200 | # If false, we use an image link card that will redirect on your PeerTube instance | |
201 | # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted | |
202 | whitelisted: false |