https://github.com/bocharsky-bw/stand-with-ukraine-bundle
A Symfony bundle that provides #StandWithUkraine banner and has some built-in features to block access to your resource for Russian-speaking users.
https://github.com/bocharsky-bw/stand-with-ukraine-bundle
banner bundle standwithukraine stopwar symfony-bundle ukraine
Last synced: 8 months ago
JSON representation
A Symfony bundle that provides #StandWithUkraine banner and has some built-in features to block access to your resource for Russian-speaking users.
- Host: GitHub
- URL: https://github.com/bocharsky-bw/stand-with-ukraine-bundle
- Owner: bocharsky-bw
- License: mit
- Created: 2022-05-03T11:06:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-01-03T09:36:44.000Z (almost 2 years ago)
- Last Synced: 2024-10-13T09:16:47.400Z (about 1 year ago)
- Topics: banner, bundle, standwithukraine, stopwar, symfony-bundle, ukraine
- Language: PHP
- Homepage: https://stand-with-ukraine.pp.ua/
- Size: 244 KB
- Stars: 23
- Watchers: 3
- Forks: 7
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# StandWithUkraineBundle
[](https://vshymanskyy.github.io/StandWithUkraine/)
[](https://github.com/bocharsky-bw/stand-with-ukraine-bundle/actions/workflows/ci.yaml)
На русском? Смотри [README.ru.md](README.ru.md)
*This bundle provides a built-in StandWithUkraine banner for your Symfony application and
has some features to block content for Russian-speaking users.* **Why?** Great question!
There is a war in Ukraine right now. [You can read more about it here](https://stand-with-ukraine.pp.ua/ToRussianPeople.html#-to-people-of-russia).
The initial idea of this bundle is to *push* Russian-speaking people to *think*!
Almost all Russian media are not independent anymore and spread *fake* news
to their users about what is happening in the world and even in their own country.
Everybody has a *choice*. You can choose different sources in different languages
to read the news from many other independent and trusted media around the world,
don't limit yourself with Russian language and Russian media only.
## Features
Some features included in this bundle:
- **Display "StandWithUkraine" banner** to show that your website stands united with the people
of Ukraine.
- **Block content** for users who have the **preferred language** in `Accept-Language` request
header set to `ru`. Basically, affects people who read most of the content in Russian language.
Users would be able to access the content only after changing their preferred language to
any other language. They still can keep Russian language, but as a secondary one.
- **Block content** for users who are trying to **get access from Russian IP addresses**, i.e.
accessing the content from Russia. Users would be able to access the content only after
connecting via a [VPN](https://en.wikipedia.org/wiki/Virtual_private_network) client
choosing a location different from Russia region there. It makes things less convenient
probably, but if you're using a good VPN client - you get better security, especially if
you're connecting from public Wi-Fi spots or do not trust your internet provider.
## Installation
Install with [Composer](https://getcomposer.org/):
```bash
$ symfony composer require bw/stand-with-ukraine-bundle
```
Then, enable the bundle if you don't use Symfony Flex:
```php
// config/bundles.php
return [
// ...
BW\StandWithUkraineBundle\StandWithUkraineBundle::class => ['all' => true],
];
```
And then activate/deactivate event subscribers in its configuration.
## Configuration
Configuration is optional, all options have defaults. But if you want to change it - create
a config file `config/services/stand_with_ukraine.yaml` and tweak it. Below you can find
the full configuration example with the default values:
```yaml
# config/packages/stand_with_ukraine.yaml
stand_with_ukraine:
banner:
enabled: true
# Possition of the banner: "top" or "bottom"
position: top
# Wrap the banner with a link to the given URL
target_url: null
# Will be shown in the banner, HTTP host by default
brand_name: null
ban_language:
enabled: true
use_links: true
ban_country:
enabled: true
use_links: true
```
Or you can see it in your terminal, just run:
```bash
$ symfony console config:dump-reference stand_with_ukraine
```
## Testing
For testing purposes, you can easily simulate bad requests to test things manually
on your website in an easy way. To overwrite the actual country code with `ru`, use
`swu_overwrite_country_code_ru` query parameter, i.e:
[https://127.0.0.1:8000/?swu_overwrite_country_code_ru=yes](https://127.0.0.1:8000/?swu_overwrite_country_code_ru=yes)
Also, you can overwrite preferred language with `ru` as well, use
`swu_overwrite_preferred_lang_ru` query parameter, i.e:
[https://127.0.0.1:8000/?swu_overwrite_preferred_lang_ru=yes](https://127.0.0.1:8000/?swu_overwrite_preferred_lang_ru=yes)
The system will thinks that you're sending requests from a Russian IP address or
with Russian preferred language correspondingly and behave accordingly your configuration.
## That's it!
Thanks for using this bundle! Feel free to create an issue or send a PR if you have any
ideas how to improve it. And if you like it - please, share!