Sandbox is our in-house R&D system

While your welcome, and infact encouraged, to use it for development of the Bearsampp program is it NOT for use as your daily driver!  It's strictly a R&D system.
There are a few things that are very unique to Sandbox and require important consideration.
ANY branch other then main should be considered alpha and highly likely to break everything.  Using sandbox requires patience and understanding how things function.
I'll attempt to explain things but nothing will replace experience.  Even Jacob and Bear have been slapped by sandbox more then once!

How to setup sandbox

Setting up sandbox is not difficult but the steps are exacting.

Using Sandbox is alot like any other repo in that you do a git clone and your on your way... EXCEPT there is a requirement that you do these steps in the following order.

1. your expected to be familiar with how to use a git aware IDE.  Your welcome to use the cli but these instructions are designed for an IDE.
2. clone the branch "main" into your working directory
3. switch to the branch "release"
4. rename the branch "main" to anything
5. using the "remote" branch feature merge the remote "main" branch on top of the local "release" branch
6. rename the local "release" branch to "main"
7. delete the branch you renamed main to 
8. you should now have a single local branch named "main"  In this branch is a full working version of the "Sandbox" version of bearsampp including all unique iconography.
9. start up Sandbox and test that everything works.  If so you're ready to do R&D

Firing off a bombing run

Doing a bombing run is fun and scary at the same time.  This is a large commitment of drive space so if your on anything smaller then a 64gb drive, and not at least usb 3.0 you should probably not do this!!!
So now that your worried, lets put our bomber jacket on and punch that pickle.

1. This couldn't be simpler.  Make sure your on the "main" branch.
2. if this is a fresh install of Sandbox then remove all branches from your local except "main"
3. go to the sandbox repo release for bomber payloads and download all the files there.
4. use the extract.bat and unzip all the files
5. put the bin in the root of sandbox and do NOT overwrite

Why bother with Sandbox?

Jacob and Bear had several "discussions" over the merits of sandbox. It was conceived and matured by Bear as a safe environment to test the numerous changes that were upcoming without endangering our "core".
Bear had nuked his installation of core that was his daily driver more then once and with dozens and dozens of fixes coming it was important that there was some simple way for things to be done.
You have to understand that when Bear thinks something is "simple' you should probably be scared! LOL

He's put a lot of thought and effort into what is maturing to be a great system, in his mind, for R&D.  When everything is fully matured making a merge on sandbox will auto create a pr & merge onto core.  This will facilitate the ability to roll out a new version of core very quickly, with the comfort in knowing everything has been tested thoroughly.  There will still be a final test of the "build" of course but it should always be painless.

Breaking something in sandbox is as trivial a fix as deleting, or fixing, that branch and starting fresh from main. None of the day-to-day file changes that happen in core while testing effect Sandbox.  It's completely isolated from the runtime(s).  This is one of its major strengths.  Your commits are completely and intentionally restricted to the "core" system.

What's it been like using Sandbox?

While Jacob has struggled with Sandbox, ALOT, Bear has been able to make it shine!
He uses it daily when making the changes that make Bearsampp mature.  PR's are created from those changes, tested, most of the time by Jacob, and then merged into main when they have been successfully tested.
It's a tool that if/when more developers come onboard they will have a reliable and fully tested method of doing things to further the program along.

Can't I just use normal Bearsampp?

Yep! BUT, DON'T COME COMPLAINING TO BEAR WHEN YOU BOMB YOUR INSTALL!  Don't think it can't happen to you, or "meh, easy to fix if it happens".  You couldn't be further from the truth.  Just recently Jacob bombed EVERY version of Bearsampp on his computer during testing of an encryption system.  The hours of effort and frustration he spent trying to figure it out was not for the faint of heart.  Jacob, to his merits, stuck with the battle and after many HOURS found out the real issue and its original cause.  Bear had to admit to Jacob he would've never figured it out and that's not the first time or even second or third that something like this has happened.  Jacob's tenacity, experience in IT has been instrumental in the growth of Bearsampp.
Furthermore using our main repo for R&D actually endangers our main repo because the rollbacks WILL happen!  It takes a minimum of one to two hours to roll out a new version of Bearsampp WITHOUT anything going wrong so the lower the chances of something failing the better.

How long does it take to restore Sandbox when it bombs

Ideally? 30 seconds. IT SHOULD be as simple as destroying the branch and moving forward. But in the chance you have to nuke and start over, given a decent net connection, its a 15 min fix.

How exactly do I use Sandbox?

