Skip to content

Commit 0230984

Browse files
committed
Format .md with markdownlint
1 parent 1fcfb11 commit 0230984

2 files changed

Lines changed: 35 additions & 34 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 29 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,9 @@ We love pull requests from everyone. Check out our [open issues](https://github.
66

77
We recommend forking the repository, and then cloning your new repo.
88

9-
git clone git@github.com:your-username/bubbly.git
9+
```bash
10+
git clone git@github.com:your-username/bubbly.git
11+
```
1012

1113
Once you've made changes and committed them in your fork, preferably on a nicely named branch with descriptive commit messages, you can move on to [Creating a Pull Request](#creating-a-pull-request).
1214

@@ -32,9 +34,9 @@ In [`nginx-config/directive/bubbly_rock-hard-ssl.conf`](https://github.com/eusta
3234

3335
Drops everything older than ~2020 browsers.
3436

35-
- Supports Firefox 63, Android 10.0, Chrome 70, Edge 75, Java 11, OpenSSL 1.1.1, Opera 57, Safari 12.1
37+
* Supports Firefox 63, Android 10.0, Chrome 70, Edge 75, Java 11, OpenSSL 1.1.1, Opera 57, Safari 12.1
3638

37-
```
39+
```nginx
3840
ssl_protocols TLSv1.3;
3941
ssl_ecdh_curve X25519MLKEM768:X25519:prime256v1:secp384r1;
4042
ssl_prefer_server_ciphers off;
@@ -44,9 +46,9 @@ ssl_prefer_server_ciphers off;
4446

4547
Supports the last several versions of every modern browser, plus a long tail.
4648

47-
- Supports Firefox 31.3.0, Android 4.4.2, Chrome 49, Edge 15 on Windows 10, IE 11 on Windows 10, Java 8u161, OpenSSL 1.0.1l, Opera 20, Safari 9
49+
* Supports Firefox 31.3.0, Android 4.4.2, Chrome 49, Edge 15 on Windows 10, IE 11 on Windows 10, Java 8u161, OpenSSL 1.0.1l, Opera 20, Safari 9
4850

49-
```
51+
```nginx
5052
ssl_protocols TLSv1.2 TLSv1.3;
5153
ssl_ecdh_curve X25519MLKEM768:X25519:prime256v1:secp384r1;
5254
ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305;
@@ -57,28 +59,28 @@ ssl_prefer_server_ciphers off;
5759

5860
Various headers are delivered from various configuration files. This list should help source any undesired headers you see being sent. Some headers can be sent from multiple locations.
5961

60-
- [`nginx-config/directive/bubbly_security-headers.conf`](https://github.com/eustasy/Bubbly/blob/master/nginx-config/directive/bubbly_security-headers.conf)
61-
- - `Access-Control-Allow-Origin`
62-
- - `Content-Security-Policy-Report-Only`
63-
- - `Content-Security-Policy`
64-
- - `Cross-Origin-Embedder-Policy`
65-
- - `Cross-Origin-Opener-Policy`
66-
- - `Cross-Origin-Resource-Policy`
67-
- - `X-Content-Type-Options`
68-
- - `X-Frame-Options`
69-
- - `Feature-Policy`
70-
- - `Permissions-Policy`
71-
- - `Referrer-Policy`
72-
- - `Server`
73-
- - `Strict-Transport-Security`
74-
- - `X-XSS-Protection`
75-
- [`nginx-config/location/h5bp_expires.conf`](https://github.com/eustasy/Bubbly/blob/master/nginx-config/location/h5bp_expires.conf)
76-
- - `Cache-Control`
77-
- [`nginx-config/directive/h5bp_no-transform.conf`](https://github.com/eustasy/Bubbly/blob/master/nginx-config/directive/h5bp_no-transform.conf)
78-
- - `Cache-Control`
79-
- [`nginx-config/location/bubbly_extensionless-php.conf`](https://github.com/eustasy/Bubbly/blob/master/nginx-config/location/bubbly_extensionless-php.conf)
80-
- - Suppresses `X-Powered-By`
81-
- [`nginx-config/directive/bubbly_rock-hard-ssl.conf`](https://github.com/eustasy/Bubbly/blob/master/nginx-config/directive/bubbly_rock-hard-ssl.conf)
62+
* [`nginx-config/directive/bubbly_security-headers.conf`](https://github.com/eustasy/Bubbly/blob/master/nginx-config/directive/bubbly_security-headers.conf)
63+
* * `Access-Control-Allow-Origin`
64+
* * `Content-Security-Policy-Report-Only`
65+
* * `Content-Security-Policy`
66+
* * `Cross-Origin-Embedder-Policy`
67+
* * `Cross-Origin-Opener-Policy`
68+
* * `Cross-Origin-Resource-Policy`
69+
* * `X-Content-Type-Options`
70+
* * `X-Frame-Options`
71+
* * `Feature-Policy`
72+
* * `Permissions-Policy`
73+
* * `Referrer-Policy`
74+
* * `Server`
75+
* * `Strict-Transport-Security`
76+
* * `X-XSS-Protection`
77+
* [`nginx-config/location/h5bp_expires.conf`](https://github.com/eustasy/Bubbly/blob/master/nginx-config/location/h5bp_expires.conf)
78+
* * `Cache-Control`
79+
* [`nginx-config/directive/h5bp_no-transform.conf`](https://github.com/eustasy/Bubbly/blob/master/nginx-config/directive/h5bp_no-transform.conf)
80+
* * `Cache-Control`
81+
* [`nginx-config/location/bubbly_extensionless-php.conf`](https://github.com/eustasy/Bubbly/blob/master/nginx-config/location/bubbly_extensionless-php.conf)
82+
* * Suppresses `X-Powered-By`
83+
* [`nginx-config/directive/bubbly_rock-hard-ssl.conf`](https://github.com/eustasy/Bubbly/blob/master/nginx-config/directive/bubbly_rock-hard-ssl.conf)
8284

8385
## Contact Points
8486

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
If you want an instant A+ score on Qualys [SSL Labs](https://www.ssllabs.com/ssltest/analyze.html?d=lewisgoddard.me.uk) and A score on [SecurityHeaders.io](https://securityheaders.io/?q=lewisgoddard.me.uk&followRedirects=on), then this is what you'll need to do. You won't need any familiarity with [Certbot](https://github.com/certbot/certbot), [Let's Encrypt](https://letsencrypt.org/), the ACME spec, or SSL in general, just basic Nginx configuration.
1010

11-
**1. Install Certbot and Clone Bubbly**
11+
## 1. Install Certbot and Clone Bubbly
1212

1313
We'll start off by cloning the project into the home folder with git.
1414

@@ -18,7 +18,7 @@ sudo apt install git certbot &&
1818
git clone https://github.com/eustasy/Bubbly
1919
```
2020

21-
**2. Generate Statics**
21+
## 2. Generate Statics
2222

2323
Generate the static keys once per server.
2424

@@ -30,15 +30,15 @@ As it will warn, this might take a while.
3030

3131
Have a seat.
3232

33-
**3. Copy config blocks**
33+
## 3. Copy config blocks
3434

3535
When you've gone and made something in the 15 minutes that could well take, or you've just set up a new SSH session, copy the Nginx configuration over to the Nginx area.
3636

3737
```bash
3838
~/Bubbly/bubbly_copy-configs.sh
3939
```
4040

41-
**4. Configure & Enable Verification**
41+
## 4. Configure & Enable Verification
4242

4343
Copy the verification site template and replace the instances of `example.com` in the file with your actual domain name.
4444

@@ -56,8 +56,7 @@ sudo nginx -t && sudo service nginx reload
5656

5757
Alternatively, you can simply add `include location/bubbly_well-known-passthrough.conf;` to an existing site you want to continue working while we upgrade.
5858

59-
60-
**5. Fetch Certificates**
59+
## 5. Fetch Certificates
6160

6261
Fetch your certificates like this:
6362

@@ -69,7 +68,7 @@ It will ask for the root password, and an email address, so hang around, it shou
6968

7069
Certbot will set up a systemd timer that runs `certbot renew` automatically twice a day. The `--deploy-hook` passed by the script is stored in `/etc/letsencrypt/renewal/example.com.conf`, so Nginx will be reloaded automatically after each successful renewal — no cron job or manual renewal needed.
7170

72-
**6. Start using the Certificates**
71+
## 6. Start using the Certificates
7372

7473
Copy the live site template alongside the verify config you already have. You'll need to more carefully review the `[OPTION]`s in this file, as you'll also need to change the certificate location to match the domain name you requested. Consider taking a look at the `[OPTION]`s and `[WARNING]`s in other linked config files.
7574

0 commit comments

Comments
 (0)