https://github.com/dokku/dokku-redirect

A plugin for dokku that gives the ability to set simple redirects for an application
https://github.com/dokku/dokku-redirect

dokku dokku-plugin nginx paas redirect

Last synced: 3 months ago
JSON representation

A plugin for dokku that gives the ability to set simple redirects for an application

• Host: GitHub
• URL: https://github.com/dokku/dokku-redirect
• Owner: dokku
• License: mit
• Created: 2015-10-18T23:06:51.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-08-20T15:31:28.000Z (10 months ago)
• Last Synced: 2024-04-04T15:32:08.661Z (3 months ago)
• Topics: dokku, dokku-plugin, nginx, paas, redirect
• Language: Shell
• Homepage:
• Size: 44.9 KB
• Stars: 101
• Watchers: 6
• Forks: 9
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-stars - dokku/dokku-redirect - A plugin for dokku that gives the ability to set simple redirects for an application (Shell)
• awesome-stars - dokku-redirect
• awesome-starred - dokku/dokku-redirect - A plugin for dokku that gives the ability to set simple redirects for an application (others)

README

        
# dokku-redirect

dokku-redirect is a plugin for [dokku][dokku] that gives the ability to set simple redirects for an application.

This plugin only redirects one domain to another and does not handle complete URLs. If source domain is managed by dokku and is TLS enabled, then nginx configuration for https redirects will be handled automatically.

## Installation

```sh

# dokku 0.11+

$ dokku plugin:install https://github.com/dokku/dokku-redirect.git

```

## Commands

```

$ dokku help

    redirect                            Display the redirects set on app

    redirect:set    [] Set a redirect from  domain to  domain

    redirect:unset                 Unset a redirect from 

```


## Redirect Codes

| Code | Name               | Behavior                                           |

| ---- | ------------------ | -------------------------------------------------- |

| 301  | Moved Permanently  | __(Default)__ Permanent, preserves method          |

| 302  | Found              | Temporary, may change method to GET                |

| 303  | See Other          | (HTTP/1.1) Temporary, changes method to GET        |

| 307  | Temporary Redirect | (HTTP/1.1) Temporary, preserves method             |

## Usage

Check redirects on my-app

```shell

$ dokku redirect my-app

SOURCE       DESTINATION      CODE

ma.dokku.me  my-app.dokku.me  301

```

Set a new redirect on my-app

```shell

$ dokku redirect:set my-app ma.dokku.me my-app.dokku.me

-----> Setting redirect for my-app...

       done

```

Redirects will include all app-specific nginx include files.

Unset an existing redirect

```shell

$ dokku redirect:unset my-app ma.dokku.me

-----> Unsetting redirect for my-app...

       done

```

## License

This plugin is released under the MIT license. See the file [LICENSE](LICENSE).

[dokku]: https://github.com/progrium/dokku