From 8c6e3d87d94a34f741c02483f758e7f9d145b7f2 Mon Sep 17 00:00:00 2001 From: Matthew Somerville Date: Wed, 6 May 2020 16:27:28 +0100 Subject: [Docs] Document HTTPS dev server. --- docs/install/manual-install.md | 7 +++++++ docs/install/vagrant.md | 7 +++++++ 2 files changed, 14 insertions(+) (limited to 'docs/install') 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 , 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 -- cgit v1.2.3 From 1243e701620d71dfcf0eedb880f40e7fef59415d Mon Sep 17 00:00:00 2001 From: Matthew Somerville Date: Mon, 13 Jul 2020 13:55:10 +0100 Subject: Do not have bootstrap run sudo commands. Your site user may not have access to sudo, and your admin user may cause permission issues if used to do the git checkout, or the Perl module installation. Document the separate script to install system packages instead. Co-authored-by: Sam Pearson --- docs/install/manual-install.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'docs/install') diff --git a/docs/install/manual-install.md b/docs/install/manual-install.md index 408b419cb..35c654cf5 100644 --- a/docs/install/manual-install.md +++ b/docs/install/manual-install.md @@ -40,7 +40,7 @@ dependencies are listed in `conf/packages.generic`. To install all of them you can run e.g.: {% highlight bash %} -$ sudo xargs -a conf/packages.generic apt-get install +$ sudo bin/install_packages {% endhighlight %} A similar list of packages should work for other Debian-based distributions. -- cgit v1.2.3