{"id":13523728,"url":"https://github.com/joshp23/YOURLS-IQRCodes","last_synced_at":"2025-04-01T01:33:21.769Z","repository":{"id":49427358,"uuid":"76757913","full_name":"joshp23/YOURLS-IQRCodes","owner":"joshp23","description":"YOURLS QRCode plugin with exposed options and full integration","archived":false,"fork":false,"pushed_at":"2021-06-04T13:06:03.000Z","size":269,"stargazers_count":22,"open_issues_count":8,"forks_count":11,"subscribers_count":7,"default_branch":"master","last_synced_at":"2024-11-02T08:30:44.677Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/joshp23.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-12-18T02:09:34.000Z","updated_at":"2024-09-05T16:21:29.000Z","dependencies_parsed_at":"2022-08-26T22:50:13.560Z","dependency_job_id":null,"html_url":"https://github.com/joshp23/YOURLS-IQRCodes","commit_stats":null,"previous_names":[],"tags_count":33,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshp23%2FYOURLS-IQRCodes","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshp23%2FYOURLS-IQRCodes/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshp23%2FYOURLS-IQRCodes/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/joshp23%2FYOURLS-IQRCodes/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/joshp23","download_url":"https://codeload.github.com/joshp23/YOURLS-IQRCodes/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246567225,"owners_count":20798136,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T06:01:03.188Z","updated_at":"2025-04-01T01:33:16.761Z","avatar_url":"https://github.com/joshp23.png","language":"PHP","funding_links":[],"categories":["Plugins"],"sub_categories":["I"],"readme":"# YOURLS-IQRCodes\nYOURLS Integrated QRCodes plugin with exposed options and full integration\n\nThis is an updated fork of [Inline QRCode](http://techlister.com/plugins-2/qrcode-plugin-for-yourls/354/) which is more compact, configurable, and just as efficient with more features.\n\n## Requires:\n- PHP-GD on your system\n- YOURLS 1.7.9 +  \n- [U-SRV](https://github.com/joshp23/YOURLS-U-SRV) v2.0.0 +\n\n## Features\n### Old\n* QRCodes are generated and cached for every new short url\n* A new QRCode is generated when a short url is edited\n* Cached QRCodes are deleted when its corresponding short url is deleted\n* QRCodes are displayed within the sharebox whenever the sharebox is displayed\n* QRCodes are generated for pre-existing shorturls when sharebox is displayed\n* Codes are generated from a standalone php based QRCode library\n  * No calls to google!\n\n### New\n* All options are available in the admin interface\n  * Code size\n  * Border width\n  * ECC level\n  * Image file type\n  * Optional logo watermark (image preview, scale, location on QR Code)\n  * Image cache location \n  * Auto-delete or preserve cache on plugin deactivation\n* Scan the entire database at once and generate QR Codes for any short url that is found to be missing one\n* Plenty of well documented, practical examples in the options page to help get started with integration\n* Code links are served using U-SRV, a secure system allowing greater integration\n* Updated and minimized md5.js\n* Streamlined version of the QR Code generation library\n* Almost 1/2 the size of its predecessor\n  * This can halfed again by disabling and deleting the PHP QR Code cache, which was left in for enhanced performance. This setting can be found on lnie 100 of `assets/phpqrcode.php`\n* Append `.qr` to any short url to display qr code\n\n## Installation\n1. Download and install YOURLS and U-SRV. U-SRV will have created it's cache, within which will sit the IQRCodes's cache.\n2. Download the [latest release](https://github.com/joshp23/YOURLS-IQRCodes/releases/latest) of this repo and extract the `iqrcodes` folder to `YOURLS/user/plugins/`\n\t- the following commands are run from `YOURLS` root folder. Eg, `/absolute/path/to/YOURLS`\n3. Symlink or copy `qrchk.php` into the `pages` folder. Automation of this task is planned for a future release.\n    - Symlink:  \n\t  `ln -s user/plugins/iqrcodes/assets/qrchk.php user/pages/qrchk.php`  \n    - Copy:  \n\t  `cp user/plugins/iqrcodes/assets/qrchk.php user/pages/qrchk.php`\n3. Set permissions and cache\n    -  There needs to be two cache folders (relative to YOURLS root)\n       -  `user/plugins/iqrcodes/cache`   \n       is included with the plugin download\n       -  `/path/to/U-SRV/cache/qr`   \n       iqrcodes will attempt to create this\n    - In case of failure just do somethign like the following (as root):\n      -  `mkdir /PATH/TO/U-SRV/CACHE/qr`\n      -  `chmod -R 777 /PATH/TO/U-SRV/CACHE`\n      -  `chown -R www-data:www-data /PATH/TO/U-SRV/CACHE`\n      -  `chown -R www-data:www-data /PATH/TO/YOURLS/user/plugins/iqrcodes`\n4. Enable module, default config works fine, or visit IQRCodes page to fine tune.\n5. Have fun!\n\n### Hint:\nWant to embed these QR codes into a worpress widget? Check out [this gist](https://gist.github.com/joshp23/3f990e6ec36e24ba53985968bbfa89f1)\n### Note: \nIf you are using YOURLS with Nginx and using [this](https://github.com/YOURLS/YOURLS/wiki/Nginx-configuration) directive, you may end up with [404's instead of images](https://github.com/joshp23/YOURLS-IQRCodes/issues/21#issuecomment-326797121). You may want to have a look at [this](https://github.com/YOURLS/YOURLS/issues/1715#issuecomment-326797015) comment and thread. \n\nIf this becomes an issue, try changing\n```\n(try_files $uri $uri/ /yourls-loader.php;)\n```\nto\n```\nif (!-e $request_filename){ rewrite ^(.+)$ /yourls-loader.php?q=$1 last; }\n```\n## Credits\n[Inline QRcode](http://techlister.com/plugins-2/qrcode-plugin-for-yourls/354/) by Savoul Pelister is the base of this fork\n\n[PHP QR Code](http://phpqrcode.sourceforge.net/) by Dominik Dzienia (aka deltalab) generates the actual QR Codes\n\n[JavaScript MD5](https://blueimp.github.io/JavaScript-MD5/) by Sebastian Tschan (aka BlueImp) hashes the filenames in js\n\n### Tips\nDogecoin: DARhgg9q3HAWYZuN95DKnFonADrSWUimy3\n\n===========================\n\n    Copyright (C) 2016 Josh Panter\n\n    This program is free software: you can redistribute it and/or modify\n    it under the terms of the GNU General Public License as published by\n    the Free Software Foundation, either version 3 of the License, or\n    (at your option) any later version.\n\n    This program is distributed in the hope that it will be useful,\n    but WITHOUT ANY WARRANTY; without even the implied warranty of\n    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the\n    GNU General Public License for more details.\n\n    You should have received a copy of the GNU General Public License\n    along with this program.  If not, see \u003chttp://www.gnu.org/licenses/\u003e.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshp23%2FYOURLS-IQRCodes","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjoshp23%2FYOURLS-IQRCodes","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjoshp23%2FYOURLS-IQRCodes/lists"}