on master help sign in
add notes about running locally with https
commit30e9376f790cb606a68d61b950dca09782ec309a authorJoe Betz <joebetz91@gmail.com> dateThu 21 Nov 2019, 20:40 (7 years ago) parentf80bce9
1 file changed+7
README.md+7
README.md+7
@@ -7,6 +7,7 @@ Obelisk provides an easy way to develop and deploy your [Reflex](https://github.
77 - [Hoogle](#hoogle)
88 - [Adding Packages](#adding-packages)
99 - [Adding Package Overrides](#adding-package-overrides)
10+ - [Running over https](#running-over-https)
1011- [Deploying](#deploying)
1112 - [Locally](#locally)
1213 - [EC2](#ec2)
@@ -121,6 +122,12 @@ project ./. ({ pkgs, ... }: {
121122
122123For further information see [the Haskell section](https://nixos.org/nixpkgs/manual/#users-guide-to-the-haskell-infrastructure) of nixpkgs Contributors Guide.
123124
125+### Running over https
126+
127+To run the application locally over https, update the protocol in `config/common/route` to `https`, and then use `ob run` as normal. Obelisk will automatically generate a self-signed certificate for running https. The certificate will be valid for 1 year, at which point a new certificate can be generated by removing `certificate.pem` from `~/.config/obelisk`.
128+
129+Note: The browser will issue a warning about using an invalid certificate on localhost. On Chrome, you can either go to `chrome://flags/#allow-insecure-localhost` to enable invalid certificates for localhost, or click through the warning to add an exception for Obelisk's self-signed certificate.
130+
124131## Deploying
125132
126133### Locally