Sessions - Revision history

SarahK: /* Sessions are not being removed automatically */

2022-05-03T20:56:45Z

‎Sessions are not being removed automatically

Lawrence: /* Sessions are not being removed automatically */

2021-10-19T11:51:16Z

‎Sessions are not being removed automatically

Lawrence: /* Sessions are not being removed automatically */

2021-10-19T11:50:00Z

‎Sessions are not being removed automatically

Lawrence at 11:44, 19 October 2021

2021-10-19T11:44:49Z

Lawrence at 11:44, 19 October 2021

2021-10-19T11:44:10Z

AlexN at 13:26, 10 December 2020

2020-12-10T13:26:15Z

AlexN: /* Advanced Configuration */

2020-12-10T13:25:10Z

‎Advanced Configuration

PeterB: Undo revision 28701 by PeterB (talk)

2020-07-10T16:52:48Z

Undo revision 28701 by PeterB (talk)

PeterB: Formatting update

2020-07-10T16:51:34Z

Formatting update

SarahK: /* Advanced Configuration */

2020-05-12T18:17:07Z

‎Advanced Configuration

← Older revision		Revision as of 20:56, 3 May 2022
Line 67:		Line 67:
	===Sessions are not being removed automatically===		===Sessions are not being removed automatically===

−	If you notice that the sessions ~~are not being removed~~ from the location ~~specified by~~ your session configuration, either the location ~~specified for~~ the session.save_path PHP setting or the database table when using database sessions~~, this~~ is likely ~~the result of~~ using non-standard values for the PHP session.gc_probability and session.gc_divisor settings. Most commonly 0 for one or both of them. These settings are part of a probability based calculation and ~~has~~ values of 1 and 1000 respectively, meaning that there is a 1% chance of garbage collection being executed per request. ~~It is generally best~~ to ~~set~~ the ~~settings to these defaults~~.	+	If you notice that the system is not removing sessions from the location in your session configuration, either the location of the <tt>session.save_path</tt> PHP setting or the database table when using database sessions is likely using non-standard values for the PHP <tt>session.gc_probability</tt> and <tt>session.gc_divisor</tt> settings. Most commonly, this is <tt>0</tt> for one or both of them.
		+
		+	These settings are part of a probability-based calculation and have values of <tt>1</tt> and <tt>1000</tt> respectively, meaning that there is a 1% chance of garbage collection being executed per request. We recommend setting these settings to the default values.

← Older revision		Revision as of 11:51, 19 October 2021
Line 67:		Line 67:
	===Sessions are not being removed automatically===		===Sessions are not being removed automatically===

−	If you notice that the sessions are not being removed from the location specified by your session configuration (the location specified for the session.save_path PHP setting or the database table when using database sessions), this is likely the result of using non-standard values for the PHP session.gc_probability and session.gc_divisor settings~~, likely~~ 0 for one or both of them. These settings are part of a probability based calculation and has values of 1 and 1000 respectively, meaning that there is a 1% chance of garbage collection being executed per request. It is generally best to set the settings to these defaults.	+	If you notice that the sessions are not being removed from the location specified by your session configuration, either the location specified for the session.save_path PHP setting or the database table when using database sessions, this is likely the result of using non-standard values for the PHP session.gc_probability and session.gc_divisor settings. Most commonly 0 for one or both of them. These settings are part of a probability based calculation and has values of 1 and 1000 respectively, meaning that there is a 1% chance of garbage collection being executed per request. It is generally best to set the settings to these defaults.

← Older revision		Revision as of 11:50, 19 October 2021
Line 66:		Line 66:

	===Sessions are not being removed automatically===		===Sessions are not being removed automatically===
		+
		+	If you notice that the sessions are not being removed from the location specified by your session configuration (the location specified for the session.save_path PHP setting or the database table when using database sessions), this is likely the result of using non-standard values for the PHP session.gc_probability and session.gc_divisor settings, likely 0 for one or both of them. These settings are part of a probability based calculation and has values of 1 and 1000 respectively, meaning that there is a 1% chance of garbage collection being executed per request. It is generally best to set the settings to these defaults.

← Older revision		Revision as of 11:44, 19 October 2021
Line 64:		Line 64:

	==Troubleshooting==		==Troubleshooting==
		+
		+	===Sessions are not being removed automatically===

← Older revision		Revision as of 11:44, 19 October 2021
Line 62:		Line 62:

	This commands assumes root access to the server.		This commands assumes root access to the server.
		+
		+	==Troubleshooting==

@@ Line 55: / Line 55: @@
 =====Using a Remote Database=====
-If you wish to use a remote database for the management of sessions, the tblsessions table will need to be created manually. The first step for this would be to upload the tblsessions.schema.sql file to the remote server, then import the contents of that file to your database via command line like this:
+If you wish to use a remote database for the management of sessions, the tblsessions table will need to be created manually. The first step for this would be to upload the tblsessions.schema.sql file to the remote server, which can be located within WHMCS at <tt>resources/sql/install/tblsessions.schema.sql</tt>, then import the contents of that file to your database via command line like this:
 <div class="source-cli">

← Older revision		Revision as of 13:25, 10 December 2020
Line 53:		Line 53:

	WHMCS does not manage tables or schema outside the core database. If you provide an advanced configuration, you will need to ensure the named database has the appropriate target table and schema. A copy of the appropriate table schema is in WHMCS at <tt>resources/sql/install/tblsessions.schema.sql</tt>.		WHMCS does not manage tables or schema outside the core database. If you provide an advanced configuration, you will need to ensure the named database has the appropriate target table and schema. A copy of the appropriate table schema is in WHMCS at <tt>resources/sql/install/tblsessions.schema.sql</tt>.
		+
		+	=====Using a Remote Database=====
		+	If you wish to use a remote database for the management of sessions, the tblsessions table will need to be created manually. The first step for this would be to upload the tblsessions.schema.sql file to the remote server, then import the contents of that file to your database via command line like this:
		+
		+	<div class="source-cli">
		+	mysql -u root [database_name] < /path/to/tblsessions.schema.sql
		+	</div>
		+
		+	This commands assumes root access to the server.

@@ Line 34: / Line 34: @@
 Below is an example of the structure and key-and-value pairs for advanced configuration:
- <nowiki>
+<div class="source-cli">
 $session_handling = [
-    'serviceProvider' => '\\WHMCS\\Session\\Database\\ServiceProvider',  //do not alter this line
+<br/>  'serviceProvider' => '\\WHMCS\\Session\\Database\\ServiceProvider',  //do not alter this line
-        'database' => [
+<br/>  'database' => [
-            'lifetime' => 24 * 60, //provide a session lifetime in minutes, default is 1440 (1 day)
+<br/>    'lifetime' => 24 * 60, //provide a session lifetime in minutes, default is 1440 (1 day)
-            'connectionAlias' => 'sessionsDbConnection',  //provide internal handler name other than "default"
+<br/>    'connectionAlias' => 'sessionsDbConnection',  //provide internal handler name other than "default"
-             'config' => [
+<br/>    'config' => [
-                 'host' => 'my.host.local',   //provide hostname or IP of database server
+<br/>      'host' => 'my.host.local',   //provide hostname or IP of database server
-                 'database' => 'db_name',     //provide name of database to use
+<br/>      'database' => 'db_name',     //provide name of database to use
-                 'username' => 'db_user',     //provide username for authenticate at server
+<br/>      'username' => 'db_user',     //provide username for authenticate at server
-                 'password' => 'db_password', //provide password for authentication at server
+<br/>      'password' => 'db_password', //provide password for authentication at server
-            ],
+<br/>    ],
-            'table' => 'user_sessions', //provide name of table; see tblsessions in WHMCS for schema
+<br/>    'table' => 'user_sessions', //provide name of table; see tblsessions in WHMCS for schema
-            'logErrors' => false, //whether session SQL errors should be recorded to activity log when possible
+<br/>    'logErrors' => false, //whether session SQL errors should be recorded to activity log when possible
-    ],
+<br/>  ],
-];
+<br/>];
-</nowiki>
+</div>
 WHMCS does not manage tables or schema outside the core database.  If you provide an advanced configuration, you will need to ensure the named database has the appropriate target table and schema.  A copy of the appropriate table schema is in WHMCS at <tt>resources/sql/install/tblsessions.schema.sql</tt>.