https://github.com/mbasso/react-https-redirect
Force a redirect to HTTPS when not on a local web server
https://github.com/mbasso/react-https-redirect
Last synced: about 1 year ago
JSON representation
Force a redirect to HTTPS when not on a local web server
- Host: GitHub
- URL: https://github.com/mbasso/react-https-redirect
- Owner: mbasso
- License: mit
- Created: 2016-02-28T12:31:02.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2021-03-05T08:13:05.000Z (over 5 years ago)
- Last Synced: 2025-03-05T10:06:28.342Z (over 1 year ago)
- Language: JavaScript
- Size: 14.6 KB
- Stars: 35
- Watchers: 4
- Forks: 16
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# React-https-redirect
[](https://www.npmjs.com/package/react-https-redirect)
[](https://github.com/mbasso/react-https-redirect/blob/master/LICENSE.md)
---
**⚠️ Security note ⚠️ - This element provides a client-side option when HSTS and server-enforced redirects aren't possible. Please don’t use this if you can configure the server.**
---
---
This is a React component equivalent of Polymer [platinum-https-redirect](https://elements.polymer-project.org/elements/platinum-https-redirect)
> The element redirects the current page to HTTPS, unless the page is loaded from a web server running on localhost.
> Using HTTP Strict Transport Security (HSTS) can be used to enforce HTTPS for an entire origin, following the first visit to any page on the origin. Configuring the underlying web server to redirect all HTTP requests to their HTTPS equivalents takes care of enforcing HTTPS on the initial visit as well. Both options provide a more robust approach to enforcing HTTPS, but require access to the underlying web server's configuration in order to implement.
> This element provides a client-side option when HSTS and server-enforced redirects aren't possible, such as when deploying code on a shared-hosting provider like GitHub Pages.
You can read more information [here](https://elements.polymer-project.org/elements/platinum-https-redirect).
## Installation
Using [npm](https://www.npmjs.com/package/react-https-redirect):
```bash
npm install --save react-https-redirect
```
Supposing a CommonJS environment, you can simply use the component in this way:
```javascript
import HttpsRedirect from 'react-https-redirect';
// you can just wrap your entire app to redirect it to the equivalent https version
// for example:
// http://example.com/ => https://example.com/
// you can also use a "disabled" prop to dinamically disable it
//
class HttpsApp extends React.Component {
render() {
return (
);
}
}
```
## Author
**Matteo Basso**
- [github/mbasso](https://github.com/mbasso)
- [@Teo_Basso](https://twitter.com/Teo_Basso)
## Copyright and License
Copyright (c) 2016, Matteo Basso.
React-https-redirect source code is licensed under the [MIT License](https://github.com/mbasso/react-https-redirect/blob/master/LICENSE.md).