Drupal - Revision history

Abmurrow: Added the PHP category

2026-05-28T01:37:50Z

Added the PHP category

← Older revision		Revision as of 01:37, 28 May 2026
Line 213:		Line 213:
	[[Category:Server]]		[[Category:Server]]
	[[Category:Web Applications]]		[[Category:Web Applications]]
			[[Category:PHP]]

Klinger: Category:Server Category:Web Applications

2026-05-11T19:29:42Z

Category:Server Category:Web Applications

← Older revision		Revision as of 19:29, 11 May 2026
Line 208:		Line 208:
	services.drupal.sites."localhost".stateDir = /path/to/custom/state/dir;		services.drupal.sites."localhost".stateDir = /path/to/custom/state/dir;
	</syntaxhighlight><blockquote>'''Note''': Changing the state directory does not automatically change the location of the <code>modules</code>, <code>themes</code>, <code>config</code>, or <code>files</code> directories. You can override those locations by using the <code>modulesDir</code> and <code>themesDir</code>, <code>configDir</code>, <code>filesDir</code> keys, accordingly.</blockquote>		</syntaxhighlight><blockquote>'''Note''': Changing the state directory does not automatically change the location of the <code>modules</code>, <code>themes</code>, <code>config</code>, or <code>files</code> directories. You can override those locations by using the <code>modulesDir</code> and <code>themesDir</code>, <code>configDir</code>, <code>filesDir</code> keys, accordingly.</blockquote>



			[[Category:Server]]
			[[Category:Web Applications]]

Abmurrow: Add new hostname config

2026-05-04T01:06:33Z

Add new hostname config