So, just like any other project you develop, you've created a branch, you've done some kind of an improvement to Bearsampp and your ready to fire it off. Great, one thing you'll notice is the iconography for Sandbox is different then for Bearsampp. This is by design. The color is a warning to you that your using a system designed for things to go wrong.
Run through the appropriate steps to test the changes you've made.  Assuming those work then check EVERY function in Sandbox.  The more thorough you are in this step the less work on everyone else who has to do the same thing to test your "fix".  Lastly fire up localhost and make sure everything there works.  Check the links, iconography, spinners, everything!
If everything looks ok, then commit, and create a pr.  If you are part of the "Qodo" team, which you most likely are, there's no need for anything other then a title for the PR.  PR-Agent Pro will do all the heavy lifting.  Then just sit back and wait for the merge of your effort.  Remove your local branch once your pr has been merged and start on the next issue.  Don't be like Bear and forget to switch to main & creating a new branch before starting on the next thing.  If you need some documentation on how the api works, then check out our API docs.

To use a single database irregardless of the db version follow this video.  The risk to doing this is if the db changes how data is handled/stored it could break our db.

The about window is a 450 x 250 window created by class.action.about.php styling is in class.windbinder.php specifically line 150

    public function drawRect($parent, $xPos, $yPos, $width, $height, $color = 15790320, $filled = true)
    {
        return $this->callWinBinder('wb_draw_rect', array($parent, $xPos, $yPos, $width, $height, $color, $filled));
    }

You must use decimal when working with colors such as https://convertingcolors.com/decimal-color-15790320.html
The hex value for the background is #f0f0f0

The bar color is controlled by Bearsampp\core\classes\tpls\class.tpl.aestan.php lines 275-276

 'BarGradientEnd=$00c07840' . PHP_EOL .
 'BarGradientStart=$00c07840' . PHP_EOL .

The first 2 digits must always be '00' and the next 6 are in BBGGRR format

Icons for the start menu and shortcuts and such are contained inside Bearsampp.exe itself.
To change those requires a few steps...

1. Create your new 128px x 128px image as a png.
2. Go to https://www.freeconvert.com/png-to-ico and convert the png to .ico.  I recommend you leave the settings at their default.
3. Go to http://www.angusj.com/resourcehacker/ and install it.
4. Within Resource Hacker open "Bearsampp.exe"
5. Following the instructions on Resource Hacker website replace the existing icons Ctrl+R
6. Compress and save

Keep in mind that modern windows can have many colors on the task bar and startup menu so the icon might be on a dark background or might be on a light background so choose your icon style appropriately.

The icon for inside the Bearsampp system tray, left menu, is in the bar.dat file in the root folder of Bearsampp.
Replacing the image in the icon tray takes a few steps...

1. Create a 32x32 pixel transparent png
2. Go to https://onlinepngtools.com/convert-png-to-bmp and convert that png to a .bmp
   1. Change the background color to match the color in core\classes\tpls\class.tpl.aestan.php 'BarGradientEnd=$0030BF00' & 'BarGradientStart=$0030BF00'
   
3. Now choose "Save as" and save it as "bar.dat" into the root of Bearsampp

Winbinder documentation can be found at https://crispy-computing-machine.github.io/Winbinder-Docs/

Contribute

Requirements

OpenJDK

You need OpenJDK ( minimum jdk 11 ) which can be obtained from here
if you use the .zip version of jdk then you will need to extract the archive on your computer (eg. C:\jdk) and add the path to java.exe (eg. C:\jdk\bin) to your environment var PATH.
It's easier to use the .msi installer.
To check if you have Java in your path, open a command prompt and type java -version :

openjdk version "11.0.2" 2019-01-15
OpenJDK Runtime Environment 18.9 (build 11.0.2+9)
OpenJDK 64-Bit Server VM 18.9 (build 11.0.2+9, mixed mode)

When updating versions of Microsoft's JDK it does not remove the older version. You will need to use the Add/remove programs function of windows to remove the pre-existing version.

Apache Ant

Apache Ant is used with the OpenJDK to build and package the portapp.
You need at least Apache Ant 1.10.5 that you can download on the Apache website.
Extract the archive on your computer (eg. C:\apache-ant) and add the path to ant.bat (eg. C:\apache-ant\bin) to your environment var PATH.
To check if you have Apache Ant in your path, open a command prompt and type ant -version :

Apache Ant(TM) version 1.10.5 compiled on July 10 2018

Configuration

• Fork and clone the module of your choice.
• Clone dev in the parent folder of the module.
• Create a new pull request with your work.

For example :

cd C:\work\
git clone --recursive https://github.com/bearsampp/module-adminer.git
git clone --recursive https://github.com/bearsampp/dev.git
cd module-adminer\

Directory structure example :

[-] dev
 | [-] build
 |  |  | build-commons.xml 
[-] bearsampp-{bin|app|tool}-{name}
 |  | build.xml

