draft "security.txt" spec integration (#1020)
[oweals/peertube.git] / config / default.yaml
1 # /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ #
2
3 listen:
4   hostname: '127.0.0.1'
5   port: 9000
6
7 webserver:
8   https: false
9   hostname: 'localhost'
10   port: 9000
11
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
18 # Your database name will be "peertube"+database.suffix
19 database:
20   hostname: 'localhost'
21   port: 5432
22   suffix: '_dev'
23   username: 'peertube'
24   password: 'peertube'
25   pool:
26     max: 5
27
28 # You can also specify a 'socket' path to a unix socket but first need to
29 # comment out hostname and port
30 redis:
31   hostname: 'localhost'
32   port: 6379
33   auth: null
34   db: 0
35
36 smtp:
37   hostname: null
38   port: 465
39   username: null
40   password: null
41   tls: true
42   disable_starttls: false
43   ca_file: null # Used for self signed certificates
44   from_address: 'admin@example.com'
45
46 # From the project root directory
47 storage:
48   avatars: 'storage/avatars/'
49   videos: 'storage/videos/'
50   logs: 'storage/logs/'
51   previews: 'storage/previews/'
52   thumbnails: 'storage/thumbnails/'
53   torrents: 'storage/torrents/'
54   captions: 'storage/captions/'
55   cache: 'storage/cache/'
56
57 log:
58   level: 'info' # debug/info/warning/error
59
60 search:
61   remote_uri: # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
62     users: true
63     anonymous: false
64
65 trending:
66   videos:
67     interval_days: 7 # Compute trending videos for the last x days
68
69 cache:
70   previews:
71     size: 500 # Max number of previews you want to cache
72   captions:
73     size: 500 # Max number of video captions/subtitles you want to cache
74
75 admin:
76   email: 'admin@example.com' # Your personal email as administrator
77
78 signup:
79   enabled: false
80   limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
81   requires_email_verification: false
82   filters:
83     cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
84       whitelist: []
85       blacklist: []
86
87 user:
88   # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
89   # -1 == unlimited
90   video_quota: -1
91   video_quota_daily: -1
92
93 # If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
94 # In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
95 # Please, do not disable transcoding since many uploaded videos will not work
96 transcoding:
97   enabled: true
98   threads: 1
99   resolutions: # Only created if the original video has a higher resolution, uses more storage!
100     240p: false
101     360p: false
102     480p: false
103     720p: false
104     1080p: false
105
106 import:
107   # Add ability for your users to import remote videos (from YouTube, torrent...)
108   videos:
109     http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
110       enabled: false
111     torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
112       enabled: false
113
114 instance:
115   name: 'PeerTube'
116   short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
117   description: 'Welcome to this PeerTube instance!' # Support markdown
118   terms: 'No terms for now.' # Support markdown
119   default_client_route: '/videos/trending'
120   # By default, "do_not_list" or "blur" or "display" NSFW videos
121   # Could be overridden per user with a setting
122   default_nsfw_policy: 'do_not_list'
123   customizations:
124     javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
125     css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
126   # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
127   robots: |
128     User-agent: *
129     Disallow: ''
130   # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
131   securitytxt:
132     "# If you would like to report a security issue\n# you may report it to:\nContact: https://github.com/Chocobozzz/PeerTube\nContact: mailto:"
133
134 services:
135   # Cards configuration to format video in Twitter
136   twitter:
137     username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
138     # If true, a video player will be embedded in the Twitter feed on PeerTube video share
139     # If false, we use an image link card that will redirect on your PeerTube instance
140     # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
141     whitelisted: false