Convention Master Documentation - User contributions [en]

Release notes

2025-03-08T02:51:53Z

Alofoxx:

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/12.0.0|12.0.0]]
| 2025-03-03
| 595
| 197
| 8.1
| This is a major feature release. Cashier V2 and Con Store modules
|-
|[[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/12.0.0

2025-03-08T02:49:14Z

Alofoxx: Created page with "< Release notes ---------------------------------------------------- Release notes for version 12.0.0. March 3, 2025, 18:26: ---------------------------------------------------- This release contains all changes listed below ---------------------------------------------------- NEW Features: * Cashier V2 - A new cashier ui and workflow optimised for quick onsite registration via Driver's License scans as well as integrated support for Squa..."

< [[Release notes]]

----------------------------------------------------
Release notes for version 12.0.0.
March 3, 2025, 18:26:
----------------------------------------------------
This release contains all changes listed below
----------------------------------------------------

NEW Features:
* Cashier V2 - A new cashier ui and workflow optimised for quick onsite registration via Driver's License scans as well as integrated support for Square Terminal stations for payment and agreement capture.
* Con Store Fulfilment (Mantis 1463) - A new module that supports tracking/handling the pick of purchased items, useful for when swag pickup is with store/outside of reg room.
* Enhanced Driver License scanning/registration - In Cashier v2, scanning a Driver's License will show an improved results screen with registration status. Creating new users and registering on the spot with a scan is also now supported.
* Passwordless Kiosk Login via Email one-time link "OTP Login" - There is now a new kiosk first step that will allow users to log in by clicking a confirmation link sent to their email and remove the use of any kiosk passwords.
* Multi-attendee registration and payment during one kiosk session - The OTP Login kiosk adds support for adding multiple attendee registrations to their cart for a single payment. This will significantly improve the family registration process. **Note:** This requires the "Return to start" kiosk step to be active in your kiosk config to allow multi-user workflow.
* Mantis 869 - Con Store Module: new module for selling items in the con store through CM. Currently, it only supports integrated Square Terminal stations for payment. (other types like cash/ect comming soon)
* Mantis 1206 - Attendee Badge Display Code (layout/background) selection can now be edited through the bulk user editor.
* Mantis 1397 - Cashier V2 will now add families (or linked users) to the cart - When adding an attendee to the cart, and they have links to other attendees (such as child/parent), all users get added to the cashier cart.
* Mantis 1433 - Added payment gateway transaction number information to payment details in console to assist with refunds/payment lookup on payment provider website.
* Mantis 1438 - Fixed display issue on the UDF settings section when configuring a kiosk.
* Mantis 1440 - Added support for integrated payments through Square Terminals (standalone terminals - not readers attached to mobile devices). Cashier v2 and Con Store will initiate payment collection on the terminal and store the transaction ID in CM automatically.
* Mantis 1460 - Added printable schedule report for Event Grid Module - A report that can be given to staff/panelists with a list of every event they are part of.
* Mantis 1464 - Improved information display on items picked up or not on accounting tab of user profile.
* Mantis 1468 - Added staff satisfaction survey tool to cashier v2 system.
* Mantis 1469 - Added Driver License scanning support to the Manual Reg Entry page in the Registration console menu for account creation.
* Mantis 1475 - Corrected issue on artshow edit art screen where existing description didnt populate the edit form.
* Mantis 1477 - Corrected issue with payment step in kiosk not loading.
* Mantis 1478 - Fixed page crash when refunding items.
* Mantis 1484 - Add total processed to cashier report
* Mantis 1486 - Fixed issue with assigning permissions to low uid staff.
* Mantis 1488 - Added support to download all artshow/dealer den application responses as a CSV file.
* Mantis 1489 - Removed IP locking on kiosk sessions - This adds support for iPhone mobile users getting the session reset error due to Apple's changing privacy feature.
* Mantis 1490 - Activy on any tab will keep all tabs from logging out.
* Mantis 1498 - Cashier v2 birthday verification screen now has buttons to assist month entry.
* Mantis 1499 - User Admin - Staff account settings fixes: Added checkboxes for setting account expiry and set default comp balance to zero.
* Mantis 1505 - Fixed bug preventing the Arshow sale report PDF from generating.
* Mantis 1507 - Fixed USA zipcode location updater for the Map Attendee Location report.
* Mantis 1510 - Added support for using hCaptcha on registration kiosks.
* Various performance improvements and error handling enhancements.

Template:InstallationTOC

2023-10-07T00:26:13Z

Alofoxx:

== Installation & Upgrade ==
[[InstallGuide | Installation Guide]]
# [[Install/1-0/PreRequisites|Pre-Requisites / Getting Ready]]
# [[Install/2-0/ServerPackages|Installing Software on the Server]]
## [[Install/2-1/Joe|The Joe Editor]]
## [[Install/2-2/Networking|Configure Networking]]
## [[Install/2-3/Apache|Configure Apache Web Server]]
## [[Install/2-4/Ioncube|Install the Ioncube Loader]]
# [[Install/3-0/CMApp|Installing Convention Master]]
## [[Install/3-1/License|Add your License]]
## [[Install/3-2/Database|Configure the Database]]
## [[Install/3-3/CMConfig|Connect Convention Master to the Database]]
## [[Install/3-4/Cron|Set up Scheduled Tasks]]
## [[Install/3-5/CUPS|Install the CUPS Printing System]]
## [[Install/3-6/EPL|Install PkippLib for EPL Printers]]
# [[Install/4-0/Printing|Setting up Printing]]
## [[Install/4-1/CUPSConfig|Configure CUPS]]
## [[Install/4-2/EPLConfig|Configure EPL printers]] (inc. Zebra printers)
## [[Install/4-3/PDFPrint|Set up Printing to PDF]]
## [[Install/4-4/SocketPrint|Set up Socket Printers]]
## [[Install/4-5/CivetPrint|Set up CivetPrint]] (Deprecated)

<br />
[[Upgrading Convention Master]]
<br />

Install/4-0/Printing

2023-10-07T00:24:23Z

Alofoxx:

<div style="float:right;">
[[Install/4-1/CUPSConfig|Next: 4.1 - Configure CUPS >>]]
</div>
[[Install/3-6/EPL|<< Previously: 3.6 - Install PkippLib for EPL Printers]]

= Setting up Printing =

The next section of the document will walk you through setting up different print methods for Convention Master. You are welcome to use one or more of the available print methods in any combination to get the best printing setup for your event.

'''Note:''' We do not recommend installing printing systems on any public-facing servers intended only to take registrations. Install printing systems only on servers that are intended to print badges, agreements, etc.'''

Install/3-6/EPL

2023-10-07T00:24:09Z

Alofoxx:

<div style="float:right;">
[[Install/4-0/Printing|Next: 4.0 - Setting up Printing >>]]
</div>
[[Install/3-5/CUPS|<< Previously: 3.5 - Install the CUPS Printing System]]

= Install PkippLib for EPL Printers =

If your using the EPL print method within the registration system, then you will need the PKIpp Library. This library is included with Convention Master but requires some special setup in order to operate properly and be able to print labels.

1. Move into the /var/www/printing/pkipplib/pkipplib-0.07/

<code>cd /var/www/printing/pkipplib/pkipplib-0.07/</code>

2. Set up pkipplib (be sure to do this as root)

<code>sudo python setup.py install</code>

[[File:pkipplib-install.png]]

3. Pkipplib should now be installed.

'''Note:''' If you did not install the Python imaging library in stage 2, install it now:

<code>sudo apt-get install python3-pil</code>

Install/3-4/Cron

2023-10-07T00:23:39Z

Alofoxx:

<div style="float:right;">
[[Install/3-5/CUPS|Next: 3.5 - Install the CUPS Printing System >>]]
</div>
[[Install/3-3/CMConfig|<< Previously: 3.3 - Connect Convention Master to the Database]]

= Set Up Scheduled Tasks =

CM uses a script (<code>cm_task_manager.php</code>)to run scheduled tasks on the server backend so that it can have more time to do its job, and not require that a user have a tab open in their browser to run.
Currently, CM has five scheduled tasks that are run by this script:
* See [[Automated Tasks]]

== Automated Cron Job setup for CM ==

Use the this method to install the Cron Job if the following is true:

* You're running on Ubuntu 18.04 and
* Have installed Apache and CM with as laid out in this guide
* The user for apache is www-data

On the command line, navigate to your CM web root (if you followed this guide /var/www), then cd into other/shell_scripts

then run

./addcmcron.sh www-data

and the script will install it for you.

== Manual Cron Job Setup for CM ==

=== Set up Cron Job for CM ===

In order to take advantage of these scheduled tasks, the <code>cm_task_manager.php</code> script must be called regularly by your server's scheduler. On Linux, this system is generally Cron, but on your system it may be called something else. Cron allows Linux to run commands or scripts at a given date and time. and schedule scripts to be executed periodically.

'''NOTE: If we are hosting your installation simply contact support and we will get it setup for you when needed.'''

These instructions assume:

# You have shell access to your web server running Convention Master and <code>sudo</code> privileges. If you don't have either of these and would like help setting this up, please contact our support.
# Your server Apache user is <code>www-data</code> (the default on Ubuntu) - if it is something else, substitute your Apache user in "Create entry in Cron".

== Fetch Required Information ==

Before you can set up a new Cron task for cm, you should note down where your CM is installed. This is the folder that you downloaded the CM code into.
As with the rest of this guide, we will assume it is located in <code> /var/www/</code>. If your location is different, substitute <code> /var/www/ </code> with your path.

Inside this folder you should have <code>automated_tasks/cm_task_manager.php</code>.

This means that the full path of the CM cron script is <code> /var/www/automated_tasks/cm_task_manager.php </code>. '''Note this as your script path.'''

Next, you will need the full path to your PHP executable. Type <code>which php</code> into your terminal to get this information.
It should output something like <code>/usr/bin/php</code>. '''Note this as your php path.'''

Last, determine how often you want it to check if there is anything to do. To make up your own you can look at [http://www.crontabgenerator.com/ crontabgenerator]
We recommend every 5 minutes which will look like this <code>*/5 * * * *</code>. '''Note this as your cron timing.'''

== Create entry in Cron ==

Now you have what you need to create the Cron entry.
# Type <code> sudo crontab -u www-data -e</code> to open the Cron scheduling file (the crontab) for the web user.
# Move to the bottom of the file and add a new line.
# Enter your cron timing, php path, and script path as noted. Your line should look like this: <code>*/5 * * * * /usr/bin/php /var/www/automated_tasks/cm_task_manager.php</code>
# Make another blank line after your entry and save the file.

Setup is now complete.

Install/3-5/CUPS

2023-10-07T00:22:49Z

Alofoxx:

<div style="float:right;">
[[Install/3-6/EPL|Next: 3.6 - Install PkippLib for EPL Printers >>]]
</div>
[[Install/3-4/Cron|<< Previously: 3.4 - Set Up Scheduled Tasks]]

= Install the CUPS Printing System =

This section of the guide will explain how to install CUPS, which is the Linux printing system required for Convention Master to be able to print to paper or badges. Don’t forget that you need to set CUPS up to be accessible and administered from remote IP addresses (The rest of your reg network) since by default it can only be administered by localhost.

'''If the server you are installing Convention Master on is intended to only take registrations, and will not be printing badges, your setup is complete. We do not recommend installing printing systems on public servers that do not require them.'''

1. Install CUPS package

<code>sudo apt-get install cups</code>

2. Now configure CUPS to allow remote administration. Type the command:

<code>sudo cupsctl --remote-admin</code>

3. Make sure that your Linux user account is a member of the lpadmin group. This will allow your user to add printers. (You may need to log out and then back in again after running this command for the groups change to take effect.)

<code>sudo usermod -aG lpadmin yourusernamehere</code>

4. Now edit the <code>/etc/cups/cupsd.conf</code> file.

<code>sudo joe /etc/cups/cupsd.conf</code>

We want to replace any instances of <code>“Allow @LOCAL”</code> to <code>“Allow all”</code> throughout the entire file.

[[File:cups-setup-config.png]]

5. Restart the CUPS Service with the command:

<code>sudo systemctl restart cups</code>

6. Go to port 631 on your server (e.g. http://10.10.2.10:631/) to verify that you can administer the CUPS system. You should see a page like this:

[[File:cups-setup-complete.png]]

Install/3-3/CMConfig

2023-10-07T00:20:32Z

Alofoxx:

<div style="float:right;">
[[Install/3-4/Cron|Next: 3.4 - Set Up Scheduled Tasks >>]]
</div>
[[Install/3-2/Database|<< Previously: 3.2 - Configuring the Database]]

= Connect Convention Master to the Database =

Please follow these steps if you are setting up CM for the first time for your event on a fresh database. If you plan to import an already existing database from a previous/other installation, please skip this step and check [[Guide/MoveDatabase|our guide on moving a database.]]

1. Make the configuration directory writable so that the db_connect.php file can be created.

<code>sudo chmod ug+w /var/www/shared_php/</code>

2. Reload the setup URL and there should be no error message at the bottom of the screen:

[[File:Database-setup-screen.png]]

3. Enter information:

; Hostname : The network address of the database (Usually localhost)
; Database Name : The name of the database to install Convention Master in. If you have been following our instructions and set your database up in step 3.3, leave this as "convention_master".
; Database Username : The name of the database user to use for Convention Master. If following our instructions, leave this as "CMUser".
; Database Password : The password of the database user to use for Convention master. You may have created this in the previous step. Create a strong password that is not used for any other purpose. This can be as complicated as you wish, you will likely not need to know this password ever again.

If you have not already set up the Convention Master database (see previous step), you can enter the details of a MySQL user with permissions to create a database and users, and Convention Master will set the user up for you. (This is not the recommended way to configure your database.)

; Database Admin Username : If you have an administrator user who can create
; Database Admin Password : Enter the password you set up for your MySQL administrator user.

4. Click "Next" to save the database configuration, and begin setting up your Convention Master system user account and event details:

; Event Title : This is the name of your event
; Event Start Date : Enter the first date your event is open to attendees.
; Event End Date : Enter the last date your event is open to attendees.
; Pre-Registration End Date : The final date that you will accept registrations in advance of the event.

[[File:Database-setup-screen2.png]]

5. Now that your event has been created in the database, Convention Master will begin installing itself. You will be able to see its progress at the top of the next form. While the installation process is continuing, we need to create an administrator account for Convention Master. Go ahead and fill in this form with the details of the person who will become the first system administrator. When you're done, and the installation progress has reached 100%, click next.

[[File:Database-setup-screen3.png]]

6. You should see a message confirming that installation of Convention Master has been completed, and giving you a link to use to visit the login page. Congratulations, you have installed Convention Master! There's just one bit of cleanup we need to do.

7. Change the permissions on the shared_php folder so it is no longer world-writable.

<code>sudo chmod 755 /var/www/shared_php/</code>

'''If the server you are installing Convention Master on is intended to only take registrations, and will not be printing badges, your setup is now complete. The rest of this guide deals with setting up printing systems. We do not recommend installing printing systems on public servers that do not require them.'''

Install/3-3/CMConfig

2023-10-07T00:20:09Z

Alofoxx:

<div style="float:right;">
[[Install/2-5/Cron|Next: 3.4 - Set Up Scheduled Tasks >>]]
</div>
[[Install/3-2/Database|<< Previously: 3.2 - Configuring the Database]]

= Connect Convention Master to the Database =

Please follow these steps if you are setting up CM for the first time for your event on a fresh database. If you plan to import an already existing database from a previous/other installation, please skip this step and check [[Guide/MoveDatabase|our guide on moving a database.]]

1. Make the configuration directory writable so that the db_connect.php file can be created.

<code>sudo chmod ug+w /var/www/shared_php/</code>

2. Reload the setup URL and there should be no error message at the bottom of the screen:

[[File:Database-setup-screen.png]]

3. Enter information:

; Hostname : The network address of the database (Usually localhost)
; Database Name : The name of the database to install Convention Master in. If you have been following our instructions and set your database up in step 3.3, leave this as "convention_master".
; Database Username : The name of the database user to use for Convention Master. If following our instructions, leave this as "CMUser".
; Database Password : The password of the database user to use for Convention master. You may have created this in the previous step. Create a strong password that is not used for any other purpose. This can be as complicated as you wish, you will likely not need to know this password ever again.

If you have not already set up the Convention Master database (see previous step), you can enter the details of a MySQL user with permissions to create a database and users, and Convention Master will set the user up for you. (This is not the recommended way to configure your database.)

; Database Admin Username : If you have an administrator user who can create
; Database Admin Password : Enter the password you set up for your MySQL administrator user.

4. Click "Next" to save the database configuration, and begin setting up your Convention Master system user account and event details:

; Event Title : This is the name of your event
; Event Start Date : Enter the first date your event is open to attendees.
; Event End Date : Enter the last date your event is open to attendees.
; Pre-Registration End Date : The final date that you will accept registrations in advance of the event.

[[File:Database-setup-screen2.png]]

5. Now that your event has been created in the database, Convention Master will begin installing itself. You will be able to see its progress at the top of the next form. While the installation process is continuing, we need to create an administrator account for Convention Master. Go ahead and fill in this form with the details of the person who will become the first system administrator. When you're done, and the installation progress has reached 100%, click next.

[[File:Database-setup-screen3.png]]

6. You should see a message confirming that installation of Convention Master has been completed, and giving you a link to use to visit the login page. Congratulations, you have installed Convention Master! There's just one bit of cleanup we need to do.

7. Change the permissions on the shared_php folder so it is no longer world-writable.

<code>sudo chmod 755 /var/www/shared_php/</code>

'''If the server you are installing Convention Master on is intended to only take registrations, and will not be printing badges, your setup is now complete. The rest of this guide deals with setting up printing systems. We do not recommend installing printing systems on public servers that do not require them.'''

Install/2-4/Ioncube

2023-10-07T00:18:59Z

Alofoxx:

<div style="float:right;">
[[Install/3-0/CMApp|Next: 3.0 - Installing Convention Master >>]]
</div>
[[Install/2-3/Apache|<< Previously: 2.3 - Configure Apache Webserver]]

= Install the Ioncube Loader =

IonCube Loader is responsible for managing the license that allows you to run Convention Master.

1. Visit the Ioncube Loader download page and select the download that matches your system architecture: http://www.ioncube.com/loaders.php You can download the file to your server by copying the location and using wget, like so:

cd ~/
wget https://downloads.ioncube.com/loader_downloads/ioncube_loaders_lin_x86-64.tar.gz
tar -xof ioncube_loaders_lin_x86-64.tar.gz

2. You will now have an ioncube folder containing the Ioncube PHP extensions for every version of PHP currently supported. Copy the matching loader to the appropriate folder in /usr/lib/php (there is likely only one appropriate folder, and it is datestamped). If you followed the installation instructions in section 2, you will be running PHP 8.1 and your command will look like this:

sudo cp ioncube/ioncube_loader_lin_8.1.so /usr/lib/php/20210902/

3. Create a file called ioncube.ini in /etc/php/8.1/mods-available and put the following two lines in it (adjust the path to the Ioncube loader as appropriate):

; priority=00
zend_extension = /usr/lib/php/20210902/ioncube_loader_lin_8.1.so

This is the only configuration required for the Ioncube Loader. Save the file and exit.

4. Enable the new PHP extension for both Apache and CLI.

sudo phpenmod -v 8.1 -s ALL ioncube

5. Restart Apache to load the new PHP extension

sudo systemctl restart apache2

6. You can now delete the Ioncube downloads

rm ~/ioncube_loaders_lin_x86-64.tar.gz
rm -r ioncube/

Install/3-0/CMApp

2023-10-07T00:18:24Z

Alofoxx:

<div style="float:right;">
[[Install/3-1/License|Next: 3.1 - Add Your License >>]]
</div>
[[Install/2-4/Ioncube|<< Previously: 2.4 - Install the Ioncube Loader]]

= Installing Convention Master =

Now that your web server is configured, we can get on with installing the Convention Master application! The first step in this process is to download the code from our public Subversion repository.

== Check Out from the Convention Master Repository ==

1. Move to the <code>/var/www/</code> folder:
<code>cd /var/www/</code>

2. Make the folder writable by your user account and the www-data user (replace ‘trapa’ with your username)
<code>sudo chown trapa:www-data .</code>

3. Check out the repository (note the space then period at the end of the line, it is important)
<code>svn co https://cnmstr.pawprinting.org/cm_public/trunk/ .</code>

4. Subversion will ask for the password for your current user. (If your repository access username is not the same as your username for the server, just press enter. It will then prompt you for the correct username.)

[[File:svn-checkout-prompt1.png]]
[[File:svn-checkout-prompt2.png]]

5. You may now enter your username and password.

6. If you want to store your repository password in plain text, you can decide this next. If you do not store the password, you will need to provide it each time you update your local copy of Convention Master.

7. Subversion will check out and download the repository. It should end with “Checked out revision xx” where xx is the current version available.

[[File:svn-checkout-complete.png]]

When you load the root website http://<your.server.ip.address>/ the following message should display:

[[File:error-no-license.png]]

Install/3-4/Cron

2023-10-07T00:17:28Z

Alofoxx: Alofoxx moved page Install/2-5/Cron to Install/3-4/Cron without leaving a redirect

<div style="float:right;">
[[Install/3-0/CMApp|Next: 3.0 - Installing Convention Master >>]]
</div>
[[Install/2-4/Ioncube|<< Previously: 2.4 - Install the Ioncube Loader]]

= Set Up Scheduled Tasks =

CM uses a script (<code>cm_task_manager.php</code>)to run scheduled tasks on the server backend so that it can have more time to do its job, and not require that a user have a tab open in their browser to run.
Currently, CM has five scheduled tasks that are run by this script:
* See [[Automated Tasks]]

== Automated Cron Job setup for CM ==

Use the this method to install the Cron Job if the following is true:

* You're running on Ubuntu 18.04 and
* Have installed Apache and CM with as laid out in this guide
* The user for apache is www-data

On the command line, navigate to your CM web root (if you followed this guide /var/www), then cd into other/shell_scripts

then run

./addcmcron.sh www-data

and the script will install it for you.

== Manual Cron Job Setup for CM ==

=== Set up Cron Job for CM ===

In order to take advantage of these scheduled tasks, the <code>cm_task_manager.php</code> script must be called regularly by your server's scheduler. On Linux, this system is generally Cron, but on your system it may be called something else. Cron allows Linux to run commands or scripts at a given date and time. and schedule scripts to be executed periodically.

'''NOTE: If we are hosting your installation simply contact support and we will get it setup for you when needed.'''

These instructions assume:

# You have shell access to your web server running Convention Master and <code>sudo</code> privileges. If you don't have either of these and would like help setting this up, please contact our support.
# Your server Apache user is <code>www-data</code> (the default on Ubuntu) - if it is something else, substitute your Apache user in "Create entry in Cron".

== Fetch Required Information ==

Before you can set up a new Cron task for cm, you should note down where your CM is installed. This is the folder that you downloaded the CM code into.
As with the rest of this guide, we will assume it is located in <code> /var/www/</code>. If your location is different, substitute <code> /var/www/ </code> with your path.

Inside this folder you should have <code>automated_tasks/cm_task_manager.php</code>.

This means that the full path of the CM cron script is <code> /var/www/automated_tasks/cm_task_manager.php </code>. '''Note this as your script path.'''

Next, you will need the full path to your PHP executable. Type <code>which php</code> into your terminal to get this information.
It should output something like <code>/usr/bin/php</code>. '''Note this as your php path.'''

Last, determine how often you want it to check if there is anything to do. To make up your own you can look at [http://www.crontabgenerator.com/ crontabgenerator]
We recommend every 5 minutes which will look like this <code>*/5 * * * *</code>. '''Note this as your cron timing.'''

== Create entry in Cron ==

Now you have what you need to create the Cron entry.
# Type <code> sudo crontab -u www-data -e</code> to open the Cron scheduling file (the crontab) for the web user.
# Move to the bottom of the file and add a new line.
# Enter your cron timing, php path, and script path as noted. Your line should look like this: <code>*/5 * * * * /usr/bin/php /var/www/automated_tasks/cm_task_manager.php</code>
# Make another blank line after your entry and save the file.

Setup is now complete.

Install/3-5/CUPS

2023-10-07T00:16:39Z

Alofoxx: Alofoxx moved page Install/3-4/CUPS to Install/3-5/CUPS without leaving a redirect

<div style="float:right;">
[[Install/3-5/EPL|Next: 3.5 - Install PkippLib for EPL Printers >>]]
</div>
[[Install/3-3/CMConfig|<< Previously: 3.3 - Connect Convention Master to the Database]]

= Install the CUPS Printing System =

This section of the guide will explain how to install CUPS, which is the Linux printing system required for Convention Master to be able to print to paper or badges. Don’t forget that you need to set CUPS up to be accessible and administered from remote IP addresses (The rest of your reg network) since by default it can only be administered by localhost.

'''If the server you are installing Convention Master on is intended to only take registrations, and will not be printing badges, your setup is complete. We do not recommend installing printing systems on public servers that do not require them.'''

1. Install CUPS package

<code>sudo apt-get install cups</code>

2. Now configure CUPS to allow remote administration. Type the command:

<code>sudo cupsctl --remote-admin</code>

3. Make sure that your Linux user account is a member of the lpadmin group. This will allow your user to add printers. (You may need to log out and then back in again after running this command for the groups change to take effect.)

<code>sudo usermod -aG lpadmin yourusernamehere</code>

4. Now edit the <code>/etc/cups/cupsd.conf</code> file.

<code>sudo joe /etc/cups/cupsd.conf</code>

We want to replace any instances of <code>“Allow @LOCAL”</code> to <code>“Allow all”</code> throughout the entire file.

[[File:cups-setup-config.png]]

5. Restart the CUPS Service with the command:

<code>sudo systemctl restart cups</code>

6. Go to port 631 on your server (e.g. http://10.10.2.10:631/) to verify that you can administer the CUPS system. You should see a page like this:

[[File:cups-setup-complete.png]]

Install/3-6/EPL

2023-10-07T00:16:01Z

Alofoxx: Alofoxx moved page Install/3-5/EPL to Install/3-6/EPL without leaving a redirect

<div style="float:right;">
[[Install/4-0/Printing|Next: 4.0 - Setting up Printing >>]]
</div>
[[Install/3-4/CUPS|<< Previously: 3.4 - Install the CUPS Printing System]]

= Install PkippLib for EPL Printers =

If your using the EPL print method within the registration system, then you will need the PKIpp Library. This library is included with Convention Master but requires some special setup in order to operate properly and be able to print labels.

1. Move into the /var/www/printing/pkipplib/pkipplib-0.07/

<code>cd /var/www/printing/pkipplib/pkipplib-0.07/</code>

2. Set up pkipplib (be sure to do this as root)

<code>sudo python setup.py install</code>

[[File:pkipplib-install.png]]

3. Pkipplib should now be installed.

'''Note:''' If you did not install the Python imaging library in stage 2, install it now:

<code>sudo apt-get install python3-pil</code>

Install/3-2/Database

2023-10-07T00:03:31Z

Alofoxx: update to mysql 8 steps

<div style="float:right;">
[[Install/3-3/CMConfig|Next: 3.3 - Connect Convention Master to the Database >>]]
</div>
[[Install/3-1/License|<< Previously: 3.1 - Add Your License]]

= Configuring the Database =

In order to install Convention Master, it needs a MySQL database in which to store its data. We need to create a database on your system, and a MySQL user account to access it. This section of the guide will run you through that process.

'''If you already have a blank database provisioned on your host/by your hosting company, skip this step and proceed to the next page.'''

We need to disable some mode switches in MySQL in order for Convention Master to function. Let's go ahead and create a custom MySQL configuration file for Convention Master:

<syntaxhighlight lang="bash">
sudo joe /etc/mysql/mysql.conf.d/convention_master.cnf
</syntaxhighlight>

In this new file, place the following three lines:

<syntaxhighlight lang="bash">
[mysqld]
sql-mode="NO_ZERO_IN_DATE,ERROR_FOR_DIVISION_BY_ZERO,NO_ENGINE_SUBSTITUTION"
log-bin-trust-function-creators=1
</syntaxhighlight>

Save the new file and close. To activate it, let's restart the MySQL service:
<syntaxhighlight lang="bash">
sudo systemctl restart mysql
</syntaxhighlight>

Next, let's create the database and user account Convention Master needs to install itself. Execute the following command to log into MySQL as its super-user (root):
<syntaxhighlight lang="bash">
sudo mysql -u root -p
</syntaxhighlight>

You should see the MySQL monitor's interactive prompt. From here we can create a new database for Convention Master:
<syntaxhighlight lang="MySQL">
CREATE DATABASE convention_master;
</syntaxhighlight>

Finally, let's create a user that can access this database: Note: replace your_new_mysql_cm_password with your own unique password that you will need to enter during Convention Master installation.
<syntaxhighlight lang="MySQL">
CREATE USER 'CMUser'@'localhost' IDENTIFIED WITH mysql_native_password BY 'your_new_mysql_cm_password';
GRANT ALL PRIVILEGES ON convention_master.* TO 'CMUser'@'localhost';
FLUSH PRIVILEGES;
exit;
</syntaxhighlight>

Please make sure to note that your database name is 'convention_master', your database user is 'CMUser', and your database user password is what you replaced your_new_mysql_cm_password with. You will enter these during installation.

All done! With the database and user created, we can proceed to with the installation of Convention Master.

Install/2-0/ServerPackages

2023-10-07T00:02:29Z

Alofoxx: update to mysql 8 and php 8

<div style="float:right;">
[[Install/2-1/Joe|Next: 2.1 - The Joe Editor>>]]
</div>
[[Install/1-0/PreRequisites|<<Previously: 1.0 - Pre-Requisites]]

= Installing Software on the Server =

'''''Note: This is not a comprehensive guide on how to set up a properly secured server for production. Please look into and take steps to harden a production server, such as setting up the firewall and proper sshd settings.'''''

This section of the guide will walk you through the configuration of a server running Ubuntu Server 22.04 LTS, on which Convention Master can run. If your server is not yet installed, you can follow the official Ubuntu guide to do so:

https://tutorials.ubuntu.com/tutorial/tutorial-install-ubuntu-server

Note: Convention Master can run on any system meeting the Apache/PHP/MySQL requirement, but we will provide documentation only for Ubuntu. If you wish to use another operating system, such as CentOS or Windows, be aware that some of the steps in this guide may not apply, may have to be modified in order to work, or additional steps may be required. Convention Master can only guarantee official support for the Ubuntu Server OS.

== Configure Server ==

Once your server's operating system is installed, we can begin installing the packages you will need to run Convention Master. Log in as the user you created during installation (or any user with sudo rights), and input the following commands.

<syntaxhighlight lang="bash">
sudo apt update
sudo apt dist-upgrade -y
</syntaxhighlight>

These will ensure your server has the very latest versions of its available packages and kernel. With those done, run...

<syntaxhighlight lang="bash">
sudo reboot
</syntaxhighlight>

...to restart the server.

'''MySQL 8.0'''
Currently, MySQL 8.0.x is the recommended version for Convention Master.

To install the MySQL database server software, run the following command:
<syntaxhighlight lang="bash">
sudo apt install mysql-server
sudo systemctl start mysql.service
</syntaxhighlight>

You will need to take some extra steps to get the user accounts and special settings Convention Master needs set up.

Use the following command to get into the MySQL prompt
<syntaxhighlight lang="bash">
sudo mysql
</syntaxhighlight>

While in the MySQL prompt type the following commands. Note: replace your_new_mysql_root_password with your own unique password that you make sure you don't forget.
<syntaxhighlight lang="MySQL">
ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY 'your_new_mysql_root_password';
exit;
</syntaxhighlight>

This will make sure you don't get locked out by the next step. If you need to get back into the MySQL prompt in the future, you will use this command "mysql -u root -p" and enter the password you just set.

Next we should take some basic steps to secure the MySQL server. Run the following command to start a wizard that will walk you through some changes to your MySQL server.
<syntaxhighlight lang="bash">
sudo mysql_secure_installation
</syntaxhighlight>

* When it starts, it will ask you for your MySQL root password. This will be the same one you set above.
* It will ask if you want to enable the VALIDATE PASSWORD COMPONENT - enter N
* It will ask if you want to change your root password - you can say no since you already set a password
* From there, you can press Y and then ENTER to accept the defaults for all the subsequent questions. This will remove some anonymous users and the test database, disable remote root logins, and load these new rules so that MySQL immediately respects the changes you have made.

Once the script completes, MySQL is now installed. You will need to make some configuration changes to properly run Convention Master which will be covered in step 3.2

With MySQL configured, you can use the following command to install all the packages a standard Convention Master setup needs.

<syntaxhighlight lang="bash">
sudo apt install -y php8.1 php8.1-cli php8.1-curl php8.1-gd php8.1-mysql php8.1-mbstring php8.1-intl
subversion ntp nano joe apache2 libapache2-mod-php8.1 html2ps
htmldoc mcrypt python3-pil curl
</syntaxhighlight>

Install/1-0/PreRequisites

2023-10-06T23:09:18Z

Alofoxx: update php deps

<div style="float:right;">
[[Install/2-0/ServerPackages|Next: 2.0 - Installing Software on the Server>>]]
</div>

= Installation Pre-Requisites =

Convention Master is a web application with a wide array of event-supporting functionality that can be configured by the user. The base web application will run on the incredibly common LAMP web server stack, but some of its additional functionalities require further configuration. Before you dive into the installation process, this page will show the resources you will require.

'''Note:''' While Convention Master is a relatively traditional LAMP application, that will run on many kinds of system, we simply do not have the manpower to support them all. If you wish to receive specific assistance with installation from the CM development team, we require you to utilise a Debian-based Linux web server. We recommend Ubuntu Server 22.04 LTS, and many of the commands and references in this guide will be tailored to that environment. If you wish to use another type of environment, you are free to do so, but be aware that you may need to adapt, ignore or replace some of the commands in this installation guide for your own circumstances.

== Base Application ==

{| class="wikitable"
|-
! '''Software''' !! '''Minimum Version''' !! '''Recomended Version''' !! '''Additional Notes'''
|-
| [https://httpd.apache.org/ Apache Web Server] || 2.0 || || Required modules: mod_rewrite, mod_php
|-
| [https://php.net/ PHP] || {{CM stable php requirement}} || 8.1 || Required modules: curl, gd, mysql, mbstring, intl
|-
| [https://www.mysql.com/ MySQL] || {{CM stable mysql requirement}} || 8.0 || Note: MySQL default server mode config changes required
|-
| [https://ioncube.com Ioncube PHP Encoder] || N/A || || Available for any supported PHP version. Installation instructions can be found later in this guide.
|}

== Badge & Paper Printing ==

On Linux, you will require CUPS or EPL compatible printers, and the appropriate library installed.

If you have a Windows-only printer (many card printers are unfortunately so), we have a shell-script workaround that utilizes print-to-PDF.

Instructions on all these installation methods can be found later in this guide.

{| class="wikitable"
|-
! '''Printer Type''' !! '''Required Software''' !! '''Notes'''
|-
| CUPS || CUPS Printing System ||
|-
| EPL || Pkipplib ||
|}

Install/2-0/ServerPackages

2023-09-30T09:58:27Z

Alofoxx:

<div style="float:right;">
[[Install/2-1/Joe|Next: 2.1 - The Joe Editor>>]]
</div>
[[Install/1-0/PreRequisites|<<Previously: 1.0 - Pre-Requisites]]

= Installing Software on the Server =

This section of the guide will walk you through the configuration of a server running Ubuntu Server 22.04 LTS, on which Convention Master can run. If your server is not yet installed, you can follow the official Ubuntu guide to do so:

https://tutorials.ubuntu.com/tutorial/tutorial-install-ubuntu-server

Note: Convention Master can run on any system meeting the Apache/PHP/MySQL requirement, but we will provide documentation only for Ubuntu. If you wish to use another operating system, such as CentOS or Windows, be aware that some of the steps in this guide may not apply, may have to be modified in order to work, or additional steps may be required. Convention Master can only guarantee official support for the Ubuntu Server OS.

== Configure Server ==

Once your server's operating system is installed, we can begin installing the packages you will need to run Convention Master. Log in as the user you created during installation (or any user with sudo rights), and input the following commands.

<syntaxhighlight lang="bash">
sudo apt update
sudo apt dist-upgrade -y
</syntaxhighlight>

These will ensure your server has the very latest versions of its available packages and kernel. With those done, run...

<syntaxhighlight lang="bash">
sudo reboot
</syntaxhighlight>

...to restart the server.

'''MySQL 8.0'''
Currently several people are running MySQL 8.0, and not having any issues at all. We are curently still "testing" 8.0 and probably will continue to classify as "testing". If you would prefer to use MySQL 5.7 see the instructions below, otherwise feel free to run 8.0

'''MySQL 5.7'''
With the server restarted, we will prepare your server to install MySQL 5.7, which is not available on Ubuntu 22.04 LTS from either the default Ubuntu or MySQL repositories. As a result, we need to manually configure where to get these packages.

<syntaxhighlight lang="bash">
sudo apt-key adv --keyserver keyserver.ubuntu.com --recv-keys 5072E1F5
sudo echo 'deb http://repo.mysql.com/apt/ubuntu bionic mysql-5.7' | sudo tee /etc/apt/sources.list.d/mysql.list
sudo apt update
</syntaxhighlight>

'''NOTE:''' We are aware that official support from MySQL for version 5.7 ends in October 2023. We have run Convention Master on MySQL 8.0 in a number of scenarios without incident, however we have not yet completed specific testing on 8.0 in order to make it our supported version. We expect to have this testing completed by the release of CM v11.

With MySQL configured, you can use the following command to install all the packages a standard Convention Master setup needs.

<syntaxhighlight lang="bash">
sudo apt install -y php8.1 php8.1-cli php8.1-curl php8.1-gd php8.1-mysql php8.1-mbstring php8.1-intl
subversion ntp nano joe apache2 libapache2-mod-php7.4 bind9 bind9utils samba html2ps
htmldoc mysql-client=5.7* mysql-server=5.7* mcrypt python3-pil curl
</syntaxhighlight>

'''PHP 7.x:''' Convention Master 10.x will technically run on PHP 7.x. However, these versions of PHP are no longer supported by Zend, so we highly recommend immediately upgrading your server to PHP 8.x for best security and compatibility. Convention Master will cease supporting PHP 7.x as of version 11, currently under development at time of writing.

Finally, let's go ahead and run the wizard to properly secure your new MySQL installation:

<syntaxhighlight lang="bash">
sudo mysql_secure_installation
</syntaxhighlight>

Install/3-2/Database

2023-09-30T09:40:20Z

Alofoxx:

<div style="float:right;">
[[Install/3-3/CMConfig|Next: 3.3 - Connect Convention Master to the Database >>]]
</div>
[[Install/3-1/License|<< Previously: 3.1 - Add Your License]]

= Configuring the Database =

In order to install Convention Master, it needs a MySQL database in which to store its data. We need to create a database on your system, and a MySQL user account to access it. This section of the guide will run you through that process.

'''If you already have a blank database provisioned on your host/by your hosting company, skip this step and proceed to the next page.'''

If you have not previously done so, run the MySQL installation security wizard. This will help you set password policies, a root password for the system, disable unneeded access methods, etc.

<code>sudo mysql_secure_installation</code>

We need to disable some mode switches in MySQL in order for Convention Master to function. Let's go ahead and make a custom MySQL configuration file for Convention Master:

<code>sudo joe /etc/mysql/mysql.conf.d/convention_master.cnf</code>

In this file, place the following two lines:

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

Save the new file and close. To activate it, let's restart the MySQL service:

<code>sudo systemctl restart mysql</code>

Next, let's create the database and user account Convention Master needs to install itself. Execute the following command to log into MySQL as its super-user (root):

<code>sudo mysql</code>

You should see the MySQL monitor's interactive prompt. From here we can create a new database for Convention Master:

<code>CREATE DATABASE convention_master;</code>

Finally, let's create a user that can access this database:

<code>GRANT ALL PRIVILEGES ON convention_master.* TO CMUser@localhost IDENTIFIED BY 'yourpasswordgoeshere';</code>
<code>FLUSH PRIVILEGES;</code>

All done! With the database and user created, we can proceed to installing Convention Master.

Install/2-4/Ioncube

2023-09-30T09:23:13Z

Alofoxx: update for php 8.1

<div style="float:right;">
[[Install/2-5/Cron|Next: 2.5 - Set Up Scheduled Tasks >>]]
</div>
[[Install/2-3/Apache|<< Previously: 2.3 - Configure Apache Webserver]]

= Install the Ioncube Loader =

IonCube Loader is responsible for managing the license that allows you to run Convention Master.

1. Visit the Ioncube Loader download page and select the download that matches your system architecture: http://www.ioncube.com/loaders.php You can download the file to your server by copying the location and using wget, like so:

cd ~/
wget https://downloads.ioncube.com/loader_downloads/ioncube_loaders_lin_x86-64.tar.gz
tar -xof ioncube_loaders_lin_x86-64.tar.gz

2. You will now have an ioncube folder containing the Ioncube PHP extensions for every version of PHP currently supported. Copy the matching loader to the appropriate folder in /usr/lib/php (there is likely only one appropriate folder, and it is datestamped). If you followed the installation instructions in section 2, you will be running PHP 8.1 and your command will look like this:

sudo cp ioncube/ioncube_loader_lin_8.1.so /usr/lib/php/20210902/

3. Create a file called ioncube.ini in /etc/php/8.1/mods-available and put the following two lines in it (adjust the path to the Ioncube loader as appropriate):

; priority=00
zend_extension = /usr/lib/php/20210902/ioncube_loader_lin_8.1.so

This is the only configuration required for the Ioncube Loader. Save the file and exit.

4. Enable the new PHP extension for both Apache and CLI.

sudo phpenmod -v 8.1 -s ALL ioncube

5. Restart Apache to load the new PHP extension

sudo systemctl restart apache2

6. You can now delete the Ioncube downloads

rm ~/ioncube_loaders_lin_x86-64.tar.gz
rm -r ioncube/

Install/2-0/ServerPackages

2022-08-22T03:44:45Z

Alofoxx:

<div style="float:right;">
[[Install/2-1/Joe|Next: 2.1 - The Joe Editor>>]]
</div>
[[Install/1-0/PreRequisites|<<Previously: 1.0 - Pre-Requisites]]

= Installing Software on the Server =

This section of the guide will walk you through the configuration of a server running Ubuntu Server 18.04 LTS, on which Convention Master can run. If your server is not yet installed, you can follow the official Ubuntu guide to do so:

https://tutorials.ubuntu.com/tutorial/tutorial-install-ubuntu-server

Note: Convention Master can run on any system meeting the Apache/PHP/MySQL requirement, but we will provide documentation only for Ubuntu. If you wish to use another operating system, such as CentOS or Windows, be aware that some of the steps in this guide may not apply, may have to be modified in order to work, or additional steps may be required. Convention Master can only guarantee official support for the Ubuntu Server OS.

== Configure Server ==

Once your server's operating system is installed, we can begin installing the packages you will need to run Convention Master. Log in as the user you created during installation (or any user with sudo rights), and input the following commands.

sudo apt-get update
sudo apt-get dist-upgrade -y

These will ensure your server has the very latest versions of its available packages and kernel. With those done, run...

sudo reboot

...to restart the server. When it comes back up, you can use the following command to install all the standard packages Convention Master needs.

sudo apt-get install -y php7.4 php7.4-curl php7.4-gd php7.4-mysql php7.4-mbstring
subversion ntp nano joe apache2 libapache2-mod-php7.4 bind9 bind9utils samba html2ps
htmldoc mysql-client mysql-server mcrypt python3-pil curl

'''PHP 7.1:''' Convention Master's PHP support tracks that of Zend themselves, and as such PHP 7.1 will be supported until the end of 2019. If installing on PHP 7.1, you will need to add an additional package to the list above:

php-sodium

'''PHP 7.3:''' You may have noticed that we are installing PHP 7.2. At the time of writing (Convention Master 10.0), the software has not been tested on PHP 7.3, as Ioncube Encoder was not available in a final version before the previous CM release. Support for PHP 7.3 will be added in an upcoming release.

Template:CM current release number

2021-07-20T18:51:12Z

Alofoxx:

10.1.4

Release notes/10.1.3

2021-07-20T18:50:56Z

Alofoxx:

{{ReleaseNotesPreamble}}

'''Convention Master 10.1.3''' Released on July 17, 2021.

'''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.3.
July 17, 2021, 16:28:
----------------------------------------------------
The following changes and or features were added

* Mantis 0488: Logon History - added functionality to log when user logs into CM, it also tells the user their last login information, and added a new menu called "My Activity" that shows all activity that the UID was affected by in system log.
* Mantis 0884: Agreements Text Disclosure Bug. We closed a bug that a user could enumerate through the agreements id's to discover other agreements in the system.
* Mantis 1119: Added Cloud Printing reference implementations for powershell and bash. Rearranged all existing printing scripts into other/client_printing_scripts. Added index files to the other/ file tree, added index file to cloud printing so it can be downloaded from the internet. Added Fixes for moved install location for foxit, as well as the ability to supply a path via params on the script. README supplied to explain setup better.
* Mantis 1131: Corrected a bug that misreported the number of memberships sold in situations where they were refunded.
* Mantis 1147: Updated the artshow wizard to pad new tables added with leading zeros to help keep panels listed orderly.
* Mantis 1148: Corrected installer errors that blocked progression when you have an existing DB.
* Mantis 1149: Corrected bug where some User Defined Fields would not save or display correctly when using the pencil icon to edit reg.
* Mantis 1151: Corrected crash error that occurs on the View Reg page when event doesn't have old cc processor defined properly.
* Mantis 1152: Corrected issue with MySQL 8 and improved email server password encryption/decryption.
* Mantis 1153: Updated PHP code in preparation for future PHP compatibility.
* Mantis 1154: Fixed a bug that would happen if you attempted to delete an email server that had sent messages. It now shows an error.
* Mantis 1155: Added help button with information on membership caps to the edit events tool.
* Mantis 1156: Updated final step of the kiosk payment screen to make it more clear that you are done registering.
* Mantis 1157: Membership spelling fix.
* Mantis 1158: Fixed issue where email's modified in the kiosk editor are HTML but the email message is not sent using HTML support.
* Mantis 1159: add ifproductspurchased() function to badge image display. This will allow people to draw elements on the badge depending on whether or not items have been purchased.

{{UpgradeAdvice}}

Release notes/10.1.4

2021-07-20T18:50:24Z

Alofoxx: Created page with "< Release notes '''Convention Master 10.1.4''' Released on July 18, 2021. '''UPGRADE WARNING:''' If you are currently on version 10.0.x, release 10.1 has special instr..."

< [[Release notes]]

'''Convention Master 10.1.4''' Released on July 18, 2021.

'''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.4.
July 18, 2021, 15:29:
----------------------------------------------------
The following changes and or features were added

* Mantis 1161: Fixed a bug that prevented processing credit card transactions with cents.

{{UpgradeAdvice}}

Release notes

2021-07-20T18:48:56Z

Alofoxx: add 10.1.4

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
! rowspan="1" | Notes
|-
|[[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/10.1.3

2021-07-18T01:08:06Z

Alofoxx:

< [[Release notes]]

'''Convention Master 10.1.3''' Released on July 17, 2021.

'''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.3.
July 17, 2021, 16:28:
----------------------------------------------------
The following changes and or features were added

* Mantis 0488: Logon History - added functionality to log when user logs into CM, it also tells the user their last login information, and added a new menu called "My Activity" that shows all activity that the UID was affected by in system log.
* Mantis 0884: Agreements Text Disclosure Bug. We closed a bug that a user could enumerate through the agreements id's to discover other agreements in the system.
* Mantis 1119: Added Cloud Printing reference implementations for powershell and bash. Rearranged all existing printing scripts into other/client_printing_scripts. Added index files to the other/ file tree, added index file to cloud printing so it can be downloaded from the internet. Added Fixes for moved install location for foxit, as well as the ability to supply a path via params on the script. README supplied to explain setup better.
* Mantis 1131: Corrected a bug that misreported the number of memberships sold in situations where they were refunded.
* Mantis 1147: Updated the artshow wizard to pad new tables added with leading zeros to help keep panels listed orderly.
* Mantis 1148: Corrected installer errors that blocked progression when you have an existing DB.
* Mantis 1149: Corrected bug where some User Defined Fields would not save or display correctly when using the pencil icon to edit reg.
* Mantis 1151: Corrected crash error that occurs on the View Reg page when event doesn't have old cc processor defined properly.
* Mantis 1152: Corrected issue with MySQL 8 and improved email server password encryption/decryption.
* Mantis 1153: Updated PHP code in preparation for future PHP compatibility.
* Mantis 1154: Fixed a bug that would happen if you attempted to delete an email server that had sent messages. It now shows an error.
* Mantis 1155: Added help button with information on membership caps to the edit events tool.
* Mantis 1156: Updated final step of the kiosk payment screen to make it more clear that you are done registering.
* Mantis 1157: Membership spelling fix.
* Mantis 1158: Fixed issue where email's modified in the kiosk editor are HTML but the email message is not sent using HTML support.
* Mantis 1159: add ifproductspurchased() function to badge image display. This will allow people to draw elements on the badge depending on whether or not items have been purchased.

{{UpgradeAdvice}}

Main Page

2021-07-18T00:56:12Z

Alofoxx: /* Other Pages */

=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]]