If you are not familiar with creating a pull request, you can create a new module like this :

• Increment the build.release in the build.properties file using a YYYY.mm.dd format.  Such as 2022.07.24
• If you want you can change the build.path (default C:\bearsampp-build).
• Open a command prompt in your module folder and call the Ant target release : ant release.
• Upload your release on a file hosting system like Sendspace.
• Create an issue on Bearsampp repository to integrate your release.

Could not execute menu item (internal error)
[EAccessViolation] Access violation at address XXXXXXXX in module ‘neard.exe’. Read of address XXXXXXXX

Bearsampp tray icon is based on Aestan Tray Menu.

There are several cases to reproduce this error :

• Execute multiple actions at the same time.
• Do not wait for an action ends.
• A procedure error with Bearsampp based on bearsampp.ini file.

For the last case you will have to create an issue.

Aestan Tray Menu built in service manager is not handled by Bearsampp in the Service menu  


You can take look to the Windows Event Log to find out where the error occurred or use the Debug menu of the service (like Apache, MySQL or MariaDB).

If you still can't solve it you can try creating an issue and perhaps the community can help you solve it.

When PostgreSQL is started as a service, you can have this error :

LOG:  database system was shut down at 2013-06-13 00:54:33 UTC
LOG:  autovacuum launcher started
LOG:  database system is ready to accept connections
FATAL:  role "John" does not exist
 done
server started

This happens when you run pg_ctl start with the -w (wait) option like Bearsampp, because it will try a test connection with a user that does not exist (in your case). But that’s not really a problem (except for the confusing error message), because that proves that the server is up.

Bearsmapp icon has 3 states :

•  : All enabled services are started
•  : One or more enabled services are stopped
•  : All enabled services are stopped

To check from the Services Manager, click Start > Run and type services.msc and check the status of Bearsampp* services :
You can also see the state of services by going to http://localhost

Services loaded with NSSM have the PATH environment variable rewritten.
Impacted services are : Apache, Mailpit, Xlight and Memcached.

As you can see you can add paths relative to the Bearsampp root folder (eg. www).

In the phpinfo the Apache environment will look like this :

And as you can see some paths are automatically added :

• %SystemRoot%\system32
• %SystemRoot%
• %SystemRoot%\system32\Wbem
• %SystemRoot%\system32\WindowsPowerShell\v1.0
• BEARSAMPP_PATH\bin\apache\apache*\bin
• BEARSAMPP_PATH\bin\php\php*
• BEARSAMPP_PATH\bin\php\php*\pear
• BEARSAMPP_PATH\bin\php\php*\imagick
• BEARSAMPP_PATH\bin\nodejs\nodejs*
• BEARSAMPP_PATH\bin\svn\svn*
• BEARSAMPP_PATH\tools\composer\composer*
• BEARSAMPP_PATH\tools\git\git*\bin
• BEARSAMPP_PATH\tools\imagemagick\imagemagick*
• BEARSAMPP_PATH\tools\python\python*\bin
• BEARSAMPP_PATH\tools\ruby\ruby*\bin

If you wish to use the terminal you can use php -m and this will give you a list of all loaded modules

According to VMWare Knowledge base article, connection to VMware Workstation Server (the shared virtual machines) is administered by the VMware Host Agent service. The service uses TCP ports 80 and 443. This service is also used by other VMware products, including VMware Server and vSphere, and provides additional capabilities.

This will block the execution of the Apache service on Bearsampp.

You can change the VMware Workstation Server ports when you install Workstation and after Workstation is installed.
To connect from a second instance of Workstation to Workstation Server:

• Go to File > Connect to Server.
• Enter the host name or IP address of the host machine running Workstation Server.
• When prompted, login with the username and password of a local administrator on the remote host.

Note: If the VMware Workstation Server service running on the remote server is not using the default port, you must specify the port number. For example, remotehost:444.

With the Shared VMs Workstation preferences, you can also disable the server. To access the Shared VMs Workstation preferences:

• Go to Edit > Preferences.
• Click the Shared VMs tab.

Xdebug 3 completely changed how things are done.  You can find a document explaining those changs here.
The default port is now 9003 instead of 9000
Due to those changes we've changed the way all future php releases are configured.
the [xdebug] section in php.ini will be changed to this. 

[xdebug]
xdebug.mode = debug
xdebug.start_with_request = trigger
xdebug.output_name = cachegrind.out.%t.%p
xdebug.output_dir = "~BEARSAMPP_LIN_PATH~/tmp/cachegrind"
xdebug.var_display_max_children = "1024"
xdebug.var_display_max_depth = "8192"
xdebug.var_display_max_data = "32768"
xdebug.max_nesting_level = "250"

