[github/Chocobozzz/PeerTube.git] / config / default.yaml

# /!\ YOU SHOULD NOT UPDATE THIS FILE, USE production.yaml instead /!\ #

listen:
  hostname: '127.0.0.1'
  port: 9000

webserver:
  https: false
  hostname: 'localhost'
  port: 9000

# Proxies to trust to get real client IP
# If you run PeerTube just behind a local proxy (nginx), keep 'loopback'
# If you run PeerTube behind a remote proxy, add the proxy IP address (or subnet)
trust_proxy:
  - 'loopback'

# Your database name will be "peertube"+database.suffix
database:
  hostname: 'localhost'
  port: 5432
  suffix: '_dev'
  username: 'peertube'
  password: 'peertube'
  pool:
    max: 5

# You can also specify a 'socket' path to a unix socket but first need to
# comment out hostname and port
redis:
  hostname: 'localhost'
  port: 6379
  auth: null
  db: 0

smtp:
  hostname: null
  port: 465
  username: null
  password: null
  tls: true
  disable_starttls: false
  ca_file: null # Used for self signed certificates
  from_address: 'admin@example.com'

# From the project root directory
storage:
  avatars: 'storage/avatars/'
  videos: 'storage/videos/'
  logs: 'storage/logs/'
  previews: 'storage/previews/'
  thumbnails: 'storage/thumbnails/'
  torrents: 'storage/torrents/'
  captions: 'storage/captions/'
  cache: 'storage/cache/'

log:
  level: 'info' # debug/info/warning/error

search:
  # Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
  # If enabled, the associated group will be able to "escape" from the instance follows
  # That means they will be able to follow channels, watch videos, list videos of non followed instances
  remote_uri:
    users: true
    anonymous: false

trending:
  videos:
    interval_days: 7 # Compute trending videos for the last x days

# Cache remote videos on your server, to help other instances to broadcast the video
# You can define multiple caches using different sizes/strategies
# Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
redundancy:
  videos:
    check_interval: '1 hour' # How often you want to check new videos to cache
    strategies:
#      -
#        size: '10GB'
#        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
#        min_lifetime: '48 hours'
#        strategy: 'most-views' # Cache videos that have the most views
#      -
#        size: '10GB'
#        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
#        min_lifetime: '48 hours'
#        strategy: 'trending' # Cache trending videos
#      -
#        size: '10GB'
#        # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
#        min_lifetime: '48 hours'
#        strategy: 'recently-added' # Cache recently added videos
#        min_views: 10 # Having at least x views

cache:
  previews:
    size: 500 # Max number of previews you want to cache
  captions:
    size: 500 # Max number of video captions/subtitles you want to cache

admin:
  email: 'admin@example.com' # Your personal email as administrator

signup:
  enabled: false
  limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
  requires_email_verification: false
  filters:
    cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
      whitelist: []
      blacklist: []

user:
  # Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
  # -1 == unlimited
  video_quota: -1
  video_quota_daily: -1

# If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
# In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
# Please, do not disable transcoding since many uploaded videos will not work
transcoding:
  enabled: true
  threads: 1
  resolutions: # Only created if the original video has a higher resolution, uses more storage!
    240p: false
    360p: false
    480p: false
    720p: false
    1080p: false

import:
  # Add ability for your users to import remote videos (from YouTube, torrent...)
  videos:
    http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
      enabled: false
    torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
      enabled: false

instance:
  name: 'PeerTube'
  short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
  description: 'Welcome to this PeerTube instance!' # Support markdown
  terms: 'No terms for now.' # Support markdown
  default_client_route: '/videos/trending'
  # By default, "do_not_list" or "blur" or "display" NSFW videos
  # Could be overridden per user with a setting
  default_nsfw_policy: 'do_not_list'
  customizations:
    javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
    css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
  # Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
  robots: |
    User-agent: *
    Disallow:
  # Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
  securitytxt:
    "# 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:"

services:
  # Cards configuration to format video in Twitter
  twitter:
    username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
    # If true, a video player will be embedded in the Twitter feed on PeerTube video share
    # If false, we use an image link card that will redirect on your PeerTube instance
    # Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
    whitelisted: false