== Instructional Guides ==

* [[Guide/MoveDatabase|Moving a Database Between Installations]]
* [[Guide/Vouchers|Voucher System]]
* [[Guide/PaymentGateways|Payment Gateway System]]

== Other Pages ==
* [[Automated Tasks]]
* [[Badge Display Code Documentation]]
* [[EventGrid]]
* [[Kiosks]]
* [[Potential New Feature Descriptions]]
* [[Tag Replacements]]

== 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

Template:CM current release number

2021-07-18T00:53:09Z

Alofoxx:

10.1.3

Release notes/10.1.2

2021-07-18T00:52:47Z

Alofoxx:

{{ReleaseNotesPreamble}}

'''Convention Master 10.1.2''' Released on February 26, 2021. This is a patch release. This release corrects some minor bugs.

'''UPGRADE WARNING:''' If you are currently on version 10.0.x, this 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.2.
February 26, 2021, 06:07:
----------------------------------------------------
The following changes and or features were added
* Mantis 1146 - Fixed issue with clearing the Bruteforce Lockout manually from the console.

{{UpgradeAdvice}}

Release notes/10.1.3

2021-07-18T00:51:48Z

Alofoxx: Created page with "< Release notes '''Convention Master 10.1.3''' Released on July 17, 2021. '''UPGRADE WARNING:''' If you are currently on version 10.0.x, this release 10.1 has special..."

