KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#dsh #dsh-plugin #ai-agent #developer-tools #codex #typescript #cli #deepseek-harness #claude-code #ai-agents #mcp #rust

laravel-rickroll

★ 85 Open GitHub ↗

Rickrolls people trying to break your site.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# RickRoll for Laravel

[![Tests](https://github.com/felixdorn/laravel-rickroll/actions/workflows/tests.yml/badge.svg)](https://github.com/felixdorn/laravel-rickroll/actions/workflows/tests.yml)
[![Formats](https://github.com/felixdorn/laravel-rickroll/actions/workflows/formats.yml/badge.svg)](https://github.com/felixdorn/laravel-rickroll/actions/workflows/formats.yml)

Rickrolls people trying to break your site. This package is inspired
by [Liam Hammett's tweet](https://twitter.com/LiamHammett/status/1260984553570570240).

## Getting started

You can install the package via composer, if you don't have composer installed, you can download
it [here](https://getcomposer.org):

```bash
composer require felixdorn/laravel-rickroll
```

Or by adding a requirement in your `composer.json` :

```json
{
    "require": {
        "felixdorn/laravel-rickroll": "dev-master"
    }
}
```

## We need your knowledge!

Do you know any well-known url that "hackers" use to gather information/secrets ? Add
these [here](src/LaravelRickRoll.php), thanks!

## Usage

On your `routes/web.php` just add this single line, and we'll handle the rest for you!

```php
use Felix\Rickroll\Facades\RickRoll;

RickRoll::routes();
```

### Redirecting to a custom URL

```php
use Felix\Rickroll\Facades\RickRoll;

RickRoll::routes()->redirectsTo('https://mycustom.url');
```

### Remove all URLs

```php
use Felix\Rickroll\Facades\RickRoll;

RickRoll::routes()->clear();
```

### Adding a URL

```php
use Felix\Rickroll\Facades\RickRoll;

RickRoll::routes()->push('/rickroll')
    ->push('/rickroll/{id}', [
        'id' => '[0-9]+'
    ]);
```

### Helper

There is a `rickroll` function available if you want to rickroll someone in one of your controllers.

```php
rickroll('https://my-custom.url');
```

You don't need to return anything, it works just like an `abort`.

### Events

We're dispatching an event with the current request when someone is rick-rolled. Just listen
for `Felix\RickRoll\Events\RickRolled` in your `EventServiceProvider` .

## Testing

``` bash
composer test
```

## Contributing

Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.

### Security

If you discover any security related issues, please email hi@felixdorn.fr instead of using the issue tracker.

## Credits

- [Félix Dorn](https://github.com/felixdorn)
- [All Contributors](../../contributors)

## License

The MIT License (MIT). Please see [License File](LICENSE) for more information.

laravel-rickroll

Was this content helpful?

Recent Feedback

Download README