mirror/opensourcepos
1
0
Fork 0
mirror of https://github.com/opensourcepos/opensourcepos.git synced 2026-04-04 23:24:16 -04:00
Code Issues Packages Projects Releases Wiki Activity

Docs updated

Browse Source 
Updated documentation. Fixed image links, links in changelog, and minor typos.
This commit is contained in:
BudsieBuds
2024-04-29 16:44:28 +02:00
committed by jekkos
parent 1bc3d141e9
commit 0f098bb741
2 changed files with 49 additions and 45 deletions
Download Patch File Download Diff File Expand all files Collapse all files

66
CHANGELOG.md
View File

@@ -1,7 +1,8 @@
[unreleased]: https://github.com/opensourcepos/opensourcepos/compare/3.3.9...
[3.3.8]: https://github.com/opensourcepos/opensourcepos/compare/3.3.8...3.3.9
[3.3.7]: https://github.com/opensourcepos/opensourcepos/compare/3.3.7...3.3.8
[3.3.6]: https://github.com/opensourcepos/opensourcepos/compare/3.3.6...3.3.7
[unreleased]: https://github.com/opensourcepos/opensourcepos/compare/3.3.9...HEAD
[3.3.9]: https://github.com/opensourcepos/opensourcepos/compare/3.3.8...3.3.9
[3.3.8]: https://github.com/opensourcepos/opensourcepos/compare/3.3.7...3.3.8
[3.3.7]: https://github.com/opensourcepos/opensourcepos/compare/3.3.6...3.3.7
[3.3.6]: https://github.com/opensourcepos/opensourcepos/compare/3.3.5...3.3.6
[3.3.5]: https://github.com/opensourcepos/opensourcepos/compare/3.3.4...3.3.5
[3.3.4]: https://github.com/opensourcepos/opensourcepos/compare/3.3.3...3.3.4
[3.3.3]: https://github.com/opensourcepos/opensourcepos/compare/3.3.2...3.3.3
@@ -21,36 +22,41 @@
[2.3.4]: https://github.com/opensourcepos/opensourcepos/compare/2.3.3...2.3.4
[2.3.3]: https://github.com/opensourcepos/opensourcepos/compare/2.3.2...2.3.3
[2.3.2]: https://github.com/opensourcepos/opensourcepos/compare/2.3.1...2.3.2
[2.3.1]: https://github.com/opensourcepos/opensourcepos/compare/2.3.0...2.3.1
[2.3.0]: https://github.com/opensourcepos/opensourcepos/compare/2.2.2...2.3.0
[2.3.1]: https://github.com/opensourcepos/opensourcepos/compare/2.3...2.3.1
[2.3.0]: https://github.com/opensourcepos/opensourcepos/compare/2.2.2...2.3
# Changelog
All notable changes to this project will be documented here.
All notable changes to this project will be documented in this file.
## [3.4.0]
## [Unreleased]
List of changes in the `master` branch.
- Bump framework to CodeIgniter `4.x.x`
- Improve security performance against bots
- Bump framework to CodeIgniter 4.1.3
- Improve security performance against bots.
## [3.3.9] - 2023-11-06
## [3.3.8] - 2022-04-26
- Translation updates (Arabic, Central Khmer, Croatian, Czech, Danish, English, French, Indonesian, Lao, Russian, Spanish, Thai)
- Fix logout race condition issue ([#3578](https://github.com/opensourcepos/opensourcepos/issues/3578))
- Fix docker compose file ([#3754](https://github.com/opensourcepos/opensourcepos/issues/3754))
- Minor report fixes
- Translation updates (Flemish, Vietnamese, Thai, Azerbaijani, Spanish, French)
- Fix logo removal issue (CSRF regression)
- Substract refunds from total rewards as payment method
## [3.3.8] - 2022-08-03
## [3.3.7] - 2022-04-26
- Translation updates (Azerbaijani, Flemish, French, Spanish, Thai, Vietnamese)
- Fix logo removal issue (CSRF regression) ([#3533](https://github.com/opensourcepos/opensourcepos/issues/3533))
- Substract refunds from total rewards as payment method ([#3536](https://github.com/opensourcepos/opensourcepos/issues/3536))
- Translation updates (Thai, Indonesian, Swedish, Italian)
## [3.3.7] - 2022-03-29
- Translation updates (Chinese, French, Indonesian, Italian, Polish, Swedish, Thai)
- XSS fixes in bootstrap datatables
- Invoice numbering fixes
- Docker compose database scripts are now mounted from a container volume
## [3.3.6] - 2022-01-08
## [3.3.6] - 2021-10-31
- Translation updates (Hungarian, Indonesian, Bosnian, Ukranian, Vietnamese, Spanish)
- Translation updates (Bosnian, Dutch, Indonesian, Polish, Russian, Spanish)
- Make footer revision clickable (ref to github)
- Minor reporting adjustments
- Introduced new global keyboard shortcuts (see overview below)
@@ -66,9 +72,9 @@ List of changes in the `master` branch.
- Type juggling password fix for old logins
## [3.3.5] - 2021-08-26
## [3.3.5] - 2021-08-26 [YANKED]
- Translation updates (Romanian, Ukrainian, Vietnamese, Thai, Polish, Swedish, Portuguese, Arabic, French, Chinese, Dutch, Tamil, Turkish, Spanish)
- Translation updates (Arabic, Azerbaijani, Bulgarian, Chinese, Dutch, French, Indonesian, Polish, Portuguese, Romanian, Spanish, Swedish, Tamil, Thai, Turkish, Ukrainian, Vietnamese)
- New responsive login page based on Bootstrap `5`
- Translation fallback to English when a string is untranslated for the selected language
- Database and performance optimizations
@@ -84,7 +90,7 @@ List of changes in the `master` branch.
- Fixes for Docker to make it run on Windows
- Blind SQL injection fix
## [3.3.4] - 2021-04-18
## [3.3.4] - 2021-04-20
- Translation updates (Hungarian, Indonesian, Bosnian, Ukrainian, Vietnamese, Spanish)
- Prevent data wipeout when calling GET directly on the save endpoint
@@ -99,7 +105,7 @@ List of changes in the `master` branch.
- Add barcode field to item kits
- Fix discount register parsing in some specific locales
## [3.3.3] - 2020-12-31
## [3.3.3] - 2021-01-01
- PHP `7.4` support
- Set PHP `7.2` to be the minimum level due to older version deprecations
@@ -109,13 +115,13 @@ List of changes in the `master` branch.
- Improved security (CSRF protection)
- Various small improvements and bug fixes
## [3.3.2] - 2020-09-02
## [3.3.2] - 2020-09-03
- Fixed `only_full_group_by` issue with MySQL/MariaDB
- Fixed POS transaction return failure if items were deleted
- Various bug fixes
## [3.3.1] - 2019-12-04
## [3.3.1] - 2019-12-14
- Various bug fixes (please disable `only_full_group_by` option from MySQL/MariaDB to avoid issues)
@@ -244,7 +250,7 @@ List of changes in the `master` branch.
- Fixed `phppos to ospos` database migration script
- Minor bug fixes and some general code clean up
## [3.0.0] 2016-10-21
## [3.0.0] 2016-10-22
- Upgrade CodeIgniter to version `3.1.0`
- Major UI overhaul based on Bootstrap `3.0` and Bootswatch Themes
@@ -263,7 +269,7 @@ List of changes in the `master` branch.
- About 280 closed issues under `3.0.0` release label, too many to produce a meaningful list
- Various code cleanup, refactoring, optimization and etc.
## [2.4.0] - 2016-04-02
## [2.4.0] - 2016-10-03
- Upgrade CodeIgniter to version `3.0.5`
- Fix for spurious logouts
@@ -292,7 +298,7 @@ List of changes in the `master` branch.
- Minor code cleanup
- Removal of annoying backup prompt on logout
## [2.3.3] - 2016-01-05
## [2.3.3] - 2016-01-06
- Item kit fixes (search, list, ...)
- Add date picker widgets in sale/receiving edit forms
@@ -314,7 +320,7 @@ List of changes in the `master` branch.
- Add SQL script to clean zeroes in sales/receivings comments
- Numerous other bug fixes
## [2.3.2] - 2015-07-15
## [2.3.2] - 2016-01-25
- Nominatim (OpenStreetMap) customer address autocompletion
- Sale invoice templating
@@ -345,7 +351,7 @@ List of changes in the `master` branch.
- Fix item import through CSV
- Bug fixes for reports
## [2.3.0] - 2014-08-19
## [2.3.0] - 2014-08-20
- Support for multiple stock locations

28
README.md
View File

@@ -1,4 +1,4 @@
<p align="center"><img src="branding/emblem.svg" alt="Open Source Point of Sale Logo" width="auto" height="200"></p>
<p align="center"><img src="https://raw.githubusercontent.com/opensourcepos/opensourcepos/master/branding/emblem.svg" alt="Open Source Point of Sale Logo" width="auto" height="200"></p>
<h3 align="center">Open Source Point of Sale</h3>
<p align="center">
@@ -16,7 +16,7 @@
## 👋 Introduction
Open Source Point of Sale is a web-based point of sale system. The application is written in PHP, it uses MySQL (or MariaDB) as data storage back-end and has a simple but intuitive user interface.
Open Source Point of Sale is a web-based point of sale system. The application is written in PHP, uses MySQL (or MariaDB) as the data storage back-end, and has a simple but intuitive user interface.
The latest `3.4` version is a complete overhaul of the original software. It uses CodeIgniter 4 as a framework and is based on Bootstrap 3 using Bootswatch themes. Along with improved functionality and security.
@@ -40,8 +40,8 @@ The features include:
- Messaging (SMS)
- Multilanguage
- Selectable Bootstrap based UI theme with Bootswatch
- Mailchimp integration
- Optional Google reCAPTCHA to protect login page from brute force attacks
- MailChimp integration
- Optional Google reCAPTCHA to protect the login page from brute force attacks
- GDPR ready
## 🧪 Live Demo
@@ -82,7 +82,7 @@ Before creating a new issue, you'll need copy and include the info under the `Sy
If you're reporting a potential security issue, please refer to our security policy found in the [SECURITY.md](SECURITY.md) file.
NOTE: If you're running non-release code, please make sure you always run the latest database upgrade script and you download the latest master code.
NOTE: If you're running non-release code, please make sure you always run the latest database upgrade script and download the latest master code.
## 📖 FAQ
@@ -90,7 +90,7 @@ NOTE: If you're running non-release code, please make sure you always run the la
- If at login time you read `The installation is not correct, check your php.ini file.`, please check the error_log in `public` folder to understand what's wrong and make sure you read the [INSTALL.md](INSTALL.md). To know how to enable `error_log`, please read the comment in [issue #1770](https://github.com/opensourcepos/opensourcepos/issues/1770#issuecomment-355177943).
- If you installed your OSPOS under a web server subdir, please edit `public/.htaccess` and go to the lines with the comments `if in web root` or `if in subdir`, uncomment one and replace `<OSPOS path>` with your path and follow the instruction on the second comment line. If you face more issues, please read [issue #920](https://github.com/opensourcepos/opensourcepos/issues/920) for more information.
- If you installed your OSPOS under a web server subdir, please edit `public/.htaccess` and go to the lines with the comments `if in web root` or `if in subdir`, uncomment one and replace `<OSPOS path>` with your path, and follow the instruction on the second comment line. If you face more issues, please read [issue #920](https://github.com/opensourcepos/opensourcepos/issues/920) for more information.
- Apache server configurations are SysAdmin issues and not strictly related to OSPOS. Please make sure you can show a "Hello world" HTML page before pointing to OSPOS public directory. Make sure `.htaccess` is correctly configured.
@@ -98,13 +98,11 @@ NOTE: If you're running non-release code, please make sure you always run the la
- If you install OSPOS in Docker behind a proxy that performs `ssloffloading`, you can enable the URL generated to be HTTPS instead of HTTP, by activating the environment variable `FORCE_HTTPS = 1`.
- If you install OSPOS behind a proxy and OSPOS constantly drops your session, consider whitelisting the proxy IP address by setting `$config['proxy_ips'] = '<proxy ip>';` in the [main php config file](https://github.com/opensourcepos/opensourcepos/blob/master/application/config/config.php). In extreme instances, changing `$config['sess_match_ip'] = true;` to `FALSE` may also help.
- If you install OSPOS behind a proxy and OSPOS constantly drops your session, consider whitelisting the proxy IP address by setting `$config['proxy_ips'] = '<proxy ip>';` in the [main PHP config file](https://github.com/opensourcepos/opensourcepos/blob/master/application/config/config.php). In extreme instances, changing `$config['sess_match_ip'] = true;` to `FALSE` may also help.
- If you have suhosin installed and face an issue with CSRF, please make sure you read [issue #1492](https://github.com/opensourcepos/opensourcepos/issues/1492).
- PHP 8.0 is not currently supported, see [issue #3051](https://github.com/opensourcepos/opensourcepos/issues/3051).
- PHP 5.5 and 5.6 are no longer supported due to the fact that they have been deprecated and not safe to use from security point of view.
- PHP `≥ 8.1` is required to run this app.
## 🏃 Keep the Machine Running
@@ -119,7 +117,7 @@ If you choose to deploy OSPOS in the cloud, you can contribute to the project by
Open Source Point of Sale is licensed under MIT terms with an important addition:
The footer signature "© 2010 - _current year_ · opensourcepos.org · 3.x.x - _hash_" including the version, hash and link our website MUST BE RETAINED, MUST BE VISIBLE IN EVERY PAGE and CANNOT BE MODIFIED.
The footer signature "© 2010 - _current year_ · opensourcepos.org · 3.x.x - _hash_" including the version, hash and link to our website MUST BE RETAINED, MUST BE VISIBLE IN EVERY PAGE and CANNOT BE MODIFIED.
Also worth noting:
@@ -127,13 +125,13 @@ _The above copyright notice and this permission notice shall be included in all
For more details please read the [LICENSE](LICENSE) file.
It's important to understand that although you are free to use the application the copyright has to stay and the license agreement applies in all cases. Therefore any actions like:
It's important to understand that although you are free to use the application, the copyright has to stay and the license agreement applies in all cases. Therefore, any actions like:
- Removing LICENSE and/or any license files is prohibited
- Authoring the footer notice replacing it with your own or even worse claiming the copyright is absolutely prohibited
- Claiming full ownership of the code is prohibited
In short, you are free to use the application but you cannot claim any property on it.
In short, you are free to use the application, but you cannot claim any property on it.
Any person or company found breaching the license agreement might find a bunch of monkeys at the door ready to destroy their servers.
@@ -141,5 +139,5 @@ Any person or company found breaching the license agreement might find a bunch o
| <div align="center">JetBrains</div> | <div align="center">Travis CI</div> |
|--- | --- |
| <div align="center"><img src="https://upload.wikimedia.org/wikipedia/commons/9/9c/IntelliJ_IDEA_Icon.svg" alt="IntelliJ IDEA Logo" height="50"></div> | <div align="center"><img src="https://secrethub.io/img/travis-ci.svg" alt="Travis CI Logo" height="50"></div> |
| Many thanks to [JetBrains](https://www.jetbrains.com/) for providing a free license of [IntelliJ IDEA](https://www.jetbrains.com/idea/) to kindly support the development of OSPOS. | Many thanks to [Travis CI](https://travis-ci.org) for providing a free continuous integration service for open source projects. |
| <div align="center"><a href="https://www.jetbrains.com/idea/" target="_blank"><img src="https://github.com/opensourcepos/opensourcepos/assets/12870258/187f9bbe-4484-475c-9b58-5e5d5f931f09" alt="IntelliJ IDEA Logo" height="50"></a></div> | <div align="center"><a href="https://www.travis-ci.com/" target="_blank"><img src="https://github.com/opensourcepos/opensourcepos/assets/12870258/71cc2b44-83af-4510-a543-6358285f43c6" alt="Travis CI Logo" height="50"></a></div> |
| Many thanks to [JetBrains](https://www.jetbrains.com/) for providing a free license of [IntelliJ IDEA](https://www.jetbrains.com/idea/) to kindly support the development of OSPOS. | Many thanks to [Travis CI](https://www.travis-ci.com/) for providing a free continuous integration service for open source projects. |