Nette Documentation Preview

Nette Configuration

An overview of all configuration options in the Nette Framework.

Nette application is easily configured using configuration files. They are usually written in NEON format. We recommend to use editors with support for this format for editing.

 application: 	Application
constants: Defines PHP constants
database: Database
decorator: Decorator
di: DI Container
extensions: Install additional DI extensions
forms: Forms
http: HTTP Headers
includes: Including files
latte: Latte
mail: Mailing
parameters: Parameters
php: PHP configuration options
routing: Routing
security: Access Control
services: Services
session: Session
tracy: Tracy Debugger

If you use a string that starts with @ or has % anywhere in it, you need to escape it by adding another @ or %.


Basic settings for Nette Application.

	# shows "Nette Application" panel in Tracy BlueScreen?
	debugger: ...           # (bool) defaults to true

	# will error-presenter be called on error?
	catchExceptions: ...    # (bool) defaults to true in production mode

	# name of error-presenter
	errorPresenter: Error   # (string) defaults to 'Nette:Error'

	# do bad links generate warnings?
	# has effect only in developer mode
	silentLinks: ...        # (bool) defaults to false

Because error-presenters are not called by default in development mode and the errors are displayed by Tracy, changing the value catchExceptions to true helps to verify that error-presenters works correct during development.

Option silentLinks determines how Nette behaves in developer mode when link generation fails (for example, because there is no presenter, etc). The default value false means that Nette triggers E_USER_WARNING. Setting to true suppresses this error message. In a production environment, E_USER_WARNING is always invoked. We can also influence this behavior by setting the presenter variable $invalidLinkMode.


Defines the rules according to which the name of the class (for example App\Presenters\HomepagePresenter) is derived from the name of the presenter (for example Homepage). This the mapping can be achieved with the following configuration:

		*: App\Presenters\*Presenter

The presenter name is replaced with an asterisk and the result is the class name. Easy!

If we divide presenters into modules, we can have our own mapping for each module:

		Front: App\Modules\Front\*Presenter
		Admin: App\Modules\Admin\*Presenter
		Api: App\Api\*Presenter

Now presenter Front:Homepage maps to class `App\Modules\Front\HomepagePresenter and presenter Admin:Dashboard to class App\AdminModule\DashboardPresenter.

It will be more handy to create a general (asterisk) rule that will replace the first two rules and add an extra asterisk just for the module:

		*: App\Modules\*\*Presenter
		Api: App\Api\*Presenter

Again, the presenter Front:Homepage maps to the class `App\Modules\Front\HomepagePresenter.

But what if we use nested modules and have a presenter Admin:User:Edit? In this case, the segment with an asterisk representing the module for each level is simply repeated and the result is class App\Modules\Admin\User\EditPresenter.

An alternative notation is to use an array consisting of three segments instead of a string:

		*: [App\Modules, *, *Presenter]

This entry is equivalent to the original App\Modules\*\*Presenter.

The default value is *: *Module\*Presenter.

Automatic Registration of Presenters

Nette automatically adds presenters as services to the DI container, which significantly speeds up their creation. How Nette finds out presenters can be configured:

	# to look for presenters in Composer class map?
	scanComposer: ...      # (bool) defaults to true

	# what string must contain the class and file name?
	scanFilter: ...        # (string) defaults to 'Presenter'

	# in which directories to look for presenters?
	scanDirs:              # (string[]|false) defaults to '%appDir%'
		- %vendorDir%/mymodule

The directories listed in scanDirs do not override the default value %appDir%, but complement it, so scanDirs will contain both paths %appDir% and %vendorDir%/mymodule. If we want to overwrite the default directory, we use exclamation mark:

		- %vendorDir%/mymodule

Directory scanning can be turned off by setting false. We do not recommend completely suppressing the automatic addition of presenters, otherwise application performance will be reduced.


Creating PHP constants.

	FOOBAR: 'baz'

The FOOBAR constant will created after startup.


The configuration for one or more database connections for Nette Database.

	# DSN, only mandatory key
	dsn: "sqlite2:%appDir%/Model/demo.db"
	user: ...
	password: ...

It creates services of type Nette\Database\Connection and also Nette\Database\Context for the Database Explorer layer. The database connection is usually passed by autowiring, if this is not possible, use the service names @database.default.connection resp. @database.default.context.

Other settings:

	# shows database panel in Tracy Bar?
	debugger: ...     # (bool) defaults to true

	# shows query EXPLAIN in Tracy Bar?
	explain: ...      # (bool) defaults to true

	# to enable autowiring for this connection?
	autowired: ...    # (bool) defaults to true for first connection

	# table conventions: discovered, static, or class name
	conventions: discovered  # (string) defaults to 'discovered'

		# to connect to the database only when needed?
		lazy: ...     # (bool) defaults to false

		# PHP database driver class
		driverClass:  # (string)

		# you can list the options found in the PDO driver documentation

