| Installation Guide | |
|---|---|
| This article is a part of the Installation Guide. You can read it alone or click the previous link to easily move between the steps. | |
| << Start: Installation Guide | Step 2: Core Installation >> |
{% include callout.html content="Windows ≥ 10
Boost ≥ 1.78
MySQL ≥ 8.0 (Recommended 8.4)
OpenSSL ≥ 3.x.x
CMake ≥ 3.16
MS Visual Studio (Community) ≥ 17 (2022) (Desktop) (No preview)" type="info" %}
| Header |
|---|
| Git |
| Github Desktop |
| Visual Studio Community 2022 |
| MySQL |
| MySQL Client |
| CMake |
| OpenSSL |
| Boost |
- Run the standalone installer
{% include note.html content="During the installation, you will be prompt to Adjust your PATH environment. Pick 'Git from the command line and also from 3rd-party software'." %}
- Download the installer and follow the steps to set it up.
{% include note.html content="Make sure you're getting 'Visual Studio 2022 Community' and not 'Visual Studio Code'." %}
-
Install the C++ compiler. You will need to install the C++ compiler.
To do this, select Desktop development for C++ under Workloads -> Desktop & Mobile.
-
Run the Windows MSI Installer.
-
Scroll down to the bottom and click on "No thanks, just take me to the downloads!"
-
When the installation is almost done, make sure "Launch the MySQL Instance Configuration Wizard" is checked, then click "Finish".
-
When the MySQL Instance Configuration Wizard launches, most default options are fine, but remember the username and password you use (root // whatever). You will need them to log into your chosen database management tool (below) in order to import SQL files later.
-
To test if MySQL is set up correctly, hit CTRL+ALT+DEL on your keyboard, enter the Task Manager, and select the "Services" tab. In the list of services you should see "MySQL" with a status of "Running".
-
Add MySQL to Environment Variables.
-
Go to Control Panel -> System
-
Go to Advanced System Settings
-
Go to Environment Variables
-
Under "Systemvariables" select Path
-
Edit and add your install path of MySQL. For example: C:\Program Files\MySQL\MySQL Server 8.0\bin\
-
{% include note.html content="MySQL development files: These files are shipped with MySQL Server. Search for them in the program files directory: MySQL\MySQL Server 8.0\lib / MySQL\MySQL Server 5.7\lib. You will need them later on for the server." %}
-
HeidiSQL (Best for beginners)
-
MySQL CLI (Fastest, comes with your MySQL Instalation)
-
DBeaver (Multi-platform Database Management Tool)
{% include note.html content="You only have to pick one of the options on top." %}
-
Try connecting to your database. You may be looking for "Connect to Host", "New Connection" or "Session Manager" depending on which program you use.
-
Create a new connection/session. The Hostname/IP address of "127.0.0.1" or "localhost" is fine if you installed MySQL on the same computer that you installed HeidiSQL or SQLYog. Simply fill in your root // whatever password and you should now be able to connect to your database. It's the information used in this step MySQL
{% include note.html content="NEVER download and install the RC (Release Candidate), ALWAYS the Latest Release" %}
- Run the Windows MSI Installer.
{% include note.html content="We recommend compiling in 64-bit mode." %}
{% include note.html content="Find the 64-bit version by finding the latest 3.x.x Win64 OpenSSL that is NOT the light version." %}
- Run the Windows EXE/MSI Installer.
{{site.data.alerts.note}} If you get the error 'Missing Microsoft Visual C++ .... Redistributable' while installing OpenSSL, download the Microsoft Visual C++ 2017/2019/2022 Redistributable Package (x64) (Direct Download) (1.7MB Installer) and install it. {{site.data.alerts.end}}
{{site.data.alerts.note}} While installing OpenSSL, choose The OpenSSL binaries (/bin) directory (NOT "The Windows system directory") when given the choice of where to copy the OpenSSL DLLs. These DLLs will need to be located easily for Core Installation. {{site.data.alerts.end}}
{% include note.html content="You only have to pick one of the options on top. The one that has the specific number, it's direct download to that version." %}
- Add an environment variable to the "System" variable named "BOOST_ROOT" and with the value being your Boost installation directory, e.g.
C:/local/boost_1_81_0. Important is to use '/', not '\' when pointing to the directory. (Make sure that it does not have a trailing slash (end of the path). If you still get problems, add the same variable in theUSERvariables section too, as shown in the image below.)
{% include note.html content="Notice that this image shows the version number 1.72.0 - use your actual version number in your settings." %}
{% include note.html content="Make sure your BOOST_ROOT variable value has it's / facing the correct way. Like/this/that not\this\that" %}
| Header |
|---|
| Git |
| Github Desktop |
| Visual Studio Community 2022 |
| MySQL |
| MySQL Client |
| CMake |
| OpenSSL |
| Boost |
If you are still having problems, check:
-
Join our Discord Server, but it is not a 24/7 support channel. A staff member will answer you whenever they have time.
| Installation Guide | |
|---|---|
| This article is a part of the Installation Guide. You can read it alone or click the previous link to easily move between the steps. | |
| << Start: Installation Guide | Step 2: Core Installation >> |