< [[Release notes]]

'''Convention Master 10.1.3''' Released on July 17, 2021.

'''UPGRADE WARNING:''' If you are currently on version 10.0.x, this 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.3.
July 17, 2021, 16:28:
----------------------------------------------------
The following changes and or features were added

* Mantis 0488: Logon History - added functionality to log when user logs into CM, it also tells the user their last login information, and added a new menu called "My Activity" that shows all activity that the UID was affected by in system log.
* Mantis 0884: Agreements Text Disclosure Bug. We closed a bug that a user could enumerate through the agreements id's to discover other agreements in the system.
* Mantis 1119: Added Cloud Printing reference implementations for powershell and bash. Rearranged all existing printing scripts into other/client_printing_scripts. Added index files to the other/ file tree, added index file to cloud printing so it can be downloaded from the internet. Added Fixes for moved install location for foxit, as well as the ability to supply a path via params on the script. README supplied to explain setup better.
* Mantis 1131: Corrected a bug that misreported the number of memberships sold in situations where they were refunded.
* Mantis 1147: Updated the artshow wizard to pad new tables added with leading zeros to help keep panels listed orderly.
* Mantis 1148: Corrected installer errors that blocked progression when you have an existing DB.
* Mantis 1149: Corrected bug where some User Defined Fields would not save or display correctly when using the pencil icon to edit reg.
* Mantis 1151: Corrected crash error that occurs on the View Reg page when event doesn't have old cc processor defined properly.
* Mantis 1152: Corrected issue with MySQL 8 and improved email server password encryption/decryption.
* Mantis 1153: Updated PHP code in preparation for future PHP compatibility.
* Mantis 1154: Fixed a bug that would happen if you attempted to delete an email server that had sent messages. It now shows an error.
* Mantis 1155: Added help button with information on membership caps to the edit events tool.
* Mantis 1156: Updated final step of the kiosk payment screen to make it more clear that you are done registering.
* Mantis 1157: Membership spelling fix.
* Mantis 1158: Fixed issue where email's modified in the kiosk editor are HTML but the email message is not sent using HTML support.
* Mantis 1159: add ifproductspurchased() function to badge image display. This will allow people to draw elements on the badge depending on whether or not items have been purchased.