@@ Line 162: / Line 162: @@
 };
 </syntaxhighlight><blockquote>'''Note:''' The database settings configured in NixOS will merely create the database, they will not instruct a new Drupal installation where to find the database. Either define your database settings in <code>settings.php</code>, or see [[Drupal#After_Installation| After Installation]] for an example of how to do this with nix.</blockquote>
 == State Directory ==

Abmurrow: Fix typos, extend shell script instructions

2026-05-04T00:55:30Z

Fix typos, extend shell script instructions

Abmurrow: Undo revision 31042 by Abmurrow (talk)

2026-04-10T14:52:03Z

Undo revision 31042 by Abmurrow (talk)

← Older revision		Revision as of 14:52, 10 April 2026
Line 45:		Line 45:
	==== Capturing Server Resources Before Your Next Rebuild ====		==== Capturing Server Resources Before Your Next Rebuild ====
	After installing Drupal on NixOS using the admin UI, you will want to export the MYSQL database of your website and export the Drupal site configuration. Doing both steps makes it possible to implement continuous integration and continuous delivery on the environment you just created.		After installing Drupal on NixOS using the admin UI, you will want to export the MYSQL database of your website and export the Drupal site configuration. Doing both steps makes it possible to implement continuous integration and continuous delivery on the environment you just created.

			Backing up your Drupal configuration (with git or similar) and database is recommended, especially after a successful install of a new Drupal instance.<blockquote>'''Warning:''' When using a Drupal package that has an existing set of configuration in the config sync directory (or using the configRoot option in nix), it is '''mandatory''' to import a working SQL database from another working installation. Failing to do so will cause your website to not function correctly.

			The advised development workflow for starting a Drupal website (or websites) on NixOS is to do the following

			# Install a new instance of Drupal on NixOS. The configRoot option should be disabled.
			# Once the installation is complete, export the database, and export the configuration. See the sections below on the recommended way to do both of these tasks.
			# Integrate the contents of the config sync directory (located, by default, at /var/lib/drupal/<hostname>/config) back into your upstream Drupal package.
			# During your next rebuild, make sure to import any configuration changes by visiting '''Manage > Configuration > Development > Configuration synchronization''' in the Drupal admin.
			# If you intend on deploying this exact same site elsewhere, take regular backups of your database.
			# Deploy your saved database and the source code into a new instance of Drupal on NixOS at the same time to avoid a chicken-and-egg scenario.
			</blockquote>

	===== Exporting The Database =====		===== Exporting The Database =====
Line 82:		Line 94:
	services.drupal.sites."my-host-name.local".configSyncDir = "/var/lib/drupal/my-host-name.local/config/sync";		services.drupal.sites."my-host-name.local".configSyncDir = "/var/lib/drupal/my-host-name.local/config/sync";
	</syntaxhighlight>If you use the default setting for <code>configSyncDir</code>, you can simply add the first line of code and substitue your hostname.		</syntaxhighlight>If you use the default setting for <code>configSyncDir</code>, you can simply add the first line of code and substitue your hostname.

	== Configuration ==		== Configuration ==

Abmurrow: /* After Installation */

2026-04-10T14:51:05Z

After Installation

← Older revision		Revision as of 14:51, 10 April 2026
Line 45:		Line 45:
	==== Capturing Server Resources Before Your Next Rebuild ====		==== Capturing Server Resources Before Your Next Rebuild ====
	After installing Drupal on NixOS using the admin UI, you will want to export the MYSQL database of your website and export the Drupal site configuration. Doing both steps makes it possible to implement continuous integration and continuous delivery on the environment you just created.		After installing Drupal on NixOS using the admin UI, you will want to export the MYSQL database of your website and export the Drupal site configuration. Doing both steps makes it possible to implement continuous integration and continuous delivery on the environment you just created.

	Backing up your Drupal configuration (with git or similar) and database is recommended, especially after a successful install of a new Drupal instance.<blockquote>'''Warning:''' When using a Drupal package that has an existing set of configuration in the config sync directory (or using the configRoot option in nix), it is '''mandatory''' to import a working SQL database from another working installation. Failing to do so will cause your website to not function correctly.

	~~The advised development workflow for starting a Drupal website (or websites) on NixOS is to do the following~~

	~~# Install a new instance of Drupal on NixOS. The configRoot option should be disabled.~~
	~~# Once the installation is complete, export the database, and export the configuration. See the sections below on the recommended way to do both of these tasks.~~
	~~# Integrate the contents of the config sync directory (located, by default, at /var/lib/drupal/<hostname>/config) back into your upstream Drupal package.~~
	~~# During your next rebuild, make sure to import any configuration changes by visiting '''Manage > Configuration > Development > Configuration synchronization''' in the Drupal admin.~~
	~~# If you intend on deploying this exact same site elsewhere, take regular backups of your database.~~
	~~# Deploy your saved database and the source code into a new instance of Drupal on NixOS at the same time to avoid a chicken-and-egg scenario.~~
	~~</blockquote>~~

	===== Exporting The Database =====		===== Exporting The Database =====
Line 94:		Line 82:
	services.drupal.sites."my-host-name.local".configSyncDir = "/var/lib/drupal/my-host-name.local/config/sync";		services.drupal.sites."my-host-name.local".configSyncDir = "/var/lib/drupal/my-host-name.local/config/sync";
	</syntaxhighlight>If you use the default setting for <code>configSyncDir</code>, you can simply add the first line of code and substitue your hostname.		</syntaxhighlight>If you use the default setting for <code>configSyncDir</code>, you can simply add the first line of code and substitue your hostname.

	== Configuration ==		== Configuration ==

Abmurrow: Add information about managing config and database backups after a successful deployment and installation.

2026-04-10T14:50:45Z

Add information about managing config and database backups after a successful deployment and installation.

← Older revision		Revision as of 14:50, 10 April 2026
Line 43:		Line 43:
	</syntaxhighlight></blockquote>		</syntaxhighlight></blockquote>

			==== Capturing Server Resources Before Your Next Rebuild ====
			After installing Drupal on NixOS using the admin UI, you will want to export the MYSQL database of your website and export the Drupal site configuration. Doing both steps makes it possible to implement continuous integration and continuous delivery on the environment you just created.

			Backing up your Drupal configuration (with git or similar) and database is recommended, especially after a successful install of a new Drupal instance.<blockquote>'''Warning:''' When using a Drupal package that has an existing set of configuration in the config sync directory (or using the configRoot option in nix), it is '''mandatory''' to import a working SQL database from another working installation. Failing to do so will cause your website to not function correctly.

			The advised development workflow for starting a Drupal website (or websites) on NixOS is to do the following

			# Install a new instance of Drupal on NixOS. The configRoot option should be disabled.
			# Once the installation is complete, export the database, and export the configuration. See the sections below on the recommended way to do both of these tasks.
			# Integrate the contents of the config sync directory (located, by default, at /var/lib/drupal/<hostname>/config) back into your upstream Drupal package.
			# During your next rebuild, make sure to import any configuration changes by visiting '''Manage > Configuration > Development > Configuration synchronization''' in the Drupal admin.
			# If you intend on deploying this exact same site elsewhere, take regular backups of your database.
			# Deploy your saved database and the source code into a new instance of Drupal on NixOS at the same time to avoid a chicken-and-egg scenario.
			</blockquote>

			===== Exporting The Database =====
			As root, you can export the database to a local backup using bash script like this.

			<syntaxhighlight lang="bash">
			DATE="$(date +'%F-%T')"
			BACKUP_DIR="/var/lib/drupal/sql-backups/$DRUPAL_HOSTNAME" # Replace the hostname with your Drupal hostname from services.drupal.sites.<hostname>.

			mkdir -p "$BACKUP_DIR"

			# Replace the variables in this line with the values defined in your services.drupal configuration.
			mariadb-dump -u root -$DB_NAME -P $DB_PORT -h $DB_HOST \| gzip > "$BACKUP_DIR/$DATE-$DRUPAL_HOSTNAME-auto-backup.sql.gz"


			</syntaxhighlight>
			<blockquote>'''Note:''' The <code>$DB_NAME</code>, <code>$DB_PORT</code>, and <code>$DB_HOST</code> variables in the above script need to be replaced with actual values from your Drupal configuration. By default, these values are <code>drupal</code>, <code>3306</code>, and <code>localhost</code>, respectively.

			Likewise, replace instances of <code>$DRUPAL_HOSTNAME</code> with the hostname you defined under <code>services.drupal.sites.<hostname></code></blockquote>

			===== Exporting The Configuration =====
			Refer to this guide on Drupal.org for how to [https://www.drupal.org/docs/administering-a-drupal-site/configuration-management/managing-your-sites-configuration export your configuration yamls].

			Drupal uses the files in the config sync directory as a way to implement the concept of "migrations" that you find in many other web frameworks like Ruby on Rails or Django. Whenever you change certain settings in the backend of your website, Drupal can export those database changes into a file to preserve that change in code. Config changes made on a lower environment can then be pushed up to a higher environment as code and imported to change the database in a predictable way.

			Configuration on a Drupal instance in NixOS will be synchronized to the location defined by the <code>configSyncDir</code> option in your nix configuration. By default, this location is set to <code>/var/lib/drupal/<hostname>/config/sync</code>.

			When you export your Drupal configuration on NixOS, make sure to save this configuration in another location immediately afterward, or it may be overridden on the next rebuild or on the next reboot.

			Generally, you should integrate the config you export from the NixOS environment back into a git repo that also contains your Drupal source code. This will ensure that the Drupal instance you deploy into NixOS can import any config changes from git.

			If you Drupal package come with configuration in a config sync directory (or similar), make sure to tell NixOS where to find it with this expression.<syntaxhighlight lang="nix">
			# Tell NixOS where to look for the config sync directory in the Drupal package.
			services.drupal.sites."my-host-name.local".configRoot = "/config";

			# The contents of the /config directory (defined above) will be copied into the path defined by the configSyncDir setting MINUS the trailing "/sync" path, if it exists.
			services.drupal.sites."my-host-name.local".configSyncDir = "/var/lib/drupal/my-host-name.local/config/sync";
			</syntaxhighlight>If you use the default setting for <code>configSyncDir</code>, you can simply add the first line of code and substitue your hostname.
	== Configuration ==		== Configuration ==

Abmurrow at 18:02, 5 April 2026

2026-04-05T18:02:44Z

← Older revision		Revision as of 18:02, 5 April 2026
Line 110:		Line 110:
	};		};
	};		};
	</syntaxhighlight><blockquote>'''Note:''' The database settings configured in NixOS will merely create the database, they will not instruct a new Drupal installation where to find the database. Either define your database settings in <code>settings.~~pho~~</code>, or see [[Drupal#After_Installation\| After Installation]] for an example of how to do this with nix.</blockquote>		</syntaxhighlight><blockquote>'''Note:''' The database settings configured in NixOS will merely create the database, they will not instruct a new Drupal installation where to find the database. Either define your database settings in <code>settings.php</code>, or see [[Drupal#After_Installation\| After Installation]] for an example of how to do this with nix.</blockquote>

	== State Directory ==		== State Directory ==

Abmurrow: Add note about database config

2026-04-05T18:01:42Z

Add note about database config

← Older revision		Revision as of 18:01, 5 April 2026
Line 110:		Line 110:
	};		};
	};		};
	</syntaxhighlight>		</syntaxhighlight><blockquote>'''Note:''' The database settings configured in NixOS will merely create the database, they will not instruct a new Drupal installation where to find the database. Either define your database settings in <code>settings.pho</code>, or see [[Drupal#After_Installation\| After Installation]] for an example of how to do this with nix.</blockquote>

	== State Directory ==		== State Directory ==

Abmurrow: Changed a note into a blockquote element for better readability.

2026-04-05T17:53:37Z

Changed a note into a blockquote element for better readability.

← Older revision		Revision as of 17:53, 5 April 2026
Line 131:		Line 131:
	If you want the state directory to be located in a different part of the system, you can use the following configuration to change where it is created<syntaxhighlight lang="nix">		If you want the state directory to be located in a different part of the system, you can use the following configuration to change where it is created<syntaxhighlight lang="nix">
	services.drupal.sites."localhost".stateDir = /path/to/custom/state/dir;		services.drupal.sites."localhost".stateDir = /path/to/custom/state/dir;
	</syntaxhighlight>'''Note''': Changing the state directory does not automatically change the location of the <code>modules</code>, <code>themes</code>, <code>config</code>, or <code>files</code> directories. You can override those locations by using the <code>modulesDir</code> and <code>themesDir</code>, <code>configDir</code>, <code>filesDir</code> keys, accordingly.		</syntaxhighlight><blockquote>'''Note''': Changing the state directory does not automatically change the location of the <code>modules</code>, <code>themes</code>, <code>config</code>, or <code>files</code> directories. You can override those locations by using the <code>modulesDir</code> and <code>themesDir</code>, <code>configDir</code>, <code>filesDir</code> keys, accordingly.</blockquote>

← Older revision		Revision as of 00:55, 4 May 2026
Line 87:		Line 87:
	Generally, you should integrate the config you export from the NixOS environment back into a git repo that also contains your Drupal source code. This will ensure that the Drupal instance you deploy into NixOS can import any config changes from git.		Generally, you should integrate the config you export from the NixOS environment back into a git repo that also contains your Drupal source code. This will ensure that the Drupal instance you deploy into NixOS can import any config changes from git.

	If ~~you~~ Drupal package ~~come~~ with configuration in a config sync directory (or similar), make sure to tell NixOS where to find it with this expression.<syntaxhighlight lang="nix">		If your Drupal package comes with configuration in a config sync directory (or similar), make sure to tell NixOS where to find it with this expression.<syntaxhighlight lang="nix">
	# Tell NixOS where to look for the config sync directory in the Drupal package.		# Tell NixOS where to look for the config sync directory in the Drupal package.
	services.drupal.sites."my-host-name.local".configRoot = "/config";		services.drupal.sites."my-host-name.local".configRoot = "/config";
Line 93:		Line 93:
	# The contents of the /config directory (defined above) will be copied into the path defined by the configSyncDir setting MINUS the trailing "/sync" path, if it exists.		# The contents of the /config directory (defined above) will be copied into the path defined by the configSyncDir setting MINUS the trailing "/sync" path, if it exists.
	services.drupal.sites."my-host-name.local".configSyncDir = "/var/lib/drupal/my-host-name.local/config/sync";		services.drupal.sites."my-host-name.local".configSyncDir = "/var/lib/drupal/my-host-name.local/config/sync";
	</syntaxhighlight>If you use the default setting for <code>configSyncDir</code>, you can simply add the first line of code and ~~substitue~~ your hostname.		</syntaxhighlight>If you use the default setting for <code>configSyncDir</code>, you can simply add the first line of code and substitute your hostname.
	== Configuration ==		== Configuration ==

	=== Configuration Using settings.php ===		=== Configuration Using settings.php ===
	Drupal uses a file called <code>settings.php</code> to configure the application at a ~~general~~ level. If you use the NixOS-provided Drupal package instead of a custom package, you may want to change some of these settings.		Drupal uses a file called <code>settings.php</code> to configure the application at a low level. If you use the NixOS-provided Drupal package instead of a custom package, you may want to change some of these settings.

	You can do this by writing pure PHP into the <code>services.drupal.sites.<name>.extraSettings</code> key<syntaxhighlight lang="nix">		You can do this by writing pure PHP into the <code>services.drupal.sites.<name>.extraSettings</code> key<syntaxhighlight lang="nix">
Line 118:		Line 118:

	=== Webserver Configuration ===		=== Webserver Configuration ===
	You can use either [[nginx]] or [[caddy]] as the webserver, but only one may be used at a time. All Drupal installations on NixOS will use the same configured webserver, though configuration may be customized for each installation.		You can use either [[nginx]] or [[caddy]] as the webserver, but only one may be used at a time. All Drupal installations on NixOS will use the same configured webserver, though webserver configuration may be customized for each installation.

	Nginx is the default webserver, though you can use caddy by writing this configuration<syntaxhighlight lang="nix">		Nginx is the default webserver, though you can use caddy by writing this configuration<syntaxhighlight lang="nix">
Line 167:		Line 167:

	This is the file structure you can find at a typical installation<syntaxhighlight lang="bash">		This is the file structure you can find at a typical installation<syntaxhighlight lang="bash">
			$ pwd
			/var/lib/drupal/localhost
	$ ls		$ ls
	config modules private sites themes		config modules private sites themes
Line 172:		Line 174:
	</syntaxhighlight>Files in this directory, because of their tendency to change during run time, cannot live inside of <code>/nix/store</code>, so they are placed here instead.		</syntaxhighlight>Files in this directory, because of their tendency to change during run time, cannot live inside of <code>/nix/store</code>, so they are placed here instead.

	The webserver is the default owner of all files in the state directory and regular users are not permitted to access this directory by default. However, users who belong to the webserver group may edit or upload files ~~as needed~~. Refer to [[Drupal#How To Access Files In The State Directory As A Regular User\|How To Access Files In The State Directory As A Regular User]] for more information on how to add users to the webserver group.		The webserver is the default owner of all files in the state directory and regular users are not permitted to access this directory by default. However, users who belong to the webserver group may edit or upload files.

			Refer to [[Drupal#How To Access Files In The State Directory As A Regular User\|How To Access Files In The State Directory As A Regular User]] for more information on how to add users to the webserver group.

	=== Uploading Modules and Themes ===		=== Uploading Modules and Themes ===
	The <code>modules</code> and <code>themes</code> directories of the state directory are symlinked directly to the Drupal installation in the nix store. Users can upload both [https://www.drupal.org/docs/user_guide/en/extend-manual-install.html modules and themes] to these directories and Drupal will detect them.		The <code>modules</code> and <code>themes</code> directories of the state directory are symlinked directly to the Drupal installation in the nix store. Users can upload both [https://www.drupal.org/docs/user_guide/en/extend-manual-install.html modules and themes] to these directories and Drupal will detect them.

	This is not the officially [https://www.drupal.org/docs/extending-drupal/installing-modules recommended method] for installing contributed modules and themes, or modules and themes that have third-party dependencies. However, this functionality has been preserved both as an escape hatch, and to provide an easy way to manage a simple Drupal install that doesn't rely on [https://getcomposer.org/ composer].		This is not the officially [https://www.drupal.org/docs/extending-drupal/installing-modules recommended method] for installing contributed modules and themes, or modules and themes that have third-party dependencies. However, this functionality has been preserved both as an escape hatch, and to provide an easy way to manage a simple Drupal install that doesn't rely exclusively on [https://getcomposer.org/ composer].

	=== Changing The Location Of The State Directory ===		=== Changing The Location Of The State Directory ===