Ensembia/QRForge-selfhosted
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Local setup eliminated and documentation updated

Browse Source
This commit is contained in:
giandonato.inverso@edempg.it
2025-01-12 23:48:49 +01:00
parent 79d9ac71a3
commit f05c073ad4
20 changed files with 8 additions and 5567 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/index.html
+7 -13
View File
@@ -61,8 +61,8 @@
<div class="mainpanel">
<div class="title" id="header">
<h1>PHP Dynamic Qr code - v2.x</h1>
<small> Documentation - v2.x / Last Update: 16/10/2023</small>
<h1>PHP Dynamic Qr code - v2.3.0</h1>
<small> Documentation - v2.3.0 / Last Update: 13/01/2025</small>
<!--<h2 style="color: black">Technical documentation deprecated as the core of the project has been modified in version 2.0</h2>-->
</div>
@@ -81,24 +81,18 @@
<div id="setup">
<h2> Setup</h2>
<p>You can choose between local installation (recommended for development) and docker installation (recommended for general use)</p>
<p><u>Follow these steps to install the script locally:</u></p>
<p><u>Local setup:</u></p>
<ol><strong>
<li>Clone the project from github</li>
<li>Use src/ folder as Document Root of your webserver</li>
<li>Edit config/environment.php with your database credential</li>
<li>Launch install/setup.php file in your browser </li>
<p>The script checks the requirements, write permissions on the generated folders and creates a database with sample data</p>
<li>Finish</li>
<p>If all went well you will see a summary screen with a login button (username: superadmin, password: superadmin). Alternatively, you will get an error message</p>
<li>No more available from v2.3.0</li>
</ol>
<p><u>Follow these steps to install the script with docker via docker compose (simplest method, recommended):</u></p>
<p><u>Docker:</u></p>
<ol>
<li>Download docker-compose.yml file from github and edit if you want (recommended)</li>
<li>docker compose build --no-cache && docker compose up -d</li>
<li>Open your browser at http://localhost:80 and login with (username: superadmin, password: superadmin) </li>
<li>Finish</li>
</ol>
<p><u>Follow these steps to install the script with docker via locally build image:</u></p>
<p><u>Docker image building:</u></p>
<ol>
<li>Clone the project from github</li>
<li>Clone the database project from github: https://github.com/giandonatoinverso/PHP-Dynamic-Qr-code-db</li>
@@ -289,7 +283,7 @@ However, this feature is not recommended as it can cause different QR code scann
<h2>Support</h2>
<div class="wrapper">
<div class="alert alert-success alert-dismissible" role="alert">
If you have any question please feel free to email me at <strong><a href="mailto:info@giandonatoinverso.it?Subject=Dynamic%20Qrcode" target="_top">info@giandonatoinverso.it</a></strong>
If you have any question please feel free to email me at <strong><a href="mailto:hello@giandonatoinverso.dev?Subject=Dynamic%20Qrcode" target="_top">hello@giandonatoinverso.dev</a></strong>
</div>
<p>Please don't forget to rate my script on GitHub.
<br>