{{UpgradeAdvice}}

Release notes

2021-07-18T00:48:41Z

Alofoxx: add 10.1.3

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
! rowspan="1" | Notes
|-
|[[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/PaymentGateways

2021-02-27T00:55:09Z

Alofoxx: Created page with " == Payment Gateway System == Released in version 10.1.0 the Payment Gateway system is a re-write of the remote payment processing system that handles the communication and tr..."

== Payment Gateway System ==
Released in version 10.1.0 the Payment Gateway system is a re-write of the remote payment processing system that handles the communication and transfer of funds between Convention Master, the customer’s bank, and the Convention’s bank.
This system allows us to expand the number of payment providers we support while helping convention maintain PCI Compliance.

== Supported Payment Gateways ==
Here are the Payment Gateways we support:

* Authorize.Net
* PayPal
* Square
* Stripe

If you would like us to add support for another gateway please reach out to support.

== How To Docs ==
* [[Guide/PaymentGateways/Get_api_keys|Getting Payment Gateway API Keys]]
* [[Guide/PaymentGateways/Add_gateway|Adding new Payment Gateway]]
* [[Guide/PaymentGateways/Enable_gateway|Enable Payment Gateway in a Kiosk]]
* [[Guide/PaymentGateways/Test_gateway|Testing a Payment Gateway]]
* [[Guide/PaymentGateways/Transaction_history|View Payment Gateway Transaction History]]

Main Page

2021-02-27T00:31:13Z

Alofoxx: /* Instructional Guides */

=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]]

