PHPackages janvince/smallgdpr-plugin - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. janvince/smallgdpr-plugin ActiveOctober-plugin janvince/smallgdpr-plugin ========================= None v1.28.1(3mo ago)102269PHP Since Nov 9Pushed 3mo ago2 watchersCompare [ Source](https://github.com/jan-vince/smallgdpr)[ Packagist](https://packagist.org/packages/janvince/smallgdpr-plugin)[ RSS](/packages/janvince-smallgdpr-plugin/feed)WikiDiscussions master Synced 1w ago READMEChangelog (10)Dependencies (1)Versions (13)Used By (0) Small GDPR ========== [](#small-gdpr) > Simple plugin to cope with GDPR Installation ------------ [](#installation) **GitHub** clone into `/plugins` dir: ``` git clone https://github.com/jan-vince/smallgdpr ``` **OctoberCMS backend** Just look for 'Small GDPR' in search field in: > Settings > Updates & Plugins > Install plugins ### Permissions [](#permissions) > Settings > Administrators You can set permissions to restrict access to *Settings > Small plugins > Small GDPR* and to messages list. Quick start guide ----------------- [](#quick-start-guide) ### Cookies [](#cookies) - Install plugin. - Go October's settings page and click on GDPR > Cookies. - Go to tab Import and click button `Import default settings`. - Go to tab Cookies, add your JS code to cookies group as you need. - Go to CMS part of October. - Add new Layout (or use your existing) - Add component Small GDPR > Cookies bar (inside of your `body` tag). - Go to CMS part of October. - Add new Page with URL `/gdpr` - Add component Small GDPR > Manage cookies (inside any of your tags) > Do not forget to add `{% scripts %}` tag to your layout page just before closing `body` tag! More info [in October docs](https://octobercms.com/docs/markup/tag-scripts). - Open your website - cookies bar should be visible :) --- Settings -------- [](#settings) ### Tab: Cookies groups [](#tab-cookies-groups) The main idea is to create groups of cookies with JS scripts that you want to run on your website. #### Required [](#required) When turned on users cannot disable these groups in Manage cookies component and scripts will be always executed. #### Default enabled [](#default-enabled) Scripts in these groups will run without explicit user concent but can be disabled by user (in Manage cookies component). Be careful not to violate your local laws! #### Default checked [](#default-checked) Scripts in these groups will not run but in modal window they will be pre-checked. #### Scripts [](#scripts) You can add one or more scripts to selected group ##### Custom JS code or files [](#custom-js-code-or-files) You can add your own JS code and/or files to be executed when a cookies group is allowed (or required). You can optionally limit scripts execution to production mode. ##### Run only in production [](#run-only-in-production) Script wil be executed only in `production` environment. ##### Disable [](#disable) This scripts will never be executed ##### Run on specific pages [](#run-on-specific-pages) You can limit scripts execution to specific pages URLs. ### Tab: Cookies bar [](#tab-cookies-bar) You can edit title and content of cookies bar. If you want, you can select from pre-defined CSS styles. #### Buttons [](#buttons) You can add one or more buttons to your cookies bar. ##### Allow all cookies [](#allow-all-cookies) When turned on, click on this button will set all cookies groups enabled. Usefull for "Allow all" button on Cookies bar. *Note: Users can change cookies settings later on CMS page with Manage cookies component (like /gdpr) if you create one.* ##### Open modal window [](#open-modal-window) When turned on, click on this button open modal window with list of cookies group. *Currently supported only for Boostrap 3 UI style (can be set on tab Settings).* ### Tab: Manage cookies [](#tab-manage-cookies) Just add title and content and those will be shown above cookies groups listing in Manage cookies component. ### Tab: Settings [](#tab-settings) Few general settings to be set. #### Cookies expiration [](#cookies-expiration) Number of days for cookies to live in browser. #### UI style [](#ui-style) Change formating of output HTML code. #### Set cookies for each language [](#set-cookies-for-each-language) > Default is on. This is required if you use Rainlab Translate plugin and you set up cookies groups for each language with different cookies groups codes. On the other hand if you have separate languages but same cookies groups codes and you want your visitors not to have consent for each language separately, you can switch this off. ### Tab: Import [](#tab-import) You can import settings presets from Media your own path or default plugin preset (if you leave all empty). You have to use YAML format. *Note: Try Export first to get idea of an import file structure.* ### Tab: Export [](#tab-export) You can export current settings data to configuration file and use it as a backup or template for other sites. Components ---------- [](#components) ### Cookies bar [](#cookies-bar) Should be used in your Layouts or Pages. #### Hide Cookies bar [](#hide-cookies-bar) If you need to hide Cookies bar on specific Page or Layout, you can use [View Bag](https://octobercms.com/docs/cms/components#viewbag-component) on your Page this way: ``` [viewBag] hideCookiesBar = 1 ``` ### Manage cookies [](#manage-cookies) Put this component to your page with details about privacy (like /gdpr or /cookies). > Manage cookies component can be also added as a snippet to Static Page Users will be able to change cookies settings. HOWTO ----- [](#howto) With component `Cookies bar` or `Manage cookies` you can access cookies settings in your Twig code like this: ``` {% if sgCookies.necessary %} ... {% endif %} ``` --- > My thanks goes to: > [OctoberCMS](http://www.octobercms.com) team members and supporters for this great system. > [Brooke Cagle](https://unsplash.com/@brookecagle) for her photo. > [Font Awesome](http://fontawesome.io/icons/) for nice icons. [OFFLINE](https://github.com/OFFLINE-GmbH) for inspiration from [his GDPR plugin](https://github.com/OFFLINE-GmbH/oc-gdpr-plugin) Created by [Jan Vince](http://www.vince.cz), freelance web designer from Czech Republic. ### Health Score 46 — FairBetter than 93% of packages Maintenance82 Actively maintained with recent releases Popularity22 Limited adoption so far Community18 Small or concentrated contributor base Maturity53 Maturing project, gaining track record Bus Factor1 Top contributor holds 86% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~108 days Recently: every ~175 days Total 12 Last Release 95d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/7d0762b85a7c8514e93d4114ae9bbd9dbacfe9efc2b6bd76ef151ebdcec39bf9?d=identicon)[jan-vince](/maintainers/jan-vince) --- Top Contributors [![jan-vince](https://avatars.githubusercontent.com/u/1104383?v=4)](https://github.com/jan-vince "jan-vince (111 commits)")[![evwerkz](https://avatars.githubusercontent.com/u/49227960?v=4)](https://github.com/evwerkz "evwerkz (6 commits)")[![ShrikeFIN](https://avatars.githubusercontent.com/u/1734521?v=4)](https://github.com/ShrikeFIN "ShrikeFIN (5 commits)")[![SamBrishes](https://avatars.githubusercontent.com/u/106578633?v=4)](https://github.com/SamBrishes "SamBrishes (3 commits)")[![mediaclinic](https://avatars.githubusercontent.com/u/1957049?v=4)](https://github.com/mediaclinic "mediaclinic (2 commits)")[![anik1ng](https://avatars.githubusercontent.com/u/505388?v=4)](https://github.com/anik1ng "anik1ng (1 commits)")[![ZhiweiWu0425](https://avatars.githubusercontent.com/u/89636889?v=4)](https://github.com/ZhiweiWu0425 "ZhiweiWu0425 (1 commits)") ### Embed Badge ![Health badge](/badges/janvince-smallgdpr-plugin/health.svg) ``` [![Health](https://phpackages.com/badges/janvince-smallgdpr-plugin/health.svg)](https://phpackages.com/packages/janvince-smallgdpr-plugin) ``` ### Alternatives [elgg/elgg Elgg is an award-winning social networking engine, delivering the building blocks that enable businesses, schools, universities and associations to create their own fully-featured social networks and applications. 1.7k15.7k5](/packages/elgg-elgg)[pressbooks/pressbooks Pressbooks is an open source book publishing tool built on a WordPress multisite platform. Pressbooks outputs books in multiple formats, including PDF, EPUB, web, and a variety of XML flavours, using a theming/templating system, driven by CSS. 44643.1k1](/packages/pressbooks-pressbooks)[johnbillion/user-switching Instant switching between user accounts in WordPress and WooCommerce. 19768.3k2](/packages/johnbillion-user-switching)[rainlab/blog-plugin Blog plugin for October CMS 17257.7k](/packages/rainlab-blog-plugin)[rainlab/user-plugin User plugin for October CMS 11954.3k13](/packages/rainlab-user-plugin) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)