aboutsummaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorMatthew Somerville <matthew@mysociety.org>2020-05-06 16:27:28 +0100
committerStruan Donald <struan@exo.org.uk>2020-05-12 17:11:52 +0100
commit8c6e3d87d94a34f741c02483f758e7f9d145b7f2 (patch)
treed19b8bf9b24abc5cc2e4eeff223fe7348a9684a0 /docs
parent0bc94341afa4909f56e94ced03f282a158a0341c (diff)
[Docs] Document HTTPS dev server.
Diffstat (limited to 'docs')
-rw-r--r--docs/install/manual-install.md7
-rw-r--r--docs/install/vagrant.md7
2 files changed, 14 insertions, 0 deletions
diff --git a/docs/install/manual-install.md b/docs/install/manual-install.md
index 5ddf8a30f..408b419cb 100644
--- a/docs/install/manual-install.md
+++ b/docs/install/manual-install.md
@@ -177,6 +177,13 @@ $ script/server
The server will be accessible as <http://localhost:3000/>, and will
automatically restart if you update the code or `general.yml`.
+If you need to run the server under HTTPS, to e.g. develop the service worker
+or geolocation, then you can run `script/server --listen :3000:ssl
+--ssl-cert=my.crt --ssl-key=my.key --Reload perllib,conf` where my.crt and
+my.key point to a key and self-signed certificate you have generated using
+something like `openssl req -x509 -newkey rsa:4096 -sha256 -nodes -keyout
+my.key -out my.crt -subj "/CN=My local CA" -days 3650`.
+
### Post-install: Things you might want to change
#### Next Steps
diff --git a/docs/install/vagrant.md b/docs/install/vagrant.md
index 55b7802ac..1c335ab5d 100644
--- a/docs/install/vagrant.md
+++ b/docs/install/vagrant.md
@@ -69,6 +69,13 @@ The username and password to access the admin (at address
`http://fixmystreet.127.0.0.1.xip.io:3000/admin/`) will have been shown at the
end of the `vagrant up` output.
+If you need to run the server under HTTPS, to e.g. develop the service worker
+or geolocation, then you can run `script/server --listen :3000:ssl
+--ssl-cert=my.crt --ssl-key=my.key --Reload perllib,conf` where my.crt and
+my.key point to a key and self-signed certificate you have generated using
+something like `openssl req -x509 -newkey rsa:4096 -sha256 -nodes -keyout
+my.key -out my.crt -subj "/CN=My local CA" -days 3650`.
+
## Editing a cobrand
If you're working on a cobrand in an external repository, you will want that