Commit	Line	Data
	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	# Add ability to fetch remote videos/actors by their URI, that may not be federated with your instance
	62	# If enabled, the associated group will be able to "escape" from the instance follows
	63	# That means they will be able to follow channels, watch videos, list videos of non followed instances
	64	remote_uri:
	65	users: true
	66	anonymous: false
	67
	68	trending:
	69	videos:
	70	interval_days: 7 # Compute trending videos for the last x days
	71
	72	# Cache remote videos on your server, to help other instances to broadcast the video
	73	# You can define multiple caches using different sizes/strategies
	74	# Once you have defined your strategies, choose which instances you want to cache in admin -> manage follows -> following
	75	redundancy:
	76	videos:
	77	check_interval: '1 hour' # How often you want to check new videos to cache
	78	strategies:
	79	# -
	80	# size: '10GB'
	81	# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
	82	# min_lifetime: '48 hours'
	83	# strategy: 'most-views' # Cache videos that have the most views
	84	# -
	85	# size: '10GB'
	86	# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
	87	# min_lifetime: '48 hours'
	88	# strategy: 'trending' # Cache trending videos
	89	# -
	90	# size: '10GB'
	91	# # Minimum time the video must remain in the cache. Only accept values > 10 hours (to not overload remote instances)
	92	# min_lifetime: '48 hours'
	93	# strategy: 'recently-added' # Cache recently added videos
	94	# min_views: 10 # Having at least x views
	95
	96	cache:
	97	previews:
	98	size: 500 # Max number of previews you want to cache
	99	captions:
	100	size: 500 # Max number of video captions/subtitles you want to cache
	101
	102	admin:
	103	email: 'admin@example.com' # Your personal email as administrator
	104
	105	signup:
	106	enabled: false
	107	limit: 10 # When the limit is reached, registrations are disabled. -1 == unlimited
	108	requires_email_verification: false
	109	filters:
	110	cidr: # You can specify CIDR ranges to whitelist (empty = no filtering) or blacklist
	111	whitelist: []
	112	blacklist: []
	113
	114	user:
	115	# Default value of maximum video BYTES the user can upload (does not take into account transcoded files).
	116	# -1 == unlimited
	117	video_quota: -1
	118	video_quota_daily: -1
	119
	120	# If enabled, the video will be transcoded to mp4 (x264) with "faststart" flag
	121	# In addition, if some resolutions are enabled the mp4 video file will be transcoded to these new resolutions.
	122	# Please, do not disable transcoding since many uploaded videos will not work
	123	transcoding:
	124	enabled: true
	125	threads: 1
	126	resolutions: # Only created if the original video has a higher resolution, uses more storage!
	127	240p: false
	128	360p: false
	129	480p: false
	130	720p: false
	131	1080p: false
	132
	133	import:
	134	# Add ability for your users to import remote videos (from YouTube, torrent...)
	135	videos:
	136	http: # Classic HTTP or all sites supported by youtube-dl https://rg3.github.io/youtube-dl/supportedsites.html
	137	enabled: false
	138	torrent: # Magnet URI or torrent file (use classic TCP/UDP/WebSeed to download the file)
	139	enabled: false
	140
	141	instance:
	142	name: 'PeerTube'
	143	short_description: 'PeerTube, a federated (ActivityPub) video streaming platform using P2P (BitTorrent) directly in the web browser with WebTorrent and Angular.'
	144	description: 'Welcome to this PeerTube instance!' # Support markdown
	145	terms: 'No terms for now.' # Support markdown
	146	default_client_route: '/videos/trending'
	147	# By default, "do_not_list" or "blur" or "display" NSFW videos
	148	# Could be overridden per user with a setting
	149	default_nsfw_policy: 'do_not_list'
	150	customizations:
	151	javascript: '' # Directly your JavaScript code (without <script> tags). Will be eval at runtime
	152	css: '' # Directly your CSS code (without <style> tags). Will be injected at runtime
	153	# Robot.txt rules. To disallow robots to crawl your instance and disallow indexation of your site, add '/' to "Disallow:'
	154	robots: \|
	155	User-agent: *
	156	Disallow:
	157	# Security.txt rules. To discourage researchers from testing your instance and disable security.txt integration, set this to an empty string.
	158	securitytxt:
	159	"# 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:"
	160
	161	services:
	162	# Cards configuration to format video in Twitter
	163	twitter:
	164	username: '@Chocobozzz' # Indicates the Twitter account for the website or platform on which the content was published
	165	# If true, a video player will be embedded in the Twitter feed on PeerTube video share
	166	# If false, we use an image link card that will redirect on your PeerTube instance
	167	# Change it to "true", and then test on https://cards-dev.twitter.com/validator to see if you are whitelisted
	168	whitelisted: false