In the configuration we can define more database connections by dividing them into named sections:

		dsn: 'mysql:host=;dbname=test'
		user: root
		password: password

		dsn: 'sqlite2::memory:'

Each defined connection creates services that includes section name in their name, ie @database.main.connection & @database.main.context and further @database.another.connection & @database.another.context.

Autowiring is enabled only for services from the first section. This can be changed with autowired: false or autowired: true. Non-autowired services are passed by name:

	- UserFacade(@database.another.connection)


You can change the default form error messages in the configuration.

		EQUAL: 'Please enter %s.'
		NOT_EQUAL: 'This value should not be %s.'
		FILLED: 'This field is required.'
		BLANK: 'This field should be blank.'
		MIN_LENGTH: 'Please enter at least %d characters.'
		MAX_LENGTH: 'Please enter no more than %d characters.'
		LENGTH: 'Please enter a value between %d and %d characters long.'
		EMAIL: 'Please enter a valid email address.'
		URL: 'Please enter a valid URL.'
		INTEGER: 'Please enter a valid integer.'
		FLOAT: 'Please enter a valid number.'
		MIN: 'Please enter a value greater than or equal to %d.'
		MAX: 'Please enter a value less than or equal to %d.'
		RANGE: 'Please enter a value between %d and %d.'
		MAX_FILE_SIZE: 'The size of the uploaded file can be up to %d bytes.'
		MAX_POST_SIZE: 'The uploaded data exceeds the limit of %d bytes.'
		MIME_TYPE: 'The uploaded file is not in the expected format.'
		IMAGE: 'The uploaded file must be image in format JPEG, GIF, PNG or WebP.'
		Nette\Forms\Controls\SelectBox::VALID: 'Please select a valid option.'
		Nette\Forms\Controls\UploadControl::VALID: 'An error occurred during file upload.'
		Nette\Forms\Controls\CsrfProtection::PROTECTION: 'Your session has expired. Please return to the home page and try again.'

HTTP Headers

	# headers that are sent with each request
		X-Powered-By: MyCMS
		X-Content-Type-Options: nosniff
		X-XSS-Protection: '1; mode=block'

	# affects header X-Frame-Options
	frames: ...      # (string|bool) defaults to 'SAMEORIGIN'

For security reasons, the framework sends a header X-Frame-Options: SAMEORIGIN, which says that a page can be displayed inside another page (in element <iframe>) only if it is on the same domain. This can be unwanted in certain situations (for example, if you are developing a Facebook application), so the behavior can be changed by setting frames: or frames: true.

Headers Content-Security-Policy (hereinafter referred to as CSP) can be easily assembled, their description can be found in CSP description. CSP directives (such as script-src) can be written either as strings according to specification or as arrays of values ​​for better readability. Then there is no need to write quotation marks around keywords such as 'self'. Nette will also automatically generate a value of nonce, so 'nonce-y4PopTLM==' will be send in the header.

	# Content Security Policy (since nette/http 2.4.10)
		# string according to CSP specification
		default-src: "'self'"

		# array of values
			- nonce
			- strict-dynamic
			- self

		# bool in the case of switches
		upgrade-insecure-requests: true
		block-all-mixed-content: false

Use <script n:nonce>...</script> in the templates and the nonce value will be filled in automatically. Making secure websites in Nette is really easy.

Similarly, headers Content-Security-Policy-Report-Only (which can be used in parallel with CSP) and Feature Policy can be added:

	# Content Security Policy Report-Only
		default-src: self
		report-uri: 'https://my-report-uri-endpoint'

	# Feature Policy
		unsized-media: none
			- self

You can change the default value of the $secure parameter inn the Nette\Http\Response::setCookie() method.

	# to send cookies only via HTTPS?
	cookieSecure: ...      # (bool|auto) defaults to false

The value auto means that if the website is running on HTTPS, cookies will be sent with the flag Secure and will therefore be available only via HTTPS.

HTTP proxy

If the site is running behind an HTTP proxy, enter its IP address in order to correctly detect the IP address of the client Nette\Http\Response::getRemoteAddress() and encrypted connection isSecured().

	# IP address, range (ie. or array of these values
	proxy:       # (string|string[]) defaults to none


This setting globally affects the behavior of Latte in components and presenters.

	# switches Latte to XHTML mode
	xhtml: ...           # (bool) defaults to false

	# class of $this->template
	templateClass: App\MyTemplateClass # defaults to Nette\Bridges\ApplicationLatte\Template

It is also possible to register new tags either by entering the class name or by referring to the service. Method install() is called by default, but this can be changed by specifying the name of another method:

	# registration of user Latte tags
		- App\MyLatteMacros::register         # static method, classname or callable
		- @App\MyLatteMacrosFactory           # service with install method
		- @App\MyLatteMacrosFactory::register # service with register method

	- App\MyLatteMacrosFactory