Bearsampp is a portable application therefore there is nothing to install except the prerequisites package.  This provides the various Microsoft code libraries that are used.  If you already have them installed, and its possible you already do,  they will not be installed again.

For each release there are "Upgrade notes" provided to guide you on how to upgrade.

By default, the user is "root" with no password

The user is postgres and there is no password for this user.

By default MySQL is started on port 3306 and MariaDB on port 3307.
Here is an example using PDO to access a database named wordpress installed on MySQL and MariaDB :

$mysql = new PDO('mysql:host=127.0.0.1;port=3306;dbname=wordpress', 'root', '');
$mysqlStmt = $mysql->query("SELECT * FROM wp_comments");
var_dump($mysqlStmt->fetchAll(PDO::FETCH_ASSOC));

$mariadb = new PDO('mysql:host=127.0.0.1;port=3307;dbname=wordpress', 'root', '');
$mariadbStmt = $mariadb->query("SELECT * FROM wp_comments");
var_dump($mariadbStmt->fetchAll(PDO::FETCH_ASSOC));

<p>There are two ways to disable some services to launch on startup.</p>
<p>First you can edit the <code class="highlighter-rouge">bearsampp.conf</code> file and change the value to <code class="highlighter-rouge">0</code> for keys ending with <code class="highlighter-rouge">enable = "1"</code> below <code class="highlighter-rouge">BINS</code>.<br>Example: <code class="highlighter-rouge">mysqlEnable = "0"</code></p>
<p>Or you can go to the <em>Bearsampp</em> menu.<br>Example: <strong>Bearsampp tray menu then Mysql then Enable / Disable<br><img src="/images/Docs/screenshots/disable%20service.png" loading="lazy" width="468" height="652" data-path="local-images:/Docs/screenshots/disable service.png"><br></strong></p>

The changes have to be done in the alias configuration in alias\phpmyadmin.conf :

<Directory "C:/neard/apps/phpmyadmin/phpmyadmin4p3/4.4.15.6/">
    Options Indexes FollowSymLinks MultiViews
    AllowOverride all
    # START switchOnline tag - Do not replace!
    Order Deny,Allow
    Deny from all
    Allow from 127.0.0.1 ::1
    # END switchOnline tag - Do not replace!
    
    <IfModule php5_module>
        php_admin_value upload_max_filesize 128M
        php_admin_value post_max_size 128M
        php_admin_value max_execution_time 360
        php_admin_value max_input_time 360
    </IfModule>
    <IfModule php7_module>
        php_admin_value upload_max_filesize 128M
        php_admin_value post_max_size 128M
        php_admin_value max_execution_time 360
        php_admin_value max_input_time 360
    </IfModule>
</Directory>

To turn off and disable Skype usage of and listening on port 80 and port 443, open the Skype window, then click on the Tools menu and select Options. Click on the Advanced tab, and go to the Connection sub-tab. Untick or uncheck the checkbox for Use port 80 and 443 as an alternative for additional incoming connections option. Click on the Save button and then restart Skype to make the change effective.

Open a CMD prompt (as Admin) and type
iisreset /stop

After the modifications have been made, restart Bearsampp for the changes to take effect.

Or you can change the port number of IIS by following the official Microsoft documentation.

Since Ruby 2.4, RubyInstaller is based on MSYS2 toolchain. If you want to compile C based ruby gems, you will have to download and install all necessary MSYS2 build tools by typing the command ridk install used by the official installer.

Since Chrome 58, self-signed certificates generated with Bearsampp are no longer accepted and you will have the error NET::ERR_CERT_AUTHORITY_INVALID if you go to https://localhost.  To resolve this you can add the .crt files to the local trusted certificate store using the steps below.

• First go to the ssl folder of bearsampp and locate the .crt file then right click on the .crt file and select "Install certificate"
  
•  Next choose "local machine"
  
• Next choose "Place all certificates in the following store" and then select "Trusted Root Certificate Authorities"
  
• Now choose "finish"
  
• Repeats for each .crt
• Close and reopen the browser

• Binaries are the main factor of Bearsampp. Some require to be run as a service like Apache and others are used on demand like Node.js.
• Applications are third-party utilities used by some binaries like phpMyAdmin used by PHP and MySQL / MariaDB. Each application has its own Apache alias (see bearsampp\alias folder).
• Tools are useful utilities to make Bearsampp better and enhance your developments.
• Highlight is an archived module

Modules

For binaries

• Start Bearsampp
• Switch your binary to the downloaded version (Left click > {name} > Versions)

Otherwise,

• Edit the bearsampp.conf file and replace the key {name}Version with the correct version.
• Start Bearsampp