== Instructional Guides ==

* [[Guide/MoveDatabase|Moving a Database Between Installations]]
* [[Guide/Vouchers|Voucher System]]
* [[Guide/PaymentGateways|Payment Gateway System]]

== Other Pages ==
* [[Automated Tasks]]
* [[Kiosks]]
* [[Tag Replacements]]
* [[Potential New Feature Descriptions]]

== 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

Main Page

2021-02-27T00:24:15Z

Alofoxx: /* Convention Master Documentation */

=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]]

== Instructional Guides ==

* [[Guide/MoveDatabase|Moving a Database Between Installations]]
* [[Guide/Vouchers|Voucher System]]

== Other Pages ==
* [[Automated Tasks]]
* [[Kiosks]]
* [[Tag Replacements]]
* [[Potential New Feature Descriptions]]

== 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

Template:InstallationTOC

2021-02-27T00:23:23Z

Alofoxx: Undo changes

== Installation & Upgrade ==
[[InstallGuide | Installation Guide]]
# [[Install/1-0/PreRequisites|Pre-Requisites / Getting Ready]]
# [[Install/2-0/ServerPackages|Installing Software on the Server]]
## [[Install/2-1/Joe|The Joe Editor]]
## [[Install/2-2/Networking|Configure Networking]]
## [[Install/2-3/Apache|Configure Apache Web Server]]
## [[Install/2-4/Ioncube|Install the Ioncube Loader]]
## [[Install/2-5/Cron|Set up Scheduled Tasks]]
# [[Install/3-0/CMApp|Installing Convention Master]]
## [[Install/3-1/License|Add your License]]
## [[Install/3-2/Database|Configure the Database]]
## [[Install/3-3/CMConfig|Connect Convention Master to the Database]]
## [[Install/3-4/CUPS|Install the CUPS Printing System]]
## [[Install/3-5/EPL|Install PkippLib for EPL Printers]]
# [[Install/4-0/Printing|Setting up Printing]]
## [[Install/4-1/CUPSConfig|Configure CUPS]]
## [[Install/4-2/EPLConfig|Configure EPL printers]] (inc. Zebra printers)
## [[Install/4-3/PDFPrint|Set up Printing to PDF]]
## [[Install/4-4/SocketPrint|Set up Socket Printers]]
## [[Install/4-5/CivetPrint|Set up CivetPrint]] (Deprecated)

