Skip to content

Commit 4547cf9

Browse files
committed
fixes pre-commits
1 parent 1037e64 commit 4547cf9

File tree

1 file changed

+21
-23
lines changed

1 file changed

+21
-23
lines changed

content/docs/guides/hedgedoc.md

+21-23
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,10 @@
11
---
2-
# cSpell:ignore hedgedoc addport
2+
# cSpell:ignore hedgedoc addport privkey USESSL
33

44
title: Securing HedgeDoc with Pomerium
55
sidebar_label: HedgeDoc
66
lang: en-US
7-
keywords:
8-
[
9-
pomerium,
10-
HedgeDoc,
11-
authentication,
12-
authorization,
13-
]
7+
keywords: [pomerium, HedgeDoc, authentication, authorization]
148
description: Learn how to control access to your HedgeDoc web application behind Pomerium.
159
---
1610

@@ -30,9 +24,9 @@ In this guide, you'll configure Pomerium to authenticate and authorize users. To
3024

3125
### Before you start
3226

33-
To complete this guide, you need:
27+
To complete this guide, you need:
3428

35-
- [Docker](https://www.docker.com/)
29+
- [Docker](https://www.docker.com/)
3630
- [Docker Compose](https://docs.docker.com/compose/install/)
3731
- [mkcert](https://github.com/FiloSottile/mkcert#installation)
3832

@@ -78,19 +72,23 @@ HedgeDoc requires an encrypted TLS connection to add and manage users. For the p
7872

7973
1. Install `mkcert` with these [instructions](https://github.com/FiloSottile/mkcert#installation)
8074
1. Create a trusted **rootCA**:
81-
```bash
82-
mkcert -install
83-
```
75+
76+
```bash
77+
mkcert -install
78+
```
79+
8480
1. Create a wildcard certificate for `*.localhost.pomerium.io`:
85-
```bash
86-
mkcert '*.localhost.pomerium.io'
87-
```
81+
82+
```bash
83+
mkcert '*.localhost.pomerium.io'
84+
```
85+
8886
This creates two files in your working directory:
8987

9088
- `_wildcard.localhost.pomerium.io.pem`
9189
- `_wildcard.localhost.pomerium.io-key.pem`
9290

93-
In the next section, you'll bind mount these certificates in a Docker Compose file.
91+
In the next section, you'll bind mount these certificates in a Docker Compose file.
9492

9593
### Set up HedgeDoc
9694

@@ -133,7 +131,7 @@ services:
133131
volumes:
134132
- uploads:/hedgedoc/public/uploads
135133
ports:
136-
- "3000:3000"
134+
- '3000:3000'
137135
restart: always
138136
depends_on:
139137
- database
@@ -148,7 +146,7 @@ volumes:
148146

149147
HedgeDoc requires a session secret to sign session cookies. If you don't add a session secret, HedgeDoc generates a random one for you upon startup, which will end any active sessions and sign out your users.
150148

151-
Adding a session secret will allow you to resume a session even if you stop your Docker services.
149+
Adding a session secret will allow you to resume a session even if you stop your Docker services.
152150

153151
To generate a secret, run:
154152

@@ -167,7 +165,7 @@ Replace the value of `CMD_SESSION_SECRET` with the output:
167165

168166
To configure HedgeDoc to use HTTPS:
169167

170-
- Set `CMD_PROTOCOL_USESSL` to `true`
168+
- Set `CMD_PROTOCOL_USESSL` to `true`
171169
- Set `CMD_ADDPORT` to `false`
172170

173171
## Run HedgeDoc and Pomerium
@@ -178,7 +176,7 @@ Run Docker Compose:
178176
docker compose up
179177
```
180178

181-
Navigate to `https://hedgedoc.localhost.pomerium.io/` to access HedgeDoc.
179+
Navigate to `https://hedgedoc.localhost.pomerium.io/` to access HedgeDoc.
182180

183181
Pomerium will prompt you to authenticate:
184182

@@ -194,10 +192,10 @@ After successful authentication, Pomerium will redirect you to your HedgeDoc URL
194192
1. Enter an **E-Mail** and **Password**
195193
1. Select **Register**
196194

197-
When you sign in, HedgeDoc will take you to your user dashboard:
195+
When you sign in, HedgeDoc will take you to your user dashboard:
198196

199197
![Secured HedgeDoc user dashboard page](./img/hedgedoc/user-dashboard.png)
200198

201199
If you check the connection, you'll notice it's secure. Now, you can write your first note and share it with users within your network:
202200

203-
![Adding a note in HedgeDoc](./img/hedgedoc/hedgedoc-note.png)
201+
![Adding a note in HedgeDoc](./img/hedgedoc/hedgedoc-note.png)

0 commit comments

Comments
 (0)