Skip to content

Commit 6f160a5

Browse files
Merge pull request #712 from dr0i/711-readmeSSLCertificate
Fix readme of how to install an SSL certificate
2 parents 0a58016 + 6131799 commit 6f160a5

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

README.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,10 @@ $ openssl genrsa 2048 > ../localhost.key
7777
$ openssl req -new -x509 -nodes -sha256 -days 3650 -key ../localhost.key -subj '/CN=*.localhost' > ../localhost.cert
7878
```
7979

80+
Note that this example creates the `localhost.cert` and `localhost.key` files
81+
in a directory one level higher from the current, so that you don't
82+
accidentally commit your certificates to `solid` while you're developing.
83+
8084
### Run multi-user server (intermediate)
8185

8286
You can run `solid` so that new users can sign up, in other words, get their WebIDs _username.yourdomain.com_.
@@ -105,7 +109,7 @@ Your users will have a dedicated folder under `./accounts`. Also, your root doma
105109
### Running Solid behind a reverse proxy (such as NGINX)
106110
See [Running Solid behind a reverse proxy](https://github.com/solid/node-solid-server/wiki/Running-Solid-behind-a-reverse-proxy).
107111

108-
##### How can send emails to my users with my Gmail?
112+
##### How can I send emails to my users with my Gmail?
109113

110114
> To use Gmail you may need to configure ["Allow Less Secure Apps"](https://www.google.com/settings/security/lesssecureapps) in your Gmail account unless you are using 2FA in which case you would have to create an [Application Specific](https://security.google.com/settings/security/apppasswords) password. You also may need to unlock your account with ["Allow access to your Google account"](https://accounts.google.com/DisplayUnlockCaptcha) to use SMTP.
111115
@@ -317,20 +321,8 @@ without them.
317321
When deploying `solid` in production, we recommend that you go the
318322
usual Certificate Authority route to generate your SSL certificate (as you
319323
would with any website that supports HTTPS). However, for testing it locally,
320-
you can easily generate a self-signed certificate for whatever domain you're
321-
working with.
322-
323-
For example, here is how to generate a self-signed certificate for `localhost`
324-
using the `openssl` library:
325-
326-
```bash
327-
328-
solid --webid --port 8443 --cert ../localhost.cert --key ../localhost.key -v
329-
```
330-
331-
Note that this example creates the `localhost.cert` and `localhost.key` files
332-
in a directory one level higher from the current, so that you don't
333-
accidentally commit your certificates to `solid` while you're developing.
324+
you can easily [generate a self-signed certificate for whatever domain you're
325+
Working with](https://github.com/solid/node-solid-server#how-do-i-get-an-ssl-key-and-certificate).
334326

335327
#### Accessing your server
336328

0 commit comments

Comments
 (0)