<br />
[[Upgrading Convention Master]]
<br />

Template:InstallationTOC

2021-02-27T00:22:28Z

Alofoxx: /* Installation & Upgrade */

== Installation & Upgrade ==
[[InstallGuide | Installation Guide]]

<br />
[[Upgrading Convention Master]]
<br />

Upgrading Convention Master

2021-02-27T00:15:41Z

Alofoxx:

== 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
:: PHP 7.4.x recomended

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

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

For more information, please read the [[Install/1-0/PreRequisites|Manual/Installation requirements]].

=== 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]]

Install/1-0/PreRequisites

2021-02-27T00:14:25Z

Alofoxx:

= Installation Pre-Requisites =

Convention Master is a web application with a wide array of event-supporting functionality that can be configured by the user. The base web application will run on the incredibly common LAMP web server stack, but some of its additional functionalities require further configuration. Before you dive into the installation process, this page will show the resources you will require.

'''Note:''' While Convention Master will run on many kinds of system, we simply do not have the manpower to support them all. If you wish to receive specific assistance with installation from the CM development team, we require you to utilise a Debian-based Linux web server. We recommend Ubuntu 18.04 LTS, and many of the commands and references in this guide will be tailored to that environment. If you wish to use another type of environment, you are free to do so, but be aware that you may need to adapt, ignore or replace some of the commands in this installation guide for your own circumstances.

== Base Application ==