By default, the mailer Nette\Mail\SendmailMailer is used to send emails, which is not further configured. However, we can switch it to Nette\Mail\SmtpMailer:

	# use SmtpMailer
	smtp: true       # (bool) defaults to false

	host: ...        # (string)
	port: ...        # (int)
	username: ...    # (string)
	password: ...    # (string)
	timeout: ...     # (int)
	secure: ...      # (ssl|tls|null) defaults to null
	clientHost: ...  # (string) defaults to $_SERVER['HTTP_HOST']
	persistent: ...  # (bool) defaults to false


You can set PHP directives. An overview of all directives can be found at

	date.timezone: Europe/Prague


Basic settings:

	# shows routing panel in Tracy Bar?
	debugger: ...   # (bool) defaults to true

	# to serialize router to DI container?
	cache: ...      # (bool) defaults to false

Router is usually defined in the RouterFactory class, a more limited alternative can be defined in the configuration using pairs mask: action:

		'detail/<id>': Admin:Home:default
		'<presenter>/<action>': Front:Home:default

Access Control

You can define a list of users in the configuration to create a simple authenticator (Nette\Security\SimpleAuthenticator). Because passwords are readable in the configuration, this solution is for testing purposes only.

	# shows user panel in Tracy Bar?
	debugger: ...  # (bool) defaults to true

		# name: password
		johndoe: secret123

		# name, password, role and other data available in the identity
			password: secret123
			roles: [admin]
			data: ...

You can also define roles and resources to create a basis for authorizer (Nette\Security\Permission):

		registered: [guest]  # registered inherits from guest
		admin: [registered]  # and admin inherits from registered

		comment: [article]   # resource inherits from article


Basic sessions settings:

	# shows session panel in Tracy Bar?
	debugger: ...        # (bool) defaults to false

	# inactivity time after which the session expires
	expiration: 14 days  # (string) defaults to '3 hours'

	# to start a session automatically after creating a container?
	# 'smart' starts a session if it is already created
	autoStart: ...       # (bool|smart) defaults to 'smart'

	# handler, service that implements the SessionHandlerInterface interface
	handler: @handlerService

You can also set all PHP session directives (in camelCase format):

	# '' written as 'name'
	name: MYID

	# 'session.save_path' written as 'savePath'
	savePath: "%tempDir%/sessions"

The session cookie is sent with the same parameters as other cookie, but you can change these for it:

	# which hosts are allowed to receive the cookie
	cookieDomain: ''  # (string|domain) defaults to unset

	# require that a cookie shouldn't be sent with cross-origin requests?
	cookieSamesite: Lax          # (Strict|Lax|None) defaults to unset

The cookieDomain option determines which domains (origins) can accept cookies. If not specified, the cookie is accepted by the same (sub)domain as is set by it, excluding their subdomains. If cookieDomain is specified, then subdomains are also included. Therefore, specifying cookieDomain is less restrictive than omitting.

For example, if cookieDomain: is set, cookie is also available on all subdomains like This can also be achieved with the special value domain, ie cookieDomain: domain.

The cookieSamesite option affects whether the cookie is sent with cross-origin requests, which provides some protection against Cross-Site Request Forgery attecks.

Tracy Debugger

You can set the Tracy parameters in the configuration and also add new panels to the Tracy Bar. These settings are applied only after the DI container has been created, so errors that occurred earlier cannot reflect them.

Error logging configuration:

	# if error has occurred the notification is sent to this email
	email:           # (string|string[]) defaults to unset

	# email sender
	fromEmail:     # (string) defaults to unset

	# to use a mailer defined in the configuration? (since Tracy 2.5)
	netteMailer: ...                 # (bool) defaults to true

	# for which error levels is BlueScreen also logged?
	logSeverity: [E_WARNING, E_NOTICE]  # defaults to []

Configuration for function dump():

	# maximum string length
	maxLength: 150             # (int) default according to Tracy

	# how deep will list
	maxDepth: 10               # (int) default according to Tracy

	# displays the location where dump() was called?
	showLocation: ...          # (bool) default according to Tracy

To install the Tracy extension:

	# appends bars to Tracy Bar
		- Nette\Bridges\DITracy\ContainerPanel
		- IncludePanel
		- XDebugHelper('myIdeKey')
		- MyPanel(@MyService)

	# append panels to BlueScreen
		- DoctrinePanel::renderException

Other options:

	# in Development mode, you will see notice or error warnings as BlueScreen
	strictMode: ...           # (bool) defaults to true

	# displays silent (@) error messages
	scream: ...               # (bool) defaults to false

	# link format to open in the editor
	editor: ...               # (string) defaults to 'editor://open/?file=%file&line=%line'

	# path to template with custom page for error 500
	errorTemplate: ...        # (string) defaults to unset

	# shows Tracy Bar?
	showBar: ...              # (bool) defaults to true

		# original: new
		/var/www/html: /data/web
		/home/web: /srv/html