Convention Master Documentation - User contributions [en]

Guide/EmailThroughOffice365

2025-05-04T04:41:00Z

Rex: /* Step 4 (only if your CM server has an IPv6 address!) */

=Sending Emails through Microsoft 365=
CM can be set up to send emails through Microsoft 365, but it requires some configuration within Exchange Online first.

==Prerequisites==
These are things you need first in order to follow this guide.
# Admin access within Microsoft 365.
# Admin access to your domain's DNS records.
# Admin access within CM.
# Outbound access from CM on port 25.
# A static IP address for CM (you probably already have this).

==Process==
===Step 1: Creating a connector===
# Log into https://admin.exchange.microsoft.com using an account with admin rights.
# In the left side menu, go to Mail flow -> Connectors
# Click "Add a connector"
## From "Your organization"
## Give it a name, maybe something like "Email from CM", and make sure the connector will be turned on
## Select the option to verify by IP address
### Type in the static IP address for your CM server
### Make sure you click the plus button after typing it in, to move it into the list under the text box
## Make sure the settings are good, then click the finish button.

===Step 2: Update your SPF record===
# Locate your SPF record in DNS. It will be a TXT record that starts with "v=spf1" and ends with something like "~all" or "-all"
# Somewhere between those two records at either end, you need to insert a new selector "ip4:<your CM IP address>"
# Save the updated record
# Check your MX record and get your Microsoft 365 endpoint. It will probably be something like "domain-tld.mail.protection.outlook.com"--you may not have this listed if your domain is using some other spam filtering service in front of 365, but you do need the Microsoft endpoint for the next step.

===Step 3: Connect CM to Microsoft 365===
When you configure the email server in CM, use the following settings:
* Send method: SMTP
* Server address: tls://<365 endpoint>
* Server port: 25
* Connection security: TLS
* Password authentication: '''unchecked'''
You need to make sure that you send emails from an address which ends in your domain name. The sending address does ''not'' need to exist in Microsoft 365.

===Step 4 (only if your CM server has an IPv6 address!)===
If (and only if) your CM server has an IPv6 address, you may experience problems sending email through Microsoft 365 if you don't follow these steps! Microsoft 365 can't add IPv6 addresses to connector settings, which prevents any IPv6 connections from being able to authenticate and send email.

If a AAAA record exists for your 365 endpoint,

'''EITHER'''
* Disable IPv6 on your CM server
'''OR'''
# [https://learn.microsoft.com/en-us/powershell/exchange/connect-to-exchange-online-powershell?view=exchange-ps Connect to Exchange Online by using PowerShell]
# Disable-IPv6ForAcceptedDomain -Domain "domain.tld"

Guide/EmailThroughOffice365

2025-05-04T04:40:01Z

Rex: Initial version

=Sending Emails through Microsoft 365=
CM can be set up to send emails through Microsoft 365, but it requires some configuration within Exchange Online first.

==Prerequisites==
These are things you need first in order to follow this guide.
# Admin access within Microsoft 365.
# Admin access to your domain's DNS records.
# Admin access within CM.
# Outbound access from CM on port 25.
# A static IP address for CM (you probably already have this).

==Process==
===Step 1: Creating a connector===
# Log into https://admin.exchange.microsoft.com using an account with admin rights.
# In the left side menu, go to Mail flow -> Connectors
# Click "Add a connector"
## From "Your organization"
## Give it a name, maybe something like "Email from CM", and make sure the connector will be turned on
## Select the option to verify by IP address
### Type in the static IP address for your CM server
### Make sure you click the plus button after typing it in, to move it into the list under the text box
## Make sure the settings are good, then click the finish button.

===Step 2: Update your SPF record===
# Locate your SPF record in DNS. It will be a TXT record that starts with "v=spf1" and ends with something like "~all" or "-all"
# Somewhere between those two records at either end, you need to insert a new selector "ip4:<your CM IP address>"
# Save the updated record
# Check your MX record and get your Microsoft 365 endpoint. It will probably be something like "domain-tld.mail.protection.outlook.com"--you may not have this listed if your domain is using some other spam filtering service in front of 365, but you do need the Microsoft endpoint for the next step.

===Step 3: Connect CM to Microsoft 365===
When you configure the email server in CM, use the following settings:
* Send method: SMTP
* Server address: tls://<365 endpoint>
* Server port: 25
* Connection security: TLS
* Password authentication: '''unchecked'''
You need to make sure that you send emails from an address which ends in your domain name. The sending address does ''not'' need to exist in Microsoft 365.

===Step 4 (only if your CM server has an IPv6 address!)===
If (and only if) your CM server has an IPv6 address, you may experience problems sending email through Microsoft 365 if you don't follow these steps! Microsoft 365 can't add IPv6 addresses to connector settings, which prevents any IPv6 connections from being able to authenticate and send email.

If a AAAA record exists for your 365 endpoint,

'''EITHER'''
* Disable IPv6 on your CM server
'''OR'''
* [https://learn.microsoft.com/en-us/powershell/exchange/connect-to-exchange-online-powershell?view=exchange-ps Connect to Exchange Online by using PowerShell]
* Disable-IPv6ForAcceptedDomain -Domain "domain.tld"

Main Page

2025-04-27T21:16:51Z

Rex: Add guide for O365 email

=Convention Master Documentation=

This wiki will attempt to document all things Convention Master. It is brand new and currently a work-in-progress, so if a subject below does not yet have a page or has incomplete documentation, please contact a development team member for more information.

== Installation & Upgrade ==
* [[InstallGuide | Installation Guide]]
* [[Upgrading Convention Master]]
* [[Upgrading from MySQL 5.7 to MySQL 8.0]]

== Instructional Guides ==

* [[Guide/MoveDatabase|Moving a Database Between Installations]]
* [[Guide/Vouchers|Voucher System]]
* [[Guide/PaymentGateways|Payment Gateway System]]
* [[Guide/DealersDen|Dealer Den / Vendor Hall Subsystem]]
* [[Guide/X-forwarded-for|X Forwarded For Headers]]
* [[Guide/implementingCaptcha|Implementing Captcha/hCaptcha]]
* [[Guide/EmailThroughOffice365|Sending email through Microsoft 365]]

== Other Pages ==
* [[Automated Tasks]]
* [[Products]]
* [[EventGrid]]
* [[Kiosks]]
* [[Potential New Feature Descriptions]]
* [[UpgradeError_Index|Database Upgrade Errors]]
* [[Cash Register V2]]

== Reference Documents ==
* [[Badge Display Code Documentation]]
* [[Tag Replacements]]
* [[Global Settings]]
* [[Sending parsed DL-ID data to CM]]

== Release Notes ==
* [[Release notes]]: All information on releases of Convention Master can be found here.

== Support ==
You can get support by contacting us via email at support[at]civetsolutions[dot]com

Release notes

2024-09-23T01:29:26Z

Rex: Fixed row wrap

This page links to the various release notes available for Convention Master.

{| class="wikitable"
! rowspan="1" | Info page
! rowspan="1" | Date Released
! rowspan="1" | DB Version
! rowspan="1" | Public Subversion Revision
! rowspan="1" | Minimum PHP Version Supported
! rowspan="1" | Notes
|-
|[[Release notes/11.0.2|11.0.2]]
| 2024-09-17
| 590
| 196
| 8.1
| This is a security release. (Fixes issues in 11.0.0 and 11.0.1
|-
|[[Release notes/11.0.1|11.0.1]]
| 2024-06-17
| 590
| 195
| 8.1
|
|-
|[[Release notes/11.0.0|11.0.0]]
|2024-04-10
| 590
| 194
| 8.1
| Events Grid released!
|-
|[[Release notes/10.3.2|10.3.2]]
|2023-12-11
| 589
| 193
| 8.1
|
|-
|[[Release notes/10.3.1|10.3.1]]
| 2023-09-16
| 589
| 191
| 8.1
| PHP 8+ required
|-
|[[Release notes/10.3.0|10.3.0]]
| 2023-07-22
| 589
| 191
| 8.1 min
| PHP 8+ required
|-
|[[Release notes/10.2.1|10.2.1]]
| 2023-04-15
| 588
| 190
| 7.4
| Warning about PHP starts here (This is the last version that will support PHP 7.4)
|-
|[[Release notes/10.2.0|10.2.0]]
|2023-03-10
|588
|187
|7.4
|
|-
|[[Release notes/10.1.8|10.1.8]]
|2023-01-12
|588
|184
|7.4
|PHP 8.2 now supported
|-
|[[Release notes/10.1.7|10.1.7]]
|2022-11-16
|588
|182
|7.1
|PHP 8.2 now supported
|-
|[[Release notes/10.1.6|10.1.6a]]
|2022-09-23
|588
|178
|7.1
|-
|[[Release notes/10.1.6|10.1.6]]
|2022-09-14
|588
|175
|7.1
|-
|[[Release notes/10.1.5|10.1.5]]
|2022-01-10
|584
|171
|7.1
|
|-
|-
|[[Release notes/10.1.4|10.1.4]]
|2021-07-18
|584
|169
|7.1
|
|-
|-
|[[Release notes/10.1.3|10.1.3]]
|2021-07-17
|583
|167
|7.1
|
|-
|-
|[[Release notes/10.1.2|10.1.2]]
|2021-02-25
|582
|166
|7.1
|
|-
|-
|[[Release notes/10.1.1|10.1.1]]
|2021-02-19
|582
|164
|7.1
|Warning about PHP version 7.2 starts here
|-
|-
|[[Release notes/10.1.0|10.1.0]]
|2021-01-31
|582
|161
|7.1
|Versions 10.1.0 and later require the database be from a version 9.5.0 or newer to perform an upgrade. (Min DB version 572)
|-
|-
|[[Release notes/10.0.13|10.0.13]]
|2020-08-10
|579
|156
|5.6
|-
|-
|[[Release notes/10.0.12|10.0.12]]
|2020-05-30
|579
|155
|5.6
|-
|[[Release notes/10.0.11|10.0.11]]
|2020-03-04
|578
|153
|5.6
|-
|[[Release notes/10.0.10|10.0.10]]
|2020-02-26
|578
|151
|5.6
|-
|[[Release notes/10.0.9|10.0.9]]
|2020-02-24
|578
|149
|5.6
|-
|[[Release notes/10.0.8|10.0.8]]
|2019-12-12
|576
|147
|5.6
|-
|[[Release notes/10.0.7|10.0.7]]
|2019-11-24
|576
|145
|5.6
|-
|[[Release notes/10.0.6|10.0.6]]
|2019-11-20
|576
|143
|5.6
|-
|[[Release notes/10.0.5|10.0.5]]
|2019-05-09
|575
|141
|5.6
|-
|[[Release notes/10.0.4|10.0.4]]
|2019-05-04
|575
|139
|5.6
|-
|[[Release notes/10.0.3|10.0.3]]
|2019-03-05
|574
|136
|5.6
|-
|[[Release notes/10.0.2|10.0.2]]
|2019-02-27
|574
|132
|5.6
|-
|[[Release notes/10.0.1|10.0.1]]
|2019-02-11
|573
|129
|5.6
|-
|[[Release notes/10.0.0|10.0.0]]
|2018-12-30
|572
|127
|5.6
|-
|[[Release notes/9.5.0|9.5.0]]
|2018-11-21
|572
|122
|5.6
|-
|[[Release notes/9.4.2|9.4.2]]
|2018-09-12
|570
|117
|
|-
|[[Release notes/9.4.1|9.4.1]]
|2018-07-03
|570
|115
|
|-
|[[Release notes/9.4.0|9.4.0]]
|2018-06-28
|570
|113
|
|-
|[[Release notes/9.3.5|9.3.5]]
|2018-03-07
|556
|111
|
|-
|[[Release notes/9.3.4|9.3.4]]
|2018-02-23
|555
|109
|
|-
|[[Release notes/9.3.3|9.3.3]]
|2018-02-18
|554
|108
|
|-
|9.3.2
|2018-01-11
|553
|106
|
|-
|9.3.1
|2018-01-11
|553
|104
|
|-
|[[Release notes/9.3.0|9.3.0]]
|2018-01-06
|553
|102
|
|-
|9.2.0
|2017-06-05
|549
|100
|
|-
|[[Release notes/9.1.2|9.1.2]]
|2017-03-30
|549
|97
|
|-
|[[Release notes/9.1.1|9.1.1]]
|2017-01-11
|548
|94
|
|-
|[[Release notes/9.1.0|9.1.0]]
|2017-01-03
|547
|93
|
|-
|[[Release notes/9.0.3|9.0.3]]
|2016-08-31
|544
|92
|
|-
|[[Release notes/9.0.2|9.0.2]]
|2016-07-27
|544
|90
|
|-
|[[Release notes/9.0.1|9.0.1]]
|2016-07-06
|543
|86
|
|-
|[[Release notes/9.0.0|9.0.0]]
|2016-05-08
|542
|85
|
|Versions 9.0.0 and later require the database be from a version 8.2.9 or newer to perform an upgrade. (Min DB version 538)
|
|-
|[[Release notes/8.2.10|8.2.10]]
|2015-12-02
|
|84
|
|-
|[[Release notes/8.2.9|8.2.9]]
|2015-10-26
|
|83
|
|-
|[[Release notes/8.2.8|8.2.8]]
|2015-06-13
|
|80
|
|-
|[[Release notes/8.2.7|8.2.7]]
|2015-01-19
|
|75
|
|-
|[[Release notes/8.2.6|8.2.6]]
|2014-07-17
|
|68
|
|-
|[[Release notes/8.2.5|8.2.5]]
|2014-06-19
|
|67
|
|-
|[[Release notes/8.2.4|8.2.4]]
|2014-05-12
|
|65
|
|-
|[[Release notes/8.2.3|8.2.3]]
|2014-05-05
|
|62
|
|-
|[[Release notes/8.2.2|8.2.2]]
|2013-12-12
|
|58
|
|-
|[[Release notes/8.2.1|8.2.1]]
|2013-11-14
|
|56
|
|-
|[[Release notes/8.2.0|8.2.0]]
|2013-06-01
|
|53
|
|-
|[[Release notes/8.1.0|8.1.0]]
|2013-03-25
|
|52
|
|-
|[[Release notes/8.0.0|8.0.0]]
|2013-02-25
|
|51
|
|-
|[[Release notes/7.2.0|7.2.0]]
|2012-07-14
|
|48
|
|-
|[[Release notes/7.1.0|7.1.0]]
|2012-04-11
|
|39
|
|-
|[[Release notes/7.0.2|7.0.2]]
|2012-03-03
|
|37
|
|-
|[[Release notes/7.0.1|7.0.1]]
|2012-02-05
|
|35
|
|-
|[[Release notes/7.0.0|7.0.0]]
|2012-01-27
|
|32
|
|-
|}

== See also ==

[[Category:Upgrading]]
[[Category:Convention Master Release Notes]]
[[Category:Convention Master development]]

Release notes

2023-10-15T19:02:14Z

Rex: ionCube Loader for PHP 8.2 does not work with CM at the present time, how can something non-functional be recommended?

This page links to the various release notes available for Convention Master.

{| class="wikitable"
! rowspan="1" | Info page
! rowspan="1" | Date Released
! rowspan="1" | DB Version
! rowspan="1" | Public Subversion Revision
! rowspan="1" | Minimum PHP Version Supported
! rowspan="1" | Notes
|-
|[[Release notes/10.3.1|10.3.1]]
| 2023-09-16
| 589
| 191
| 8.1 min
| PHP 8+ required
|-
|[[Release notes/10.3.0|10.3.0]]
| 2023-07-22
| 589
| 191
| 8.1 min
| PHP 8+ required
|-
|[[Release notes/10.2.1|10.2.1]]
| 2023-04-15
| 588
| 190
| 7.4
| Warning about PHP starts here (This is the last version that will support PHP 7.4)
|-
|[[Release notes/10.2.0|10.2.0]]
|2023-03-10
|588
|187
|7.4
|
|-
|[[Release notes/10.1.8|10.1.8]]
|2023-01-12
|588
|184
|7.4
|PHP 8.2 now supported
|-
|[[Release notes/10.1.7|10.1.7]]
|2022-11-16
|588
|182
|7.1
|PHP 8.2 now supported
|-
|[[Release notes/10.1.6|10.1.6a]]
|2022-09-23
|588
|178
|7.1
|-
|[[Release notes/10.1.6|10.1.6]]
|2022-09-14
|588
|175
|7.1
|-
|[[Release notes/10.1.5|10.1.5]]
|2022-01-10
|584
|171
|7.1
|
|-
|-
|[[Release notes/10.1.4|10.1.4]]
|2021-07-18
|584
|169
|7.1
|
|-
|-
|[[Release notes/10.1.3|10.1.3]]
|2021-07-17
|583
|167
|7.1
|
|-
|-
|[[Release notes/10.1.2|10.1.2]]
|2021-02-25
|582
|166
|7.1
|
|-
|-
|[[Release notes/10.1.1|10.1.1]]
|2021-02-19
|582
|164
|7.1
|Warning about PHP version 7.2 starts here
|-
|-
|[[Release notes/10.1.0|10.1.0]]
|2021-01-31
|582
|161
|7.1
|Versions 10.1.0 and later require the database be from a version 9.5.0 or newer to perform an upgrade. (Min DB version 572)
|-
|-
|[[Release notes/10.0.13|10.0.13]]
|2020-08-10
|579
|156
|5.6
|-
|-
|[[Release notes/10.0.12|10.0.12]]
|2020-05-30
|579
|155
|5.6
|-
|[[Release notes/10.0.11|10.0.11]]
|2020-03-04
|578
|153
|5.6
|-
|[[Release notes/10.0.10|10.0.10]]
|2020-02-26
|578
|151
|5.6
|-
|[[Release notes/10.0.9|10.0.9]]
|2020-02-24
|578
|149
|5.6
|-
|[[Release notes/10.0.8|10.0.8]]
|2019-12-12
|576
|147
|5.6
|-
|[[Release notes/10.0.7|10.0.7]]
|2019-11-24
|576
|145
|5.6
|-
|[[Release notes/10.0.6|10.0.6]]
|2019-11-20
|576
|143
|5.6
|-
|[[Release notes/10.0.5|10.0.5]]
|2019-05-09
|575
|141
|5.6
|-
|[[Release notes/10.0.4|10.0.4]]
|2019-05-04
|575
|139
|5.6
|-
|[[Release notes/10.0.3|10.0.3]]
|2019-03-05
|574
|136
|5.6
|-
|[[Release notes/10.0.2|10.0.2]]
|2019-02-27
|574
|132
|5.6
|-
|[[Release notes/10.0.1|10.0.1]]
|2019-02-11
|573
|129
|5.6
|-
|[[Release notes/10.0.0|10.0.0]]
|2018-12-30
|572
|127
|5.6
|-
|[[Release notes/9.5.0|9.5.0]]
|2018-11-21
|572
|122
|5.6
|-
|[[Release notes/9.4.2|9.4.2]]
|2018-09-12
|570
|117
|
|-
|[[Release notes/9.4.1|9.4.1]]
|2018-07-03
|570
|115
|
|-
|[[Release notes/9.4.0|9.4.0]]
|2018-06-28
|570
|113
|
|-
|[[Release notes/9.3.5|9.3.5]]
|2018-03-07
|556
|111
|
|-
|[[Release notes/9.3.4|9.3.4]]
|2018-02-23
|555
|109
|
|-
|[[Release notes/9.3.3|9.3.3]]
|2018-02-18
|554
|108
|
|-
|9.3.2
|2018-01-11
|553
|106
|
|-
|9.3.1
|2018-01-11
|553
|104
|
|-
|[[Release notes/9.3.0|9.3.0]]
|2018-01-06
|553
|102
|
|-
|9.2.0
|2017-06-05
|549
|100
|
|-
|[[Release notes/9.1.2|9.1.2]]
|2017-03-30
|549
|97
|
|-
|[[Release notes/9.1.1|9.1.1]]
|2017-01-11
|548
|94
|
|-
|[[Release notes/9.1.0|9.1.0]]
|2017-01-03
|547
|93
|
|-
|[[Release notes/9.0.3|9.0.3]]
|2016-08-31
|544
|92
|
|-
|[[Release notes/9.0.2|9.0.2]]
|2016-07-27
|544
|90
|
|-
|[[Release notes/9.0.1|9.0.1]]
|2016-07-06
|543
|86
|
|-
|[[Release notes/9.0.0|9.0.0]]
|2016-05-08
|542
|85
|
|Versions 9.0.0 and later require the database be from a version 8.2.9 or newer to perform an upgrade. (Min DB version 538)
|
|-
|[[Release notes/8.2.10|8.2.10]]
|2015-12-02
|
|84
|
|-
|[[Release notes/8.2.9|8.2.9]]
|2015-10-26
|
|83
|
|-
|[[Release notes/8.2.8|8.2.8]]
|2015-06-13
|
|80
|
|-
|[[Release notes/8.2.7|8.2.7]]
|2015-01-19
|
|75
|
|-
|[[Release notes/8.2.6|8.2.6]]
|2014-07-17
|
|68
|
|-
|[[Release notes/8.2.5|8.2.5]]
|2014-06-19
|
|67
|
|-
|[[Release notes/8.2.4|8.2.4]]
|2014-05-12
|
|65
|
|-
|[[Release notes/8.2.3|8.2.3]]
|2014-05-05
|
|62
|
|-
|[[Release notes/8.2.2|8.2.2]]
|2013-12-12
|
|58
|
|-
|[[Release notes/8.2.1|8.2.1]]
|2013-11-14
|
|56
|
|-
|[[Release notes/8.2.0|8.2.0]]
|2013-06-01
|
|53
|
|-
|[[Release notes/8.1.0|8.1.0]]
|2013-03-25
|
|52
|
|-
|[[Release notes/8.0.0|8.0.0]]
|2013-02-25
|
|51
|
|-
|[[Release notes/7.2.0|7.2.0]]
|2012-07-14
|
|48
|
|-
|[[Release notes/7.1.0|7.1.0]]
|2012-04-11
|
|39
|
|-
|[[Release notes/7.0.2|7.0.2]]
|2012-03-03
|
|37
|
|-
|[[Release notes/7.0.1|7.0.1]]
|2012-02-05
|
|35
|
|-
|[[Release notes/7.0.0|7.0.0]]
|2012-01-27
|
|32
|
|-
|}

== See also ==

[[Category:Upgrading]]
[[Category:Convention Master Release Notes]]
[[Category:Convention Master development]]

Guide/X-forwarded-for

2023-04-18T17:33:56Z

Rex: Added configuration info for PHP-FPM

=X Forwarded For=
The X-Forwarded-For header is a very common header that is used by web application firewalls and other proxy devices including cloudflare.

==Simple X-Forwarded-for implementation==
This simple implementation will ALWAYS replace the ip found in X-forward-for. It's simpler code, but people with malicous intent could potentially spoof the x-forwarded-for header, if there is ingress into your network via other means.
# Open the shared_php/db_connect.php file
# Paste in the code below

Add the following code to your db_connect.php
<syntaxhighlight lang="php">
if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER)){
$_SERVER['REMOTE_ADDR'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
}
</syntaxhighlight>

==More secure X-Forwarded-For Implemention==
This more secure implementation requires you to create a list of machines that you will allow the X-forwarded-for header to be grabbed from.
# Open the shared_php/db_connect.php file
# Paste in the code below
# Edit the $allowedProxies line of the code snippit below; add or remove comma seperated IP address values to the list of ip's which you will allow to provide the X-forwarded-for header.

<syntaxhighlight lang="php">
$allowedProxies = array('10.10.15.7','192.168.15.12');
if (array_key_exists('HTTP_X_FORWARDED_FOR', $_SERVER) && (in_array($_SERVER['REMOTE_ADDR'],$allowedProxies)){
$_SERVER['REMOTE_ADDR'] = $_SERVER['HTTP_X_FORWARDED_FOR'];
}
</syntaxhighlight>

==PHP-FPM more secure X-Forwarded-For implemention==
This more secure implementation requires you to create a list of machines that you will allow the X-forwarded-for header to be grabbed from.
# Run <code>a2enmod remoteip</code>
# Add the following to your Apache site configuration:

<nowiki><IfModule mod_remoteip.c>
RemoteIPHeader X-Forwarded-For
RemoteIPTrustedProxy your-proxy-IP-goes-here
</IfModule></nowiki>

Upgrading Convention Master

2023-03-23T00:51:22Z

Rex: /* Recommended Baseline for new servers */

== Basic overview ==

===Preliminary===
'''''As with all Convention Master upgrades, the basic premise is the same:'''''
# Check the requirements
# Read the release notes
# Back up existing files and the database
# Pull in the new files
# Log in to console with a privileged account to trigger the database update script
# Test the update

== Check requirements ==

Convention Master {{CM current release number}} requires:

* '''PHP {{CM stable php requirement}}''' (End of Life Dec 1, 2019) or later
* '''MySQL {{CM stable mysql requirement}}''', 5.6, or 5.7

=== Recommended Baseline for new servers ===
* Ubuntu 22.04 LTS
* PHP 8.1.x
* MySQL 8.0

For more information, please read the [[Install/1-0/PreRequisites|Manual/Installation requirements]]. For MySQL 8.0 specifically, see [[Setting up Mysql 8]].

=== Configuration Requirements as of version 10.1.0 ===

Version 10.1.0 requires PHP 7.x version 7.1 or later. We recommend using a currently supported version of PHP such as 7.3 or 7.4. We have not validated PHP 8 at this time.

Version 10.1.0 adds an entirely new system for payment processing that supports more providers such as Square and Stripe. It should automatically update your current provider API keys to the new payment system but you will need to enable the payment providers manually in each kiosk you accept payments. If you have any questions please reach out to support.

The manually configured file-based (steps.inc.php) kiosks are deprecated and you should migrate to DB configured kiosks as part of this upgrade if you have not already. To check if you have any file-based kiosks you can go to Admin-Event -> Kiosks in staff console. If it says the status is "In Use" and there is no Edit button then it is a file-based kiosk.

'''It is important to verify the payment step settings on every kiosk after upgrading to version 10.1.0 - otherwise you will not be able to collect payments.'''

=== Configuration Requirements as of version 10.0.0 ===

Upgrading existing Convention Master 9.5.0 installs running on PHP 5.6 to version 10.0.0 does not require any special changes.

Version 10.0.0 adds PHP 7 support and part of that was upgrading the license system. If you run Convention Master '''on PHP 7 or later''' you will need to have a new license file from the [[License Center]].

The old License File format is supported on PHP 5.6 only.
The new license files will work on any PHP version and we recommend swapping them in if you have the chance.

=== Configuration Requirements as of version 9.5.0 ===

Version 9.5.0 introduced a new feature allowing [[Kiosks]] to be configured from the console. These database configured kiosks need a special URL rewrite rule to function properly.
In order for this to function, your <code>Apache vhost</code> configuration file must allow .htaccess file overrides. For instructions on enabling this in Apache, see [[Manual/How to enable Mod Rewrite for new kiosks]]

== Read the release notes ==

The release notes for the current release can be found here: [[Release Notes/10.0.12|10.0.12]]

== Back up existing files and the database ==

:''Full instructions: [[Manual/Backing up Convention Master]]''
While the upgrade scripts are well-maintained and robust, things could still go awry. Before proceeding to update Convention Master and the database schema, '''make a full [[Manual/Backing up Convention Master|backup]]''' of Convention Master, including both the database and the files:

* Convention Master's database:
:* MySQL, do a SQL dump with the <code>mysqldump</code> command:
mysqldump --user='''''db_user''''' --password='''''db_userpassword''''' '''''convention_master_db''''' > '''''file.sql'''''
:* Make sure you move that backup file to a safe location where it won't be deleted or accessable by web.

* Convention Master's files:
:* tar, compress all files into a backup file with the <code>tar</code> command:
tar -cvpzf backup.tar.gz --exclude=/backup.tar.gz /path/to/your/installation/
:* Make sure you move that backup file to a safe location where it won't be deleted or accessable by web.

== Pull in the new files ==

==== Command line ====

You may need to run the svn command as <code>sudo</code> if you don't have full write permissions to the Convention Master install directory under your current user. When running the svn command, it will replace the files with updated versions inside the installation directory:

$ cd /path/to/your/installation/
$ svn up .

== Log in to console with a privileged account to trigger the database update script ==

Now that you have pulled in the new version, you need to log in to the staff console with a privileged account to trigger the database update scripts. Once you enter your username and password on the login screen, it may take a minute or two for the page to load. This is the system running any database upgrades in the release. When it loads, you should see a box with information that your database has been upgraded to version ###. If there were any issues during the database upgrade they will be logged. Please contact Convention Master support if a database upgrade fails.

'''Note: Once you pull in the new files, your Convention Master install will automatically go into maintenance mode to prevent any changes to the database until you trigger the database update script.'''

To trigger the database update script, login to the /console directory in your browser. The login account requires the <code>SYSTEM_UPGRADE</code> permission. Example url:
: <code>https://demo.civetsolutions.com/console</code>

==== What to do in case of "Unable to obtain bruteforce lockout information" error (or similar) on console login screen ====
This error appears on the console login page in a red box and the actual login fields will be missing.

Cause: If you are connecting to an existing old database file and are now running on MySQL version 5.7+ it is possible that you will miss the checks in <code>/setup</code> that detects incompatible default MySQL configurations introduced in MySQL version 5.7+

You are unlikely to experience this issue when upgrading unless you are setting up a new server at the same time and using MySQL version 5.7+ for the first time.

The best way to resolve this issue is to temporarily rename your <code>/shared_php/db_connect.inc.php</code> file to something else and navigate to the setup folder in your browser. It should verify your MySQL configuration and inform you how to do any needed changes.

== Test the update ==

Once the upgrade has been completed, browse Convention Master and check that the following operations work as expected:

* console pages
* kiosks that you previously set up
* send yourself a test email (In the console menu as: Admin Install - Edit Email Servers )

== Frequently asked questions ==

===How hard is it to upgrade?===

If the only existing files you have modified are configuration files like <code>db_connect.inc.php</code> or <code>steps.inc.php</code> and you are upgrading from 9.0.0 or later, the process is very simple. The amount of human work involved is only a few minutes. The database schema changes will take an amount of time proportional to the size of your database — potentially minutes for conventions with millions of attendees, but for a more typical size, it is usually done in seconds.

Upgrading becomes difficult if you have modified our source code, and you don't want your changes to be overwritten.

===How do I upgrade from a really old version? In one step, or in several steps?===

It depends: If you are '''upgrading from Convention Master 8.2.10 or older''', you should upgrade to Convention Master 9.0.0 first.

If you are '''upgrading from Convention Master 9.0.0 or newer''', you can upgrade in one step, from your old version to the latest version.

===Should I back up first?===

Short answer: Yes.

Long answer: It depends on a) how much you value your data, b) how hard it is to create a backup and c) how confident you are with MySQL maintenance and administration. We are not responsible for any data loss incurred by an upgrade. Backups are important.

An upgrade failure may leave your database in an inconsistent state, in between two versions. A PHP or MySQL error might happen during upgrade leaving your database partly upgraded. In such situations, it may be possible to somehow fix this problem with much manual work. However, it will be ''way easier'' to just put a database backup from before running the update in place and to continue with that. Otherwise, you might have hours of - needless - work.

Recovery is often complex. Volunteers on the support chats are unlikely to be impressed if you neglect to make a backup and then need help to recover from upgrade-related corruption. A better outcome is if you can revert to your backup, and then report to Convention Master support the bug in the upgrade process which caused the corruption.

===Can I keep my db_connect.inc.php?===

Yes, but you may have to make some minor changes. The format of db_connect.inc is largely backward compatible. Changes which break db_connect.inc.php compatibility will be documented in the "configuration changes" section of the [[Release notes|release notes]].

===Can my Convention Master stay online while it is upgrading?===

Generally yes, however, SVN may temporarily (for a few seconds) break it. However, once you pull in the new files, your Convention Master install will automatically go into maintenance mode to prevent any changes to the database until you trigger the database update script. If you're quick about it, it should only be a few minutes of "downtime".

===Why upgrade?===

Because it's [[Upgrading Convention Master#How hard is it to upgrade?|usually easy enough]] and [[Upgrading Convention Master#How do I upgrade from a really old version? In one step, or in several steps?|a single step from your version to latest]]].

Recent releases receive security fixes to keep your install and your host safe from vandals, while old releases don't. That makes dozens of good reasons to upgrade!

New major releases come with new features, which you might want to use: see the release notes for details.

== Subpages ==

[[Category:Upgrading]]
[[Category:Convention Master Release Notes]]

Upgrading from MySQL 5.7 to MySQL 8.0

2023-03-22T14:58:51Z

Rex:

== Incompatible SQL modes ==

For MySQL 5.7, the installation instructions guided you to create <code>/etc/mysql/mysql.conf.d/convention_master.cnf</code> with the following contents:

<code>[mysqld]</code>
<code>sql-mode="NO_ZERO_IN_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"</code>

These may also have been placed directly within <code>/etc/mysql/mysql.conf.d/mysqld.cnf</code> or another configuration file; your installation may vary.

'''BEFORE beginning the MySQL upgrade process!!!'''
You must remove <code>NO_AUTO_CREATE_USER</code> from the list of SQL modes. This is not a valid mode in MySQL 8.0, and leaving it in place will cause the upgrade process to break! You should now have

<code>[mysqld]</code>
<code>sql-mode="NO_ZERO_IN_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION"</code>

'''HELP! I didn't read the instructions and my installation is now broken!'''
Find and remove the incompatible SQL mode as mentioned above, then run <code>apt-get --fix-broken install</code>.

== Set the required options ==

'''AFTER''' the upgrade to MySQL 8.0 is finished, log into MySQL as the root user (you may try <code>sudo mysql</code>, or you may also try <code>mysql -u root -p</code>) and run the following query:

<code>SET GLOBAL log_bin_trust_function_creators = 1;</code>

You should now be ready to run with MySQL 8.0.

Upgrading from MySQL 5.7 to MySQL 8.0

2023-03-22T14:58:31Z

Rex: Created page with "== Incompatible SQL modes == For MySQL 5.7, the installation instructions guided you to create <code>/etc/mysql/mysql.conf.d/convention_master.cnf</code> with the following contents: <code>[mysqld]</code> <code>sql-mode="NO_ZERO_IN_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_AUTO_CREATE_USER,NO_ENGINE_SUBSTITUTION"</code> These may also have been placed directly within <code>/etc/mysql/mysql.conf.d/mysqld.cnf</code> or another configuration file; your installation may..."

Main Page

2023-03-22T14:42:24Z

Rex: /* Installation & Upgrade */

=Convention Master Documentation=

This wiki will attempt to document all things Convention Master. It is brand new and currently a work-in-progress, so if a subject below does not yet have a page or has incomplete documentation, please contact a development team member for more information.

== Installation & Upgrade ==
* [[InstallGuide | Installation Guide]]
* [[Upgrading Convention Master]]
* [[Upgrading from MySQL 5.7 to MySQL 8.0]]

== Instructional Guides ==

* [[Guide/MoveDatabase|Moving a Database Between Installations]]
* [[Guide/Vouchers|Voucher System]]
* [[Guide/PaymentGateways|Payment Gateway System]]
* [[Guide/DealersDen|Dealer Den / Vendor Hall Subsystem]]
* [[Guide/X-forwarded-for|X Forwarded For Headers]]

== Other Pages ==
* [[Automated Tasks]]
* [[EventGrid]]
* [[Kiosks]]
* [[Potential New Feature Descriptions]]
* [[UpgradeError_Index|Database Upgrade Errors]]

== Reference Documents ==
* [[Badge Display Code Documentation]]
* [[Tag Replacements]]
* [[Global Settings]]
* [[Sending parsed DL-ID data to CM]]

== Release Notes ==
* [[Release notes]]: All information on releases of Convention Master can be found here.

== Support ==
You can get support by contacting us via email at support[at]civetsolutions[dot]com

Upgrading Convention Master

2023-03-22T14:41:18Z

Rex: /* Check requirements */

== Basic overview ==

===Preliminary===
'''''As with all Convention Master upgrades, the basic premise is the same:'''''
# Check the requirements
# Read the release notes
# Back up existing files and the database
# Pull in the new files
# Log in to console with a privileged account to trigger the database update script
# Test the update

== Check requirements ==

Convention Master {{CM current release number}} requires:

* '''PHP {{CM stable php requirement}}''' (End of Life Dec 1, 2019) or later
* '''MySQL {{CM stable mysql requirement}}''', 5.6, or 5.7

=== Recommended Baseline for new servers ===
* Ubuntu 22.04 LTS
* PHP 8.2.x
* MySQL 8.0

For more information, please read the [[Install/1-0/PreRequisites|Manual/Installation requirements]]. For MySQL 8.0 specifically, see [[Setting up Mysql 8]].

=== Configuration Requirements as of version 10.1.0 ===

Version 10.1.0 requires PHP 7.x version 7.1 or later. We recommend using a currently supported version of PHP such as 7.3 or 7.4. We have not validated PHP 8 at this time.

Version 10.1.0 adds an entirely new system for payment processing that supports more providers such as Square and Stripe. It should automatically update your current provider API keys to the new payment system but you will need to enable the payment providers manually in each kiosk you accept payments. If you have any questions please reach out to support.

The manually configured file-based (steps.inc.php) kiosks are deprecated and you should migrate to DB configured kiosks as part of this upgrade if you have not already. To check if you have any file-based kiosks you can go to Admin-Event -> Kiosks in staff console. If it says the status is "In Use" and there is no Edit button then it is a file-based kiosk.

'''It is important to verify the payment step settings on every kiosk after upgrading to version 10.1.0 - otherwise you will not be able to collect payments.'''

=== Configuration Requirements as of version 10.0.0 ===

Upgrading existing Convention Master 9.5.0 installs running on PHP 5.6 to version 10.0.0 does not require any special changes.

Version 10.0.0 adds PHP 7 support and part of that was upgrading the license system. If you run Convention Master '''on PHP 7 or later''' you will need to have a new license file from the [[License Center]].

The old License File format is supported on PHP 5.6 only.
The new license files will work on any PHP version and we recommend swapping them in if you have the chance.

=== Configuration Requirements as of version 9.5.0 ===

Version 9.5.0 introduced a new feature allowing [[Kiosks]] to be configured from the console. These database configured kiosks need a special URL rewrite rule to function properly.
In order for this to function, your <code>Apache vhost</code> configuration file must allow .htaccess file overrides. For instructions on enabling this in Apache, see [[Manual/How to enable Mod Rewrite for new kiosks]]

== Read the release notes ==

The release notes for the current release can be found here: [[Release Notes/10.0.12|10.0.12]]

== Back up existing files and the database ==

:''Full instructions: [[Manual/Backing up Convention Master]]''
While the upgrade scripts are well-maintained and robust, things could still go awry. Before proceeding to update Convention Master and the database schema, '''make a full [[Manual/Backing up Convention Master|backup]]''' of Convention Master, including both the database and the files:

* Convention Master's database:
:* MySQL, do a SQL dump with the <code>mysqldump</code> command:
mysqldump --user='''''db_user''''' --password='''''db_userpassword''''' '''''convention_master_db''''' > '''''file.sql'''''
:* Make sure you move that backup file to a safe location where it won't be deleted or accessable by web.

* Convention Master's files:
:* tar, compress all files into a backup file with the <code>tar</code> command:
tar -cvpzf backup.tar.gz --exclude=/backup.tar.gz /path/to/your/installation/
:* Make sure you move that backup file to a safe location where it won't be deleted or accessable by web.

== Pull in the new files ==

==== Command line ====

You may need to run the svn command as <code>sudo</code> if you don't have full write permissions to the Convention Master install directory under your current user. When running the svn command, it will replace the files with updated versions inside the installation directory:

$ cd /path/to/your/installation/
$ svn up .

== Log in to console with a privileged account to trigger the database update script ==

Now that you have pulled in the new version, you need to log in to the staff console with a privileged account to trigger the database update scripts. Once you enter your username and password on the login screen, it may take a minute or two for the page to load. This is the system running any database upgrades in the release. When it loads, you should see a box with information that your database has been upgraded to version ###. If there were any issues during the database upgrade they will be logged. Please contact Convention Master support if a database upgrade fails.

'''Note: Once you pull in the new files, your Convention Master install will automatically go into maintenance mode to prevent any changes to the database until you trigger the database update script.'''

To trigger the database update script, login to the /console directory in your browser. The login account requires the <code>SYSTEM_UPGRADE</code> permission. Example url:
: <code>https://demo.civetsolutions.com/console</code>

==== What to do in case of "Unable to obtain bruteforce lockout information" error (or similar) on console login screen ====
This error appears on the console login page in a red box and the actual login fields will be missing.

Cause: If you are connecting to an existing old database file and are now running on MySQL version 5.7+ it is possible that you will miss the checks in <code>/setup</code> that detects incompatible default MySQL configurations introduced in MySQL version 5.7+

You are unlikely to experience this issue when upgrading unless you are setting up a new server at the same time and using MySQL version 5.7+ for the first time.

The best way to resolve this issue is to temporarily rename your <code>/shared_php/db_connect.inc.php</code> file to something else and navigate to the setup folder in your browser. It should verify your MySQL configuration and inform you how to do any needed changes.

== Test the update ==

Once the upgrade has been completed, browse Convention Master and check that the following operations work as expected:

* console pages
* kiosks that you previously set up
* send yourself a test email (In the console menu as: Admin Install - Edit Email Servers )

== Frequently asked questions ==

===How hard is it to upgrade?===

If the only existing files you have modified are configuration files like <code>db_connect.inc.php</code> or <code>steps.inc.php</code> and you are upgrading from 9.0.0 or later, the process is very simple. The amount of human work involved is only a few minutes. The database schema changes will take an amount of time proportional to the size of your database — potentially minutes for conventions with millions of attendees, but for a more typical size, it is usually done in seconds.

Upgrading becomes difficult if you have modified our source code, and you don't want your changes to be overwritten.

===How do I upgrade from a really old version? In one step, or in several steps?===

It depends: If you are '''upgrading from Convention Master 8.2.10 or older''', you should upgrade to Convention Master 9.0.0 first.

If you are '''upgrading from Convention Master 9.0.0 or newer''', you can upgrade in one step, from your old version to the latest version.

===Should I back up first?===

Short answer: Yes.

Long answer: It depends on a) how much you value your data, b) how hard it is to create a backup and c) how confident you are with MySQL maintenance and administration. We are not responsible for any data loss incurred by an upgrade. Backups are important.

An upgrade failure may leave your database in an inconsistent state, in between two versions. A PHP or MySQL error might happen during upgrade leaving your database partly upgraded. In such situations, it may be possible to somehow fix this problem with much manual work. However, it will be ''way easier'' to just put a database backup from before running the update in place and to continue with that. Otherwise, you might have hours of - needless - work.

Recovery is often complex. Volunteers on the support chats are unlikely to be impressed if you neglect to make a backup and then need help to recover from upgrade-related corruption. A better outcome is if you can revert to your backup, and then report to Convention Master support the bug in the upgrade process which caused the corruption.

===Can I keep my db_connect.inc.php?===

Yes, but you may have to make some minor changes. The format of db_connect.inc is largely backward compatible. Changes which break db_connect.inc.php compatibility will be documented in the "configuration changes" section of the [[Release notes|release notes]].

===Can my Convention Master stay online while it is upgrading?===

Generally yes, however, SVN may temporarily (for a few seconds) break it. However, once you pull in the new files, your Convention Master install will automatically go into maintenance mode to prevent any changes to the database until you trigger the database update script. If you're quick about it, it should only be a few minutes of "downtime".

===Why upgrade?===

Because it's [[Upgrading Convention Master#How hard is it to upgrade?|usually easy enough]] and [[Upgrading Convention Master#How do I upgrade from a really old version? In one step, or in several steps?|a single step from your version to latest]]].

Recent releases receive security fixes to keep your install and your host safe from vandals, while old releases don't. That makes dozens of good reasons to upgrade!

New major releases come with new features, which you might want to use: see the release notes for details.

== Subpages ==

[[Category:Upgrading]]
[[Category:Convention Master Release Notes]]

Release notes/10.1.6

2022-09-21T03:16:59Z

Rex: Fixed the date of release.

< [[Release notes]]

'''Convention Master 10.1.6''' Released on September 14, 2022.

'''UPGRADE WARNING:''' If you are currently on version 10.0.x, release 10.1 has special instructions added to the upgrade process. Please make sure you read them before performing an upgrade. See [[Upgrading Convention Master]]

----------------------------------------------------
Release notes for version 10.1.6.
September 14, 2022
----------------------------------------------------
The following changes and or features were added

* Mantis 525 - Bag stuffing stickers PDF now better chops pages without wasted paper.
* Mantis 786 - Bag stuffing stickers can now be printed to PDF printers.
* Mantis 834 - Bag stuffing stickers can now be printed to a PDF file that you can download.
* Mantis 945 - Improved the submit button to prevent multiple clicks from resubmitting the form in den application kiosks. This will prevent duplicated den applications. Also updated table style of pre-auth space codes to match the rest of the kiosk steps.
* Mantis 958 - Bag stuffing stickers now use the standard printer queue system and support all printer types.
* Mantis 1038 - Bag stuffing stickers can now be printed using the filtering system.
* Mantis 1105 - Fixed bug that prevented Space Requests from being deleted by applicants in the ArtShow/Dealer Application kiosks.
* Mantis 1144 - Overhauled Bag Stuffing Sticker system.
* Mantis 1165 - Corrected a bug that prevented "use event default" from working correctly on the agreements step of the kiosk.
* Mantis 1167 - Overhauled Payment Holds system to handle abandoned carts and instant payment methods better so automated tasks can be used to clean up abandoned shopping carts effectively.
* Mantis 1195 - Created a new feature that will log the history of Fan name and legal name changes and provide the ability to search for previously used names quickly.
* Mantis 1214 - Created a new feature to find and display user account duplicates.
* Mantis 1217 - Upgrade license checks to warn when a valid license is installed but is for the wrong event database.
(primarily to help our customers who share equipment between multiple events.)
* Mantis 1218 - Added PHP CLI diagnostic info to the Diagnostic Log to assist in debugging installation issues.
* Mantis 1219 - Updated DB Sanitization script for registrant notes.
* Mantis 1227 - Fixed an issue preventing database upgrades prior to v576 from working in some situations.
* Mantis 1231 - Added the barcode options to the Online Payment kiosk step. This will allow people to pay in line and display a barcode on their phone to be ready for the cashier.
* Mantis 1234 - Improved the submit button to prevent multiple clicks from resubmitting the form in kiosks. This will prevent duplicate notification emails.
* Mantis 1235 - Improved method used to pass data in URLs.
Note: This will invalidate some URLs generated on console/kiosk pages before applying the update.
Refreshing the page will generate new URLs, which only matters to users actively using CM during the upgrade.
* Mantis 1239 - Automatically process zero-dollar payments (if applicable) on the Kiosk payment step. This resolves an issue for events using memberships that cost $0 that comes with bag-stuffed products.
* Mantis 1240 - Add a default payment hold to the user's account at the select membership kiosk screen if their payment hold is either non-existent or expired.
* Mantis 1241 - Add a default payment hold to the user's account at the go shopping kiosk screen if their payment hold is either non-existent or expired.
* Mantis 1242 - Ensure that instant payment Gateway transactions create a payment hold in the kiosk payment holds system.
* Mantis 1246 - Corrected an issue where certain situations could prevent bag stuffing labels from being generated for bag stuffed products purchased with a voucher.
* Mantis 1248 - Updated database migration runner for newer versions of MySQL server to prevent UTF8 upgrade from running unnecessarily during database migrations. (this only impacted performance - no data was modified.)
* Mantis 1253 - Updated DB Sanitization script to run at the current database version.
* Mantis 1254 - Updated Kiosk change name step to utilize new name logging system.
* Mantis 1258 - Corrected an issue on the choose freebies kiosk step, allowing you to select an out-of-stock product if it had a negative number remaining in inventory.

{{UpgradeAdvice}}

Release notes

2020-05-31T21:18:01Z

Rex: Added links for 10.0.11 and 10.0.12.

Upgrading Convention Master

2020-05-31T21:08:11Z

Rex: Fixed link.

== Basic overview ==

===Preliminary===
'''''As with all Convention Master upgrades, the basic premise is the same:'''''
# Check the requirements
# Read the release notes
# Back up existing files and the database
# Pull in the new files
# Log in to console with a privileged account to trigger the database update script
# Test the update

== Check requirements ==

Convention Master {{CM current release number}} requires:

* '''PHP {{CM stable php requirement}}''' (End of Life Dec 31, 2018) or later
:: PHP 7.2.x recomended

* '''MySQL {{CM stable mysql requirement}}''', 5.6, or 5.7

=== Recommended Baseline for new servers ===
* Ubuntu 18.04 LTS
* PHP 7.2.x
* MySQL 5.7

For more information, please read the [[Manual/Installation requirements]] and [[Manual/Compatibility]].

=== Configuration Requirements as of version 10.0.0 ===

Upgrading existing Convention Master 9.5.0 installs running on PHP 5.6 to version 10.0.0 does not require any special changes.

Version 10.0.0 adds PHP 7 support and part of that was upgrading the license system. If you run Convention Master '''on PHP 7 or later''' you will need to have a new license file from the [[License Center]].

The old License File format is supported on PHP 5.6 only.
The new license files will work on any PHP version and we recommend swapping them in if you have the chance.

=== Configuration Requirements as of version 9.5.0 ===

Version 9.5.0 introduced a new feature allowing [[Kiosks]] to be configured from the console. These database configured kiosks need a special URL rewrite rule to function properly.
In order for this to function, your <code>Apache vhost</code> configuration file must allow .htaccess file overrides. For instructions on enabling this in Apache, see [[Manual/How to enable Mod Rewrite for new kiosks]]

== Read the release notes ==

The release notes for the current release can be found here: [[Release Notes/10.0.12|10.0.12]]

== Back up existing files and the database ==

:''Full instructions: [[Manual/Backing up Convention Master]]''
While the upgrade scripts are well-maintained and robust, things could still go awry. Before proceeding to update Convention Master and the database schema, '''make a full [[Manual/Backing up Convention Master|backup]]''' of Convention Master, including both the database and the files:

* Convention Master's database:
:* MySQL, do a SQL dump with the <code>mysqldump</code> command:
mysqldump --user='''''db_user''''' --password='''''db_userpassword''''' '''''convention_master_db''''' > '''''file.sql'''''
:* Make sure you move that backup file to a safe location where it won't be deleted or accessable by web.

* Convention Master's files:
:* tar, compress all files into a backup file with the <code>tar</code> command:
tar -cvpzf backup.tar.gz --exclude=/backup.tar.gz /path/to/your/installation/
:* Make sure you move that backup file to a safe location where it won't be deleted or accessable by web.

== Pull in the new files ==

==== Command line ====

You may need to run the svn command as <code>sudo</code> if you don't have full write permissions to the Convention Master install directory under your current user. When running the svn command, it will replace the files with updated versions inside the installation directory:

$ cd /path/to/your/installation/
$ svn up .

== Log in to console with a privileged account to trigger the database update script ==

Now that you have pulled in the new version, you need to log in to the staff console with a privileged account to trigger the database update scripts. Once you enter your username and password on the login screen, it may take a minute or two for the page to load. This is the system running any database upgrades in the release. When it loads, you should see a box with information that your database has been upgraded to version ###. If there were any issues during the database upgrade they will be logged. Please contact Convention Master support if a database upgrade fails.

'''Note: Once you pull in the new files, your Convention Master install will automatically go into maintenance mode to prevent any changes to the database until you trigger the database update script.'''

To trigger the database update script, login to the /console directory in your browser. The login account requires the <code>SYSTEM_UPGRADE</code> permission. Example url:
: <code>https://demo.civetsolutions.com/console</code>

==== What to do in case of "Unable to obtain bruteforce lockout information" error (or similar) on console login screen ====
This error appears on the console login page in a red box and the actual login fields will be missing.

Cause: If you are connecting to an existing old database file and are now running on MySQL version 5.7+ it is possible that you will miss the checks in <code>/setup</code> that detects incompatible default MySQL configurations introduced in MySQL version 5.7+

You are unlikely to experience this issue when upgrading unless you are setting up a new server at the same time and using MySQL version 5.7+ for the first time.

The best way to resolve this issue is to temporarily rename your <code>/shared_php/db_connect.inc.php</code> file to something else and navigate to the setup folder in your browser. It should verify your MySQL configuration and inform you how to do any needed changes.

== Test the update ==

Once the upgrade has been completed, browse Convention Master and check that the following operations work as expected:

* console pages
* kiosks that you previously set up
* send yourself a test email (In the console menu as: Admin Install - Edit Email Servers )

== Frequently asked questions ==

===How hard is it to upgrade?===

If the only existing files you have modified are configuration files like <code>db_connect.inc.php</code> or <code>steps.inc.php</code> and you are upgrading from 9.0.0 or later, the process is very simple. The amount of human work involved is only a few minutes. The database schema changes will take an amount of time proportional to the size of your database — potentially minutes for conventions with millions of attendees, but for a more typical size, it is usually done in seconds.

Upgrading becomes difficult if you have modified our source code, and you don't want your changes to be overwritten.

===How do I upgrade from a really old version? In one step, or in several steps?===

It depends: If you are '''upgrading from Convention Master 8.2.10 or older''', you should upgrade to Convention Master 9.0.0 first.

If you are '''upgrading from Convention Master 9.0.0 or newer''', you can upgrade in one step, from your old version to the latest version.

===Should I back up first?===

Short answer: Yes.

Long answer: It depends on a) how much you value your data, b) how hard it is to create a backup and c) how confident you are with MySQL maintenance and administration. We are not responsible for any data loss incurred by an upgrade. Backups are important.

An upgrade failure may leave your database in an inconsistent state, in between two versions. A PHP or MySQL error might happen during upgrade leaving your database partly upgraded. In such situations, it may be possible to somehow fix this problem with much manual work. However, it will be ''way easier'' to just put a database backup from before running the update in place and to continue with that. Otherwise, you might have hours of - needless - work.

Recovery is often complex. Volunteers on the support chats are unlikely to be impressed if you neglect to make a backup and then need help to recover from upgrade-related corruption. A better outcome is if you can revert to your backup, and then report to Convention Master support the bug in the upgrade process which caused the corruption.

===Can I keep my db_connect.inc.php?===

Yes, but you may have to make some minor changes. The format of db_connect.inc is largely backward compatible. Changes which break db_connect.inc.php compatibility will be documented in the "configuration changes" section of the [[Release notes|release notes]].

===Can my Convention Master stay online while it is upgrading?===

Generally yes, however, SVN may temporarily (for a few seconds) break it. However, once you pull in the new files, your Convention Master install will automatically go into maintenance mode to prevent any changes to the database until you trigger the database update script. If you're quick about it, it should only be a few minutes of "downtime".

===Why upgrade?===

Because it's [[Upgrading Convention Master#How hard is it to upgrade?|usually easy enough]] and [[Upgrading Convention Master#How do I upgrade from a really old version? In one step, or in several steps?|a single step from your version to latest]]].

Recent releases receive security fixes to keep your install and your host safe from vandals, while old releases don't. That makes dozens of good reasons to upgrade!

New major releases come with new features, which you might want to use: see the release notes for details.

== Subpages ==

[[Category:Upgrading]]
[[Category:Convention Master Release Notes]]

Upgrading Convention Master

2020-05-31T21:07:23Z

Rex: Update current release link.

== Basic overview ==

===Preliminary===
'''''As with all Convention Master upgrades, the basic premise is the same:'''''
# Check the requirements
# Read the release notes
# Back up existing files and the database
# Pull in the new files
# Log in to console with a privileged account to trigger the database update script
# Test the update

== Check requirements ==

Convention Master {{CM current release number}} requires:

* '''PHP {{CM stable php requirement}}''' (End of Life Dec 31, 2018) or later
:: PHP 7.2.x recomended

* '''MySQL {{CM stable mysql requirement}}''', 5.6, or 5.7

=== Recommended Baseline for new servers ===
* Ubuntu 18.04 LTS
* PHP 7.2.x
* MySQL 5.7

For more information, please read the [[Manual/Installation requirements]] and [[Manual/Compatibility]].

=== Configuration Requirements as of version 10.0.0 ===

Upgrading existing Convention Master 9.5.0 installs running on PHP 5.6 to version 10.0.0 does not require any special changes.

Version 10.0.0 adds PHP 7 support and part of that was upgrading the license system. If you run Convention Master '''on PHP 7 or later''' you will need to have a new license file from the [[License Center]].

The old License File format is supported on PHP 5.6 only.
The new license files will work on any PHP version and we recommend swapping them in if you have the chance.

=== Configuration Requirements as of version 9.5.0 ===

Version 9.5.0 introduced a new feature allowing [[Kiosks]] to be configured from the console. These database configured kiosks need a special URL rewrite rule to function properly.
In order for this to function, your <code>Apache vhost</code> configuration file must allow .htaccess file overrides. For instructions on enabling this in Apache, see [[Manual/How to enable Mod Rewrite for new kiosks]]

== Read the release notes ==

The release notes for the current release can be found here: [[Release notes/10.0.12|10.0.12]]

== Back up existing files and the database ==

:''Full instructions: [[Manual/Backing up Convention Master]]''
While the upgrade scripts are well-maintained and robust, things could still go awry. Before proceeding to update Convention Master and the database schema, '''make a full [[Manual/Backing up Convention Master|backup]]''' of Convention Master, including both the database and the files:

* Convention Master's database:
:* MySQL, do a SQL dump with the <code>mysqldump</code> command:
mysqldump --user='''''db_user''''' --password='''''db_userpassword''''' '''''convention_master_db''''' > '''''file.sql'''''
:* Make sure you move that backup file to a safe location where it won't be deleted or accessable by web.

* Convention Master's files:
:* tar, compress all files into a backup file with the <code>tar</code> command:
tar -cvpzf backup.tar.gz --exclude=/backup.tar.gz /path/to/your/installation/
:* Make sure you move that backup file to a safe location where it won't be deleted or accessable by web.

== Pull in the new files ==

==== Command line ====

You may need to run the svn command as <code>sudo</code> if you don't have full write permissions to the Convention Master install directory under your current user. When running the svn command, it will replace the files with updated versions inside the installation directory:

$ cd /path/to/your/installation/
$ svn up .

== Log in to console with a privileged account to trigger the database update script ==

Now that you have pulled in the new version, you need to log in to the staff console with a privileged account to trigger the database update scripts. Once you enter your username and password on the login screen, it may take a minute or two for the page to load. This is the system running any database upgrades in the release. When it loads, you should see a box with information that your database has been upgraded to version ###. If there were any issues during the database upgrade they will be logged. Please contact Convention Master support if a database upgrade fails.

'''Note: Once you pull in the new files, your Convention Master install will automatically go into maintenance mode to prevent any changes to the database until you trigger the database update script.'''

To trigger the database update script, login to the /console directory in your browser. The login account requires the <code>SYSTEM_UPGRADE</code> permission. Example url:
: <code>https://demo.civetsolutions.com/console</code>

==== What to do in case of "Unable to obtain bruteforce lockout information" error (or similar) on console login screen ====
This error appears on the console login page in a red box and the actual login fields will be missing.

Cause: If you are connecting to an existing old database file and are now running on MySQL version 5.7+ it is possible that you will miss the checks in <code>/setup</code> that detects incompatible default MySQL configurations introduced in MySQL version 5.7+

You are unlikely to experience this issue when upgrading unless you are setting up a new server at the same time and using MySQL version 5.7+ for the first time.

The best way to resolve this issue is to temporarily rename your <code>/shared_php/db_connect.inc.php</code> file to something else and navigate to the setup folder in your browser. It should verify your MySQL configuration and inform you how to do any needed changes.

== Test the update ==

Once the upgrade has been completed, browse Convention Master and check that the following operations work as expected:

* console pages
* kiosks that you previously set up
* send yourself a test email (In the console menu as: Admin Install - Edit Email Servers )

== Frequently asked questions ==

===How hard is it to upgrade?===

If the only existing files you have modified are configuration files like <code>db_connect.inc.php</code> or <code>steps.inc.php</code> and you are upgrading from 9.0.0 or later, the process is very simple. The amount of human work involved is only a few minutes. The database schema changes will take an amount of time proportional to the size of your database — potentially minutes for conventions with millions of attendees, but for a more typical size, it is usually done in seconds.

Upgrading becomes difficult if you have modified our source code, and you don't want your changes to be overwritten.

===How do I upgrade from a really old version? In one step, or in several steps?===

It depends: If you are '''upgrading from Convention Master 8.2.10 or older''', you should upgrade to Convention Master 9.0.0 first.

If you are '''upgrading from Convention Master 9.0.0 or newer''', you can upgrade in one step, from your old version to the latest version.

===Should I back up first?===

Short answer: Yes.

Long answer: It depends on a) how much you value your data, b) how hard it is to create a backup and c) how confident you are with MySQL maintenance and administration. We are not responsible for any data loss incurred by an upgrade. Backups are important.

An upgrade failure may leave your database in an inconsistent state, in between two versions. A PHP or MySQL error might happen during upgrade leaving your database partly upgraded. In such situations, it may be possible to somehow fix this problem with much manual work. However, it will be ''way easier'' to just put a database backup from before running the update in place and to continue with that. Otherwise, you might have hours of - needless - work.

Recovery is often complex. Volunteers on the support chats are unlikely to be impressed if you neglect to make a backup and then need help to recover from upgrade-related corruption. A better outcome is if you can revert to your backup, and then report to Convention Master support the bug in the upgrade process which caused the corruption.

===Can I keep my db_connect.inc.php?===

Yes, but you may have to make some minor changes. The format of db_connect.inc is largely backward compatible. Changes which break db_connect.inc.php compatibility will be documented in the "configuration changes" section of the [[Release notes|release notes]].

===Can my Convention Master stay online while it is upgrading?===

Generally yes, however, SVN may temporarily (for a few seconds) break it. However, once you pull in the new files, your Convention Master install will automatically go into maintenance mode to prevent any changes to the database until you trigger the database update script. If you're quick about it, it should only be a few minutes of "downtime".

===Why upgrade?===

Because it's [[Upgrading Convention Master#How hard is it to upgrade?|usually easy enough]] and [[Upgrading Convention Master#How do I upgrade from a really old version? In one step, or in several steps?|a single step from your version to latest]]].

Recent releases receive security fixes to keep your install and your host safe from vandals, while old releases don't. That makes dozens of good reasons to upgrade!

New major releases come with new features, which you might want to use: see the release notes for details.

== Subpages ==

[[Category:Upgrading]]
[[Category:Convention Master Release Notes]]

Release notes/10.0.12

2020-05-31T21:05:29Z

Rex: Fixed formatting

< [[Release notes]]

'''Convention Master 10.0.12''' Released on May 30, 2020. This is an important upgrade and bugfix release. This release fixes some issues and adds new functionality around the use of user defined fields (UDFs)

'''Security Note:'''
The previous version 10.0.9 contains a security patch for CM which will be applied here and is important to review.

'''Upgrade Note: Kiosk UDF display options have changed:'''
The default behavior for displaying user defined fields have changed. The old behavior was to display '''all''' user defined fields to the attendee if no UDFs were explicitly selected. The new behavior will display '''no''' user defined fields to the attendee if no UDFs are explicitly selected.

'''Upgrade Note: CUPS printing changes:'''
The previous version 10.0.9 contains changes to how cups works. This change requires curl to be installed on the server. This is a standard package and you can install it if it is not already by the following command:

sudo apt install curl

'''Upgrade Note: Theme Style Sheet'''
The previous version 10.0.9 contains changes which will be included here. If you are using a custom theme or a theme other than Redmond please update your main css file with a new class for the new buttons for username login. located in theme/redmond/styles.css on line 1097: .bluebutton class.

----------------------------------------------------
Release notes for version 10.0.12.
May 30, 2020
----------------------------------------------------
The following changes and or features were added
* Mantis 1091 - Added ability to search UDF results using udf:<response> and it will seach ANY/ALL UDFs for that response. The ability to search specific UDF fields already existed by searching <fieldname>:<response> or just <fieldname>: For example if the field was named "Staff" then you could search "Staff:" and find all with that flag. If a field was named "Species" you could search "Species:Civet" and find all civets.
* Mantis 1090 - Corrected issue where dictated user defined fields were not saving correctly especially when there were no user defined fields set to display items. System now properly handles kiosks where user defined fields are simply set to dictated.
* Mantis 1089 - Added a new user defined field type "regex" that will allow you to create a user defined field that can be validated before saving using regular expressions.
* Changed behaviour of kiosk; if you choose the user defined field step in kiosk configuration but choose NO settings or fields to set up, the default behaviour has changed from displaying all available user defined fields to the user, to not displaying anything to the user and silently moving onto the next step.
* Updated user defined fields to support random assignment of list items.
* Updated user defined fields, allow the use of blank() to force-erase the value that may have previously existed for a user defined field.
* Updated user defined fields, now field_defined can become the "default value" for fields that are being displayed. This means that users can set a default value but allow users to change that value.
* Updated the field editor to include links to the ability to view the raw data and graph data of the fields.

{{UpgradeAdvice}}

Release notes/10.0.12

2020-05-31T21:00:53Z

Rex: Uploaded release notes for 10.0.12.

< [[Release notes]]

'''Convention Master 10.0.12''' Released on May 30, 2020. This is an important upgrade and bugfix release. This release fixes some issues and adds new functionality around the use of user defined fields (UDFs)

'''Security Note:'''
The previous version 10.0.9 contains a security patch for CM which will be applied here and is important to review.

'''Upgrade Note: Kiosk UDF display options have changed:'''
The default behavior for displaying user defined fields have changed. The old behavior was to display ALL user defined fields to the attendee if no UDFs were explicitly selected. The new behavior will display NO user defined fields to the attendee if no UDFs are explicitly selected.

'''Upgrade Note: CUPS printing changes:'''
The previous version 10.0.9 contains changes to how cups works. This change requires curl to be installed on the server. This is a standard package and you can install it if it is not already by the following command:

sudo apt install curl

'''Upgrade Note: Theme Style Sheet'''
The previous version 10.0.9 contains changes which will be included here. If you are using a custom theme or a theme other than Redmond please update your main css file with a new class for the new buttons for username login. located in theme/redmond/styles.css on line 1097: .bluebutton class.

----------------------------------------------------
Release notes for version 10.0.12.
May 30, 2020
----------------------------------------------------
The following changes and or features were added
* Mantis 1091 - Added ability to search UDF results using udf:<response> and it will seach ANY/ALL UDFs for that response. The ability to search specific UDF fields already existed by searching <fieldname>:<response> or just <fieldname>: For example if the field was named "Staff" then you could search "Staff:" and find all with that flag. If a field was named "Species" you could search "Species:Civet" and find all civets.
* Mantis 1090 - Corrected issue where dictated user defined fields were not saving correctly especially when there were no user defined fields set to display items. System now properly handles kiosks where user defined fields are simply set to dictated.
* Mantis 1089 - Added a new user defined field type "regex" that will allow you to create a user defined field that can be validated before saving using regular expressions.
* Changed behaviour of kiosk; if you choose the user defined field step in kiosk configuration but choose NO settings or fields to set up, the default behaviour has changed from displaying all available user defined fields to the user, to not displaying anything to the user and silently moving onto the next step.
* Updated user defined fields to support random assignment of list items.
* Updated user defined fields, allow the use of blank() to force-erase the value that may have previously existed for a user defined field.
* Updated user defined fields, now field_defined can become the "default value" for fields that are being displayed. This means that users can set a default value but allow users to change that value.
* Updated the field editor to include links to the ability to view the raw data and graph data of the fields.

{{UpgradeAdvice}}

Release notes/10.0.11

2020-05-31T20:51:39Z

Rex: Uploaded release notes for 10.0.11.

< [[Release notes]]

'''Convention Master 10.0.11''' Released on March 4, 2020. This is an important upgrade and bugfix release. This release fixes some issues created in the 10.0.9 branch and additionally fixes various issues in the cashier flow.

'''Security Note:'''
The previous version 10.0.9 contains a security patch for CM which will be applied here and is important to review.

'''Upgrade Note: CUPS printing changes:'''
The previous version 10.0.9 contains changes to how cups works. This change requires curl to be installed on the server. This is a standard package and you can install it if it is not already by the following command:

sudo apt install curl

'''Upgrade Note: Theme Style Sheet'''
The previous version 10.0.9 contains changes which will be included here. If you are using a custom theme or a theme other than Redmond please update your main css file with a new class for the new buttons for username login. located in theme/redmond/styles.css on line 1097: .bluebutton class.

----------------------------------------------------
Release notes for version 10.0.11.
March 4, 2020
----------------------------------------------------
The following changes and or features were added

* Mantis 1050 - Improved cashier flow/speed by removing the requirement to record a zero dollar payment when cashing out people who do not owe a balance during finalize sale step.
* Mantis 1052 - Removed debug statement "Programmatic Half at Line 239" on console index page.
* Mantis 1053 - Corrected a bug with the sanitize DB script that caused it to fail with "Additional badges" error.
* Mantis 1055 - Corrected a bug that can cause a loop to happen in cash register when adding users to cart related to registrant notes.
* Mantis 1058 - Corrected a bug introduced in 10.0.9 that prevented the amount of change owed to an attendee from showing on cash register screen after cash payment.

* Fixed bug in kiosk deprecation warning on edit kiosks page that caused it to show even when no file-based kiosks were in use.

{{UpgradeAdvice}}