{| class="wikitable"
|-
! '''Software''' !! '''Minimum Version''' !! '''Recomended Version''' !! '''Additional Notes'''
|-
| [https://httpd.apache.org/ Apache Web Server] || 2.0 || || Required modules: mod_rewrite, mod_php
|-
| [https://php.net/ PHP] || {{CM stable php requirement}} || 7.4 || Required modules: curl, gd, mysql, mbstring
|-
| [https://www.mysql.com/ MySQL] || {{CM stable mysql requirement}} || 5.7 ||
|-
| [https://ioncube.com Ioncube PHP Encoder] || N/A || || Available for any supported PHP version. Installation instructions can be found later in this guide.
|}

== Badge & Paper Printing ==

On Linux, you will require CUPS or EPL compatible printers, and the appropriate library installed.

If you have a Windows-only printer (many card printers are unfortunately so), we have a shell-script workaround that utilizes print-to-PDF.

Instructions on all these installation methods can be found later in this guide.

{| class="wikitable"
|-
! '''Printer Type''' !! '''Required Software''' !! '''Notes'''
|-
| CUPS || CUPS Printing System ||
|-
| EPL || Pkipplib ||
|}

Upgrading Convention Master

2021-02-27T00:09:44Z

Alofoxx:

== 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
:: PHP 7.4.x recomended

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

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

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

=== 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]]

Template:CM current release number

2021-02-26T23:57:36Z

Alofoxx:

10.1.2

Release notes/10.1.1

2021-02-26T23:57:16Z

Alofoxx:

{{ReleaseNotesPreamble}}

'''Convention Master 10.1.1''' Released on February 19, 2021. This is a patch release. This release corrects some minor bugs, and removes all functions deprecated in PHP 7.4.

'''UPGRADE WARNING:''' If you are currently on version 10.0.x, this 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.1.
February 19, 2021, 03:38:
----------------------------------------------------
The following changes and or features were added
* Mantis 476 - Admins can now remove/edit all filters
* Mantis 522 - Corrected bug that prevented removing Dealers Assistants
* Mantis 870 - Removed SYSTEM USER login.
* Mantis 905 - Corrected some issues with filter engine that returned some errors mentioning count()
* Mantis 1093 - Added ability to add new kiosks by copying existing ones.
* Mantis 1130 - Enabled the ability to remove a membership from the customer in the edit-reg, provided the customer has not already paid for the membership.
* Mantis 1134 - Fixed SQL error when listing assistants in artshow/dealers with no applicants approved.
* Mantis 1135 - Removed get_magic_quotes_gpc support.
* Mantis 1136 - Removed CM 9.x license support.
* Mantis 1137 - Removed unused PDF library.
* Mantis 1138 - Removed money_format() usage - 7.4 deprecated
* Mantis 1139 - Corrected some database errors that prevented setup from running.
* Mantis 1140 - Corrected bug in Artshow that allowed adding spaces that had no fees set up. Table types with no fees will be disabled to prevent creating an invalid configuration.
* Mantis 1141 - Added ability to refund membership, when the membership is refunded the events_attended membership type will revert to a previous membership type, or be removed if there are no un-refunded memberships left.
* Mantis 1142 - Set the oldest DB version to 572 and remove outdated upgrade files.

* Upgraded installer to do blowfish hashed password if the algorithm is present.
* BugFix - Found a bug that pre-reg process payment was unable to record a voucher payment. Issue Corrected.

{{UpgradeAdvice}}

Release notes/10.1.0

2021-02-26T23:57:06Z

Alofoxx:

{{ReleaseNotesPreamble}}

'''Convention Master 10.1.0''' Released on January 31, 2021. This is a major feature release. This release changes to the new Omnipay payment library, and releases the voucher feature. This system contains many fixes to other smaller systems, but please be careful to test your kiosks and ensure payment processing is working when upgrading to this release.

'''UPGRADE WARNING:''' This release 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.0.
January 31, 2021, 15:46
----------------------------------------------------
The following changes and or features were added

* Mantis 900 - Payment Gateways: Add new system using Omnipay to support many payment processors.
* Mantis 987 - Validate cashbox system after Payment Gateway upgrade.
* Mantis 988 - Upgrade Art Show module to support Payment Gateway upgrade.
* Mantis 989 - Upgrade printable receipts to support Payment Gateway upgrade.
* Mantis 992 - Add currency selector to global settings.
* Mantis 1001 - Add update script that migrates existing paypal payment gateway settings to new Payment Gateway system.
* Mantis 1002 - Modify Kiosk payment screens for Payment Gateway upgrade.
* Mantis 1003 - Modify Kiosk editor in console to support Payment Gateway upgrade.
* Mantis 1004 - Add payment landing page for Payment Gateway upgrade.
* Mantis 1006 - Update Accounting - Credit Card Audit Report to show new Payment Gateway payments.
* Mantis 1007 - Add version check and warning message for OpenSSL version installed.
* Mantis 1008 - Update global settings for Payment Gateway upgrade.
* Mantis 1009 - Update db sanitizer script for new db changes.
* Mantis 1015 - Add database upgrade for Payment Gateways.
* Mantis 1016 - Add payment by Stripe to Payment Gateways.
* Mantis 1017 - Add warning and hard stop if on PHP7.0 or earlier. Add EOL Warning in console for people using PHP 7.2 or earlier.
* Mantis 1024 - Upgrade payment system to support payments from Payment Gateway upgrade.
* Mantis 1025 - Update receipts to have Payment Gateway information.
* Mantis 1040 - Add payment by Authorize.Net to Payment Gateways.
* Mantis 1041 - Add payment by PayPal to Payment Gateways.
* Mantis 1063 - Add Voucher system.
* Mantis 1069 - Add database upgrade for Voucher system.
* Mantis 1073 - Add new task to the automated task system to remind people to spend un-spent vouchers. This will remind people, at 2, 7, 15, and 30 days out from the voucher expiration date.
* Mantis 1074 - Mass Emailer - Add support for adding Vouchers to Emails in bulk.
* Mantis 1075 - Modify Kiosk payment screens for Voucher system.
* Mantis 1076 - Added the ability to see vouchers assigned to a person from the new Voucher tab in view reg.
* Mantis 1077 - Add "Use Voucher" button to cash register.
* Mantis 1079 - Add Voucher Manager that allows you to Bulk Create Vouchers.
* Mantis 1080 - Add vouchers to Pre-Reg process payment
* Mantis 1081 - Add vouchers concept to Pre-reg process refund. Added the ability to process refund to a voucher. You can now refund things to a voucher for people to use either elsewhere, or at a future year.
* Mantis 1082 - Add page to show existing vouchers.
* Mantis 1083 - Add vouchers to filter system.
* Mantis 1084 - Add Voucher Usage Graph / Voucher Report.
* Mantis 1087 - Add warnings to Kiosk that make it clear if using a payment gateway in sandbox mode - which will not record payments.
* Mantis 1088 - Remove support for old payment processing steps in Kiosks.
* Mantis 1108 - Update Kiosk password reset emails to only send one email when more than one account is tied to the same address.
* Mantis 1110 - Update Kiosk password reset emails to only invalidate the reset link when used for each UID rather than per email.
* Mantis 1111 - Add payment by Square to Payment Gateways.
* Mantis 1112 - Added ability to create a single voucher, for a single user, from View Reg.
* Mantis 1113 - Remove PHP 5.x support. PHP 7.1.x or newer required to run CM. Recommended to stay in non EOL versions such as PHP 7.3+.
* Mantis 1118 - Corrected bug that was preventing people from making new kiosks.
* Mantis 1122 - Fixed issue that caused HTML emails to be sent as plain text when using pre-reg process payment.
* Mantis 1123 - Updated the language for kiosk setting "Choose Membership - Show membership if not available" to make it clear how it works.
* Mantis 1125 - Add email to send receipts on payment completion for Payment Gateway upgrade.
* Mantis 1127 - Add Admin Install - Payment Gateways page to configure new payment providers.
* Mantis 1132 - Delete all the hard kiosk folders and entry points (kiosks that had to be configured by steps file on the server). Conventions should be using the Console configured "Soft Kiosks".

* Added a tool "Activation Requests" to the pre-reg menu to help find customers who may be asking for activation or password reset emails.
* The process_payment landing page banner at the top to return you to your previous kiosk, if it has enough information to determine what your previous kiosk was.
* Upgraded the system to log an error if email failed.
* Upgraded the system to log an error if payment processing failed in an unexpected way.
* Corrected bug in edit settings. USD should not be the default value for the field since that will make it impossible to save "USD" as a value.
* Removed requirement for a virtual cashier id for payment gateways.
* Updated the payment browser to have transactions listed in time descending order
* Updated the payment browser set status "created' to 'incomplete' to better reflect that the transaction was started but not completed.
* Fix missing year in copyright footer of emails.
* Added sending of emails on the redemption of Vouchers.
* Modified MOST view reg tabs to now be ajax HTML loaded. This is a work in progress towards having View Reg act faster since we were starting to see some page slowdown.
* Updated voucher system to make vouchers redeemable in kiosk. This has some major changes to the way that the shopping cart items are processed. This tool has a function that takes all your shopping cart items, and memberships and finds a combination that is closest to the voucher value without going over. Leaving the remaining items in the shopping cart. With much considerations these functions may be usable in future

{{UpgradeAdvice}}

Release notes/10.0.13

2021-02-26T23:56:53Z

Alofoxx:

{{ReleaseNotesPreamble}}

'''Convention Master 10.0.13''' Released on August 10, 2020. This is a feature release. This release adds new bulk editing tools to help with membership transfers.

----------------------------------------------------
Release notes for version 10.0.13.
August 10, 2020
----------------------------------------------------
The following changes and or features were added

* Mantis 0663 - Added ability to add new memberships in bulk with the bulk editor tool to help cons move memberships between events in bulk using filters.
* Mantis 0663 - Added new Record Payment tool under filtering to apply bulk comp payments based on filters.
* Mantis 1099 - Added card last 4 digits and authcode to payment browser on card payments to assist with bulk refunds.

{{UpgradeAdvice}}

Release notes/10.1.1

2021-02-26T23:55:42Z

Alofoxx:

< [[Release notes]]

'''Convention Master 10.1.1''' Released on February 19, 2021. This is a patch release. This release corrects some minor bugs, and removes all functions deprecated in PHP 7.4.

'''UPGRADE WARNING:''' If you are currently on version 10.0.x, this 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.1.
February 19, 2021, 03:38:
----------------------------------------------------
The following changes and or features were added
* Mantis 476 - Admins can now remove/edit all filters
* Mantis 522 - Corrected bug that prevented removing Dealers Assistants
* Mantis 870 - Removed SYSTEM USER login.
* Mantis 905 - Corrected some issues with filter engine that returned some errors mentioning count()
* Mantis 1093 - Added ability to add new kiosks by copying existing ones.
* Mantis 1130 - Enabled the ability to remove a membership from the customer in the edit-reg, provided the customer has not already paid for the membership.
* Mantis 1134 - Fixed SQL error when listing assistants in artshow/dealers with no applicants approved.
* Mantis 1135 - Removed get_magic_quotes_gpc support.
* Mantis 1136 - Removed CM 9.x license support.
* Mantis 1137 - Removed unused PDF library.
* Mantis 1138 - Removed money_format() usage - 7.4 deprecated
* Mantis 1139 - Corrected some database errors that prevented setup from running.
* Mantis 1140 - Corrected bug in Artshow that allowed adding spaces that had no fees set up. Table types with no fees will be disabled to prevent creating an invalid configuration.
* Mantis 1141 - Added ability to refund membership, when the membership is refunded the events_attended membership type will revert to a previous membership type, or be removed if there are no un-refunded memberships left.
* Mantis 1142 - Set the oldest DB version to 572 and remove outdated upgrade files.

* Upgraded installer to do blowfish hashed password if the algorithm is present.
* BugFix - Found a bug that pre-reg process payment was unable to record a voucher payment. Issue Corrected.

{{UpgradeAdvice}}

Release notes/10.1.2

2021-02-26T23:55:25Z

Alofoxx:

< [[Release notes]]

'''Convention Master 10.1.2''' Released on February 26, 2021. This is a patch release. This release corrects some minor bugs.

'''UPGRADE WARNING:''' If you are currently on version 10.0.x, this 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.2.
February 26, 2021, 06:07:
----------------------------------------------------
The following changes and or features were added
* Mantis 1146 - Fixed issue with clearing the Bruteforce Lockout manually from the console.

{{UpgradeAdvice}}

Release notes/10.1.0

2021-02-26T23:54:35Z

Alofoxx:

< [[Release notes]]

'''Convention Master 10.1.0''' Released on January 31, 2021. This is a major feature release. This release changes to the new Omnipay payment library, and releases the voucher feature. This system contains many fixes to other smaller systems, but please be careful to test your kiosks and ensure payment processing is working when upgrading to this release.

'''UPGRADE WARNING:''' This release 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.0.
January 31, 2021, 15:46
----------------------------------------------------
The following changes and or features were added

* Mantis 900 - Payment Gateways: Add new system using Omnipay to support many payment processors.
* Mantis 987 - Validate cashbox system after Payment Gateway upgrade.
* Mantis 988 - Upgrade Art Show module to support Payment Gateway upgrade.
* Mantis 989 - Upgrade printable receipts to support Payment Gateway upgrade.
* Mantis 992 - Add currency selector to global settings.
* Mantis 1001 - Add update script that migrates existing paypal payment gateway settings to new Payment Gateway system.
* Mantis 1002 - Modify Kiosk payment screens for Payment Gateway upgrade.
* Mantis 1003 - Modify Kiosk editor in console to support Payment Gateway upgrade.
* Mantis 1004 - Add payment landing page for Payment Gateway upgrade.
* Mantis 1006 - Update Accounting - Credit Card Audit Report to show new Payment Gateway payments.
* Mantis 1007 - Add version check and warning message for OpenSSL version installed.
* Mantis 1008 - Update global settings for Payment Gateway upgrade.
* Mantis 1009 - Update db sanitizer script for new db changes.
* Mantis 1015 - Add database upgrade for Payment Gateways.
* Mantis 1016 - Add payment by Stripe to Payment Gateways.
* Mantis 1017 - Add warning and hard stop if on PHP7.0 or earlier. Add EOL Warning in console for people using PHP 7.2 or earlier.
* Mantis 1024 - Upgrade payment system to support payments from Payment Gateway upgrade.
* Mantis 1025 - Update receipts to have Payment Gateway information.
* Mantis 1040 - Add payment by Authorize.Net to Payment Gateways.
* Mantis 1041 - Add payment by PayPal to Payment Gateways.
* Mantis 1063 - Add Voucher system.
* Mantis 1069 - Add database upgrade for Voucher system.
* Mantis 1073 - Add new task to the automated task system to remind people to spend un-spent vouchers. This will remind people, at 2, 7, 15, and 30 days out from the voucher expiration date.
* Mantis 1074 - Mass Emailer - Add support for adding Vouchers to Emails in bulk.
* Mantis 1075 - Modify Kiosk payment screens for Voucher system.
* Mantis 1076 - Added the ability to see vouchers assigned to a person from the new Voucher tab in view reg.
* Mantis 1077 - Add "Use Voucher" button to cash register.
* Mantis 1079 - Add Voucher Manager that allows you to Bulk Create Vouchers.
* Mantis 1080 - Add vouchers to Pre-Reg process payment
* Mantis 1081 - Add vouchers concept to Pre-reg process refund. Added the ability to process refund to a voucher. You can now refund things to a voucher for people to use either elsewhere, or at a future year.
* Mantis 1082 - Add page to show existing vouchers.
* Mantis 1083 - Add vouchers to filter system.
* Mantis 1084 - Add Voucher Usage Graph / Voucher Report.
* Mantis 1087 - Add warnings to Kiosk that make it clear if using a payment gateway in sandbox mode - which will not record payments.
* Mantis 1088 - Remove support for old payment processing steps in Kiosks.
* Mantis 1108 - Update Kiosk password reset emails to only send one email when more than one account is tied to the same address.
* Mantis 1110 - Update Kiosk password reset emails to only invalidate the reset link when used for each UID rather than per email.
* Mantis 1111 - Add payment by Square to Payment Gateways.
* Mantis 1112 - Added ability to create a single voucher, for a single user, from View Reg.
* Mantis 1113 - Remove PHP 5.x support. PHP 7.1.x or newer required to run CM. Recommended to stay in non EOL versions such as PHP 7.3+.
* Mantis 1118 - Corrected bug that was preventing people from making new kiosks.
* Mantis 1122 - Fixed issue that caused HTML emails to be sent as plain text when using pre-reg process payment.
* Mantis 1123 - Updated the language for kiosk setting "Choose Membership - Show membership if not available" to make it clear how it works.
* Mantis 1125 - Add email to send receipts on payment completion for Payment Gateway upgrade.
* Mantis 1127 - Add Admin Install - Payment Gateways page to configure new payment providers.
* Mantis 1132 - Delete all the hard kiosk folders and entry points (kiosks that had to be configured by steps file on the server). Conventions should be using the Console configured "Soft Kiosks".

* Added a tool "Activation Requests" to the pre-reg menu to help find customers who may be asking for activation or password reset emails.
* The process_payment landing page banner at the top to return you to your previous kiosk, if it has enough information to determine what your previous kiosk was.
* Upgraded the system to log an error if email failed.
* Upgraded the system to log an error if payment processing failed in an unexpected way.
* Corrected bug in edit settings. USD should not be the default value for the field since that will make it impossible to save "USD" as a value.
* Removed requirement for a virtual cashier id for payment gateways.
* Updated the payment browser to have transactions listed in time descending order
* Updated the payment browser set status "created' to 'incomplete' to better reflect that the transaction was started but not completed.
* Fix missing year in copyright footer of emails.
* Added sending of emails on the redemption of Vouchers.
* Modified MOST view reg tabs to now be ajax HTML loaded. This is a work in progress towards having View Reg act faster since we were starting to see some page slowdown.
* Updated voucher system to make vouchers redeemable in kiosk. This has some major changes to the way that the shopping cart items are processed. This tool has a function that takes all your shopping cart items, and memberships and finds a combination that is closest to the voucher value without going over. Leaving the remaining items in the shopping cart. With much considerations these functions may be usable in future

{{UpgradeAdvice}}

Release notes/10.1.1

2021-02-26T23:52:20Z

Alofoxx:

< [[Release notes]]

'''Convention Master 10.1.1''' Released on February 19, 2021. This is a patch release. This release corrects some minor bugs, and removes all functions deprecated in PHP 7.4.

----------------------------------------------------
Release notes for version 10.1.1.
February 19, 2021, 03:38:
----------------------------------------------------
The following changes and or features were added
* Mantis 476 - Admins can now remove/edit all filters
* Mantis 522 - Corrected bug that prevented removing Dealers Assistants
* Mantis 870 - Removed SYSTEM USER login.
* Mantis 905 - Corrected some issues with filter engine that returned some errors mentioning count()
* Mantis 1093 - Added ability to add new kiosks by copying existing ones.
* Mantis 1130 - Enabled the ability to remove a membership from the customer in the edit-reg, provided the customer has not already paid for the membership.
* Mantis 1134 - Fixed SQL error when listing assistants in artshow/dealers with no applicants approved.
* Mantis 1135 - Removed get_magic_quotes_gpc support.
* Mantis 1136 - Removed CM 9.x license support.
* Mantis 1137 - Removed unused PDF library.
* Mantis 1138 - Removed money_format() usage - 7.4 deprecated
* Mantis 1139 - Corrected some database errors that prevented setup from running.
* Mantis 1140 - Corrected bug in Artshow that allowed adding spaces that had no fees set up. Table types with no fees will be disabled to prevent creating an invalid configuration.
* Mantis 1141 - Added ability to refund membership, when the membership is refunded the events_attended membership type will revert to a previous membership type, or be removed if there are no un-refunded memberships left.
* Mantis 1142 - Set the oldest DB version to 572 and remove outdated upgrade files.

* Upgraded installer to do blowfish hashed password if the algorithm is present.
* BugFix - Found a bug that pre-reg process payment was unable to record a voucher payment. Issue Corrected.

{{UpgradeAdvice}}

Release notes/10.1.2

2021-02-26T23:51:53Z

Alofoxx: Created page with "< Release notes '''Convention Master 10.1.2''' Released on February 26, 2021. This is a patch release. This release corrects some minor bugs. -------------------------..."

< [[Release notes]]

'''Convention Master 10.1.2''' Released on February 26, 2021. This is a patch release. This release corrects some minor bugs.

----------------------------------------------------
Release notes for version 10.1.2.
February 26, 2021, 06:07:
----------------------------------------------------
The following changes and or features were added
* Mantis 1146 - Fixed issue with clearing the Bruteforce Lockout manually from the console.

{{UpgradeAdvice}}

Upgrading Convention Master

2021-02-22T22:40:54Z

Alofoxx:

== 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
:: PHP 7.4.x recomended

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

=== Recommended Baseline for new servers ===
* Ubuntu 18.04 LTS
* PHP 7.4.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]]

Template:CM stable php requirement

2021-02-22T22:36:29Z

Alofoxx